InferenceEngine::InferencePlugin Class Reference

This class is a C++ API wrapper for IInferencePlugin. More...

#include <ie_plugin_cpp.hpp>

Public Types
using	Ptr = std::shared_ptr< InferencePlugin >
	Shared pointer on InferencePlugin object.

Public Member Functions
	InferencePlugin ()=default
	A default constructor.
	InferencePlugin (const InferenceEnginePluginPtr &pointer)
	Constructs a plugin instance from the given pointer. More...
const Version *	GetVersion ()
ExecutableNetwork	LoadNetwork (const ICNNNetwork &network, const std::map< std::string, std::string > &config)
ExecutableNetwork	LoadNetwork (CNNNetwork network, const std::map< std::string, std::string > &config)
void	AddExtension (InferenceEngine::IExtensionPtr extension)
void	SetConfig (const std::map< std::string, std::string > &config)
ExecutableNetwork	ImportNetwork (const std::string &modelFileName, const std::map< std::string, std::string > &config)
void	QueryNetwork (const ICNNNetwork &network, const std::map< std::string, std::string > &config, QueryNetworkResult &res) const
	operator InferenceEngine::InferenceEnginePluginPtr ()
	Converts InferenceEngine to InferenceEnginePluginPtr pointer. More...

Detailed Description

This class is a C++ API wrapper for IInferencePlugin.

Deprecated:

Use InferenceEngine::Core instead. Will be removed in 2021.1

It can throw exceptions safely for the application, where it is properly handled.

Constructor & Destructor Documentation

InferencePlugin()

InferenceEngine::InferencePlugin::InferencePlugin ( const InferenceEnginePluginPtr &  pointer )

inlineexplicit

Constructs a plugin instance from the given pointer.

Parameters

pointer

Initialized Plugin pointer

Member Function Documentation

AddExtension()

void InferenceEngine::InferencePlugin::AddExtension ( InferenceEngine::IExtensionPtr  extension )

inline

Registers extension within the plugin.

Wraps IInferencePlugin::AddExtension

Parameters

extension

Pointer to loaded Extension

GetVersion()

const Version* InferenceEngine::InferencePlugin::GetVersion ( )

inline

Returns plugin version information.

Wraps IInferencePlugin::GetVersion

Returns

A plugin version

ImportNetwork()

ExecutableNetwork InferenceEngine::InferencePlugin::ImportNetwork ( const std::string &  modelFileName, const std::map< std::string, std::string > &  config  )

inline

Creates an executable network from a previously exported network.

Wraps IInferencePlugin::ImportNetwork

Parameters

modelFileName	A path to the imported network
config	A configuration map

Returns

Created Executable Network object

LoadNetwork() [1/2]

ExecutableNetwork InferenceEngine::InferencePlugin::LoadNetwork ( const ICNNNetwork &  network, const std::map< std::string, std::string > &  config  )

inline

Creates an executable network from a network object. User can create as many networks as they need and use them simultaneously (up to the limitation of the hardware resources)

Wraps IInferencePlugin::LoadNetwork

Parameters

network	A network object to load
config	A map of configuration options

Returns

Created Executable Network object

LoadNetwork() [2/2]

ExecutableNetwork InferenceEngine::InferencePlugin::LoadNetwork ( CNNNetwork  network, const std::map< std::string, std::string > &  config  )

inline

Wraps IInferencePlugin::LoadNetwork

Parameters

network	A network object to load
config	A map of configuration options

Returns

Created Executable Network object

operator InferenceEngine::InferenceEnginePluginPtr()

InferenceEngine::InferencePlugin::operator InferenceEngine::InferenceEnginePluginPtr ( )

inline

Converts InferenceEngine to InferenceEnginePluginPtr pointer.

Returns

Wrapped object

QueryNetwork()

void InferenceEngine::InferencePlugin::QueryNetwork ( const ICNNNetwork &  network, const std::map< std::string, std::string > &  config, QueryNetworkResult &  res  ) const

inline

Query plugin if it supports specified network with specified configuration.

Wraps IInferencePlugin::QueryNetwork

Parameters

network	A network object to query
config	A configuration map
res	Query results

SetConfig()

void InferenceEngine::InferencePlugin::SetConfig ( const std::map< std::string, std::string > &  config )

inline

Sets configuration for plugin, acceptable keys can be found in ie_plugin_config.hpp.

Wraps IInferencePlugin::SetConfig

Parameters

config

A configuration map

---

The documentation for this class was generated from the following file:

• cpp/ie_plugin_cpp.hpp