An API of plugin to be implemented by a plugin. More...

#include <ie_iplugin_internal.hpp>

Inheritance diagram for InferenceEngine::IInferencePlugin:

Public Types
using	Ptr = std::shared_ptr< IInferencePlugin >
	A shared pointer to IInferencePlugin interface.

Public Member Functions
void	SetVersion (const Version &version)
	Sets a plugin version. More...

const Version &	GetVersion () const
	Gets a plugin version. More...

virtual std::string	GetName () const noexcept
	Provides a name of a plugin. More...

virtual void	SetName (const std::string &name) noexcept
	Sets a name for a plugin. More...

virtual std::shared_ptr< IExecutableNetworkInternal >	LoadNetwork (const CNNNetwork &network, const std::map< std::string, std::string > &config)
	Creates an executable network from an pares network object, users can create as many networks as they need and use them simultaneously (up to the limitation of the HW resources) More...

virtual std::shared_ptr< IExecutableNetworkInternal >	LoadNetwork (const CNNNetwork &network, const std::map< std::string, std::string > &config, const std::shared_ptr< RemoteContext > &context)
	Creates an executable network from network object, on specified remote context. More...

virtual std::shared_ptr< IExecutableNetworkInternal >	LoadNetwork (const std::string &modelPath, const std::map< std::string, std::string > &config)
	Creates an executable network from model file path. More...

virtual void	AddExtension (const std::shared_ptr< IExtension > &extension)
	Registers extension within plugin. More...

virtual void	SetConfig (const std::map< std::string, std::string > &config)
	Sets configuration for plugin, acceptable keys can be found in ie_plugin_config.hpp. More...

virtual Parameter	GetConfig (const std::string &name, const std::map< std::string, Parameter > &options) const
	Gets configuration dedicated to plugin behaviour. More...

virtual Parameter	GetMetric (const std::string &name, const std::map< std::string, Parameter > &options) const
	Gets general runtime metric for dedicated hardware. More...

virtual std::shared_ptr< RemoteContext >	CreateContext (const ParamMap &params)
	Creates a remote context instance based on a map of parameters. More...

virtual std::shared_ptr< RemoteContext >	GetDefaultContext (const ParamMap &params)
	Provides a default remote context instance if supported by a plugin. More...

virtual std::shared_ptr< IExecutableNetworkInternal >	ImportNetwork (const std::string &modelFileName, const std::map< std::string, std::string > &config)
	Creates an executable network from an previously exported network. More...

virtual std::shared_ptr< IExecutableNetworkInternal >	ImportNetwork (std::istream &networkModel, const std::map< std::string, std::string > &config)
	Creates an executable network from an previously exported network using plugin implementation and removes Inference Engine magic and plugin name. More...

virtual std::shared_ptr< IExecutableNetworkInternal >	ImportNetwork (std::istream &networkModel, const std::shared_ptr< RemoteContext > &context, const std::map< std::string, std::string > &config)
	Creates an executable network from an previously exported network using plugin implementation and removes Inference Engine magic and plugin name. More...

virtual void	SetCore (ICore *core)
	Sets pointer to ICore interface. More...

virtual ICore *	GetCore () const noexcept
	Gets reference to ICore interface. More...

virtual QueryNetworkResult	QueryNetwork (const CNNNetwork &network, const std::map< std::string, std::string > &config) const
	Queries a plugin about supported layers in network. More...

Protected Member Functions
virtual std::shared_ptr< IExecutableNetworkInternal >	LoadExeNetworkImpl (const CNNNetwork &network, const std::map< std::string, std::string > &config)
	Creates an executable network from a parsed network object, users can create as many networks as they need and use them simultaneously (up to the limitation of the HW resources) More...

virtual std::shared_ptr< IExecutableNetworkInternal >	LoadExeNetworkImpl (const CNNNetwork &network, const std::shared_ptr< RemoteContext > &context, const std::map< std::string, std::string > &config)
	Creates an executable network using remote context from a parsed network object, users can create as many networks as they need and use them simultaneously (up to the limitation of the HW resources) More...

void	SetExeNetworkInfo (const std::shared_ptr< IExecutableNetworkInternal > &exeNetwork, const ConstInputsDataMap &inputs, const ConstOutputsDataMap &outputs)
	Set input and output information to executable network. This method is used to set addtional information to InferenceEngine::IExecutableNetworkInternal create by device plugin. More...

Protected Attributes
std::string	_pluginName
	A device name that plugins enables.

std::map< std::string, std::string >	_config
	A map config keys -> values.

ICore *	_core = nullptr
	A pointer to ICore interface.

Detailed Description

An API of plugin to be implemented by a plugin.

Member Function Documentation

◆ AddExtension()

virtual void InferenceEngine::IInferencePlugin::AddExtension ( const std::shared_ptr< IExtension > & extension )

virtual

Registers extension within plugin.

Parameters

extension - pointer to already loaded extension

◆ CreateContext()

virtual std::shared_ptr<RemoteContext> InferenceEngine::IInferencePlugin::CreateContext ( const ParamMap & params )

virtual

Creates a remote context instance based on a map of parameters.

Parameters

[in] params The map of parameters

Returns: A remote context object

◆ GetConfig()

virtual Parameter InferenceEngine::IInferencePlugin::GetConfig	(	const std::string &	name,
		const std::map< std::string, Parameter > &	options
	)		const

virtual

Gets configuration dedicated to plugin behaviour.

Parameters

name	- value of config corresponding to config key
options	- configuration details for config

Returns: Value of config corresponding to config key

◆ GetCore()

virtual ICore* InferenceEngine::IInferencePlugin::GetCore ( ) const

virtualnoexcept

Gets reference to ICore interface.

Returns: Reference to ICore interface

◆ GetDefaultContext()

virtual std::shared_ptr<RemoteContext> InferenceEngine::IInferencePlugin::GetDefaultContext ( const ParamMap & params )

virtual

Provides a default remote context instance if supported by a plugin.

Parameters

[in] params The map of parameters

Returns: The default context.

◆ GetMetric()

virtual Parameter InferenceEngine::IInferencePlugin::GetMetric	(	const std::string &	name,
		const std::map< std::string, Parameter > &	options
	)		const

virtual

Gets general runtime metric for dedicated hardware.

Parameters

name	- metric name to request
options	- configuration details for metric

Returns: Metric value corresponding to metric key

◆ GetName()

virtual std::string InferenceEngine::IInferencePlugin::GetName ( ) const

virtualnoexcept

Provides a name of a plugin.

Returns: The name.

◆ GetVersion()

const Version& InferenceEngine::IInferencePlugin::GetVersion ( ) const

Gets a plugin version.

Returns: A const InferenceEngine::Version object

◆ ImportNetwork() [1/3]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::ImportNetwork	(	const std::string &	modelFileName,
		const std::map< std::string, std::string > &	config
	)

virtual

Creates an executable network from an previously exported network.

Deprecated:: Use ImportNetwork(std::istream& networkModel, const std::map<std::string, std::string>& config)

Parameters

modelFileName	- path to the location of the exported file
config	A string -> string map of parameters

Returns: An Executable network

◆ ImportNetwork() [2/3]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::ImportNetwork	(	std::istream &	networkModel,
		const std::map< std::string, std::string > &	config
	)

virtual

Creates an executable network from an previously exported network using plugin implementation and removes Inference Engine magic and plugin name.

Parameters

networkModel	Reference to network model output stream
config	A string -> string map of parameters

Returns: An Executable network

◆ ImportNetwork() [3/3]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::ImportNetwork	(	std::istream &	networkModel,
		const std::shared_ptr< RemoteContext > &	context,
		const std::map< std::string, std::string > &	config
	)

virtual

Creates an executable network from an previously exported network using plugin implementation and removes Inference Engine magic and plugin name.

Parameters

networkModel	Reference to network model output stream
context	A pointer to plugin context derived from RemoteContext class used to execute the network
config	A string -> string map of parameters

Returns: An Executable network

◆ LoadExeNetworkImpl() [1/2]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::LoadExeNetworkImpl	(	const CNNNetwork &	network,
		const std::map< std::string, std::string > &	config
	)

protectedvirtual

Creates an executable network from a parsed network object, users can create as many networks as they need and use them simultaneously (up to the limitation of the HW resources)

Note: The function is used in InferencePluginInternal::LoadNetwork(const CNNNetwork&, const std::map<std::string, std::string>&) which performs common steps first and calls this plugin-dependent method implementation after.

Parameters

network	A network object
config	string-string map of config parameters relevant only for this load operation

Returns: Shared pointer to the ExecutableNetwork object

◆ LoadExeNetworkImpl() [2/2]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::LoadExeNetworkImpl	(	const CNNNetwork &	network,
		const std::shared_ptr< RemoteContext > &	context,
		const std::map< std::string, std::string > &	config
	)

protectedvirtual

Creates an executable network using remote context from a parsed network object, users can create as many networks as they need and use them simultaneously (up to the limitation of the HW resources)

Note: The function is used in InferencePluginInternal::LoadNetwork(const CNNNetwork&, const std::map<std::string, std::string>&, RemoteContext::Ptr) which performs common steps first and calls this plugin-dependent method implementation after.

Parameters

network	A network object
context	A remote context
config	string-string map of config parameters relevant only for this load operation

Returns: Shared pointer to the ExecutableNetwork object

◆ LoadNetwork() [1/3]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::LoadNetwork	(	const CNNNetwork &	network,
		const std::map< std::string, std::string > &	config
	)

virtual

Creates an executable network from an pares network object, users can create as many networks as they need and use them simultaneously (up to the limitation of the HW resources)

Parameters

network	A network object acquired from InferenceEngine::Core::ReadNetwork
config	A string-string map of config parameters relevant only for this load operation

Returns: Created Executable Network object

◆ LoadNetwork() [2/3]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::LoadNetwork	(	const CNNNetwork &	network,
		const std::map< std::string, std::string > &	config,
		const std::shared_ptr< RemoteContext > &	context
	)

virtual

Creates an executable network from network object, on specified remote context.

Parameters

network	A network object acquired from InferenceEngine::Core::ReadNetwork
config	string-string map of config parameters relevant only for this load operation
context	A pointer to plugin context derived from RemoteContext class used to execute the network

Returns: Created Executable Network object

◆ LoadNetwork() [3/3]

virtual std::shared_ptr<IExecutableNetworkInternal> InferenceEngine::IInferencePlugin::LoadNetwork	(	const std::string &	modelPath,
		const std::map< std::string, std::string > &	config
	)

virtual

Creates an executable network from model file path.

Parameters

modelPath	A path to model
config	A string-string map of config parameters relevant only for this load operation

Returns: Created Executable Network object

◆ QueryNetwork()

virtual QueryNetworkResult InferenceEngine::IInferencePlugin::QueryNetwork	(	const CNNNetwork &	network,
		const std::map< std::string, std::string > &	config
	)		const

virtual

Queries a plugin about supported layers in network.

Parameters

[in]	network	The network object to query
[in]	config	The map of configuration parameters

Returns: The result of query operator containing supported layers map

◆ SetConfig()

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

virtual

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

Parameters

config string-string map of config parameters

◆ SetCore()

virtual void InferenceEngine::IInferencePlugin::SetCore ( ICore * core )

virtual

Sets pointer to ICore interface.

Parameters

core	Pointer to Core interface

◆ SetExeNetworkInfo()

void InferenceEngine::IInferencePlugin::SetExeNetworkInfo	(	const std::shared_ptr< IExecutableNetworkInternal > &	exeNetwork,
		const ConstInputsDataMap &	inputs,
		const ConstOutputsDataMap &	outputs
	)

protected

Set input and output information to executable network. This method is used to set addtional information to InferenceEngine::IExecutableNetworkInternal create by device plugin.

Parameters

exeNetwork	An executable network object to set information to
inputs	An input information to set
outputs	An output information to set

◆ SetName()

virtual void InferenceEngine::IInferencePlugin::SetName ( const std::string & name )

virtualnoexcept

Sets a name for a plugin.

Parameters

[in] name The name

◆ SetVersion()

void InferenceEngine::IInferencePlugin::SetVersion ( const Version & version )

Sets a plugin version.

Parameters

version A version to set

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

cpp_interfaces/interface/ie_iplugin_internal.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ AddExtension()

◆ CreateContext()

◆ GetConfig()

◆ GetCore()

◆ GetDefaultContext()

◆ GetMetric()

◆ GetName()

◆ GetVersion()

◆ ImportNetwork() [1/3]

◆ ImportNetwork() [2/3]

◆ ImportNetwork() [3/3]

◆ LoadExeNetworkImpl() [1/2]

◆ LoadExeNetworkImpl() [2/2]

◆ LoadNetwork() [1/3]

◆ LoadNetwork() [2/3]

◆ LoadNetwork() [3/3]

◆ QueryNetwork()

◆ SetConfig()

◆ SetCore()

◆ SetExeNetworkInfo()

◆ SetName()

◆ SetVersion()