Public Member Functions
InferenceEngine::IInferencePlugin Class Referenceabstract

This class is a main plugin interface. More...

#include <ie_plugin.hpp>

Inheritance diagram for InferenceEngine::IInferencePlugin:
Inheritance graph
[legend]
Collaboration diagram for InferenceEngine::IInferencePlugin:
Collaboration graph
[legend]

Public Member Functions

virtual void GetVersion (const Version *&versionInfo) noexcept=0
 Returns plugin version information. More...
 
virtual void SetLogCallback (IErrorListener &listener) noexcept=0
 Sets logging callback. More...
 
virtual StatusCode LoadNetwork (IExecutableNetwork::Ptr &ret, const ICNNNetwork &network, const std::map< std::string, std::string > &config, ResponseDesc *resp) noexcept=0
 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) More...
 
virtual StatusCode ImportNetwork (IExecutableNetwork::Ptr &ret, const std::string &modelFileName, const std::map< std::string, std::string > &config, ResponseDesc *resp) noexcept=0
 Creates an executable network from a previously exported network. More...
 
virtual StatusCode AddExtension (InferenceEngine::IExtensionPtr extension, InferenceEngine::ResponseDesc *resp) noexcept=0
 Registers extension within the plugin. More...
 
virtual StatusCode SetConfig (const std::map< std::string, std::string > &config, ResponseDesc *resp) noexcept=0
 Sets configuration for plugin, acceptable keys can be found in ie_plugin_config.hpp. More...
 
virtual void QueryNetwork (const ICNNNetwork &network, const std::map< std::string, std::string > &config, QueryNetworkResult &res) const noexcept
 Query plugin if it supports specified network with specified configuration. More...
 
 ~IInferencePlugin () override
 A default virtual destructor.
 

Detailed Description

This class is a main plugin interface.

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

Member Function Documentation

§ AddExtension()

virtual StatusCode InferenceEngine::IInferencePlugin::AddExtension ( InferenceEngine::IExtensionPtr  extension,
InferenceEngine::ResponseDesc resp 
)
pure virtualnoexcept

Registers extension within the plugin.

Parameters
extensionPointer to already loaded extension
respPointer to the response message that holds a description of an error if any occurred
Returns
Status code of the operation. InferenceEngine::OK if succeeded

§ GetVersion()

virtual void InferenceEngine::IInferencePlugin::GetVersion ( const Version *&  versionInfo)
pure virtualnoexcept

Returns plugin version information.

Parameters
versionInfoPointer to version info. Is set by plugin

§ ImportNetwork()

virtual StatusCode InferenceEngine::IInferencePlugin::ImportNetwork ( IExecutableNetwork::Ptr ret,
const std::string &  modelFileName,
const std::map< std::string, std::string > &  config,
ResponseDesc resp 
)
pure virtualnoexcept

Creates an executable network from a previously exported network.

Parameters
retReference to a shared ptr of the returned network interface
modelFileNamePath to the location of the exported file
configMap of pairs: (config parameter name, config parameter value) relevant only for this load operation*
respPointer to the response message that holds a description of an error if any occurred
Returns
Status code of the operation. InferenceEngine::OK if succeeded

§ LoadNetwork()

virtual StatusCode InferenceEngine::IInferencePlugin::LoadNetwork ( IExecutableNetwork::Ptr ret,
const ICNNNetwork network,
const std::map< std::string, std::string > &  config,
ResponseDesc resp 
)
pure virtualnoexcept

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)

Parameters
retReference to a shared ptr of the returned network interface
networkNetwork object acquired from CNNNetReader
configMap of pairs: (config parameter name, config parameter value) relevant only for this load operation
respPointer to the response message that holds a description of an error if any occurred
Returns
Status code of the operation. InferenceEngine::OK if succeeded

§ QueryNetwork()

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

Query plugin if it supports specified network with specified configuration.

Parameters
networkNetwork object to query
configMap of pairs: (config parameter name, config parameter value)
resReference to query network result

§ SetConfig()

virtual StatusCode InferenceEngine::IInferencePlugin::SetConfig ( const std::map< std::string, std::string > &  config,
ResponseDesc resp 
)
pure virtualnoexcept

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

Parameters
configMap of pairs: (config parameter name, config parameter value)
respPointer to the response message that holds a description of an error if any occurred
Returns
Status code of the operation. InferenceEngine::OK if succeeded

§ SetLogCallback()

virtual void InferenceEngine::IInferencePlugin::SetLogCallback ( IErrorListener listener)
pure virtualnoexcept

Sets logging callback.

Deprecated:
IErrorListener is not used anymore. StatusCode is provided in case of unexpected situations This API will be removed in 2021.1 release.

Logging is used to track what is going on inside

Parameters
listenerLogging sink

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