Minimal ICore interface to allow plugin to get information from Core Inference Engine class. More...

#include <ie_icore.hpp>

Public Member Functions
virtual std::shared_ptr< ITaskExecutor >	GetTaskExecutor () const =0
	Returns global to Inference Engine class task executor. More...

virtual CNNNetwork	ReadNetwork (const std::string &model, const Blob::CPtr &weights) const =0
	Reads IR xml and bin (with the same name) files. More...

virtual CNNNetwork	ReadNetwork (const std::string &modelPath, const std::string &binPath) const =0
	Reads IR xml and bin files. More...

virtual SoExecutableNetworkInternal	LoadNetwork (const CNNNetwork &network, const std::string &deviceName, const std::map< std::string, std::string > &config={})=0
	Creates an executable network from a network object. More...

virtual SoExecutableNetworkInternal	LoadNetwork (const std::string &modelPath, const std::string &deviceName, const std::map< std::string, std::string > &config)=0
	Creates an executable network from a model file. More...

virtual SoExecutableNetworkInternal	ImportNetwork (std::istream &networkModel, const std::string &deviceName={}, const std::map< std::string, std::string > &config={})=0
	Creates an executable network from a previously exported network. More...

virtual QueryNetworkResult	QueryNetwork (const CNNNetwork &network, const std::string &deviceName, const std::map< std::string, std::string > &config) const =0
	Query device if it supports specified network with specified configuration. More...

virtual Parameter	GetMetric (const std::string &deviceName, const std::string &name) const =0
	Gets general runtime metric for dedicated hardware. More...

virtual std::vector< std::string >	GetAvailableDevices () const =0
	Returns devices available for neural networks inference. More...

virtual bool	DeviceSupportsImportExport (const std::string &deviceName) const =0
	Checks whether device supports Export & Import functionality of network. More...

virtual	~ICore ()=default
	Default virtual destructor.

Detailed Description

Minimal ICore interface to allow plugin to get information from Core Inference Engine class.

Member Function Documentation

◆ DeviceSupportsImportExport()

virtual bool InferenceEngine::ICore::DeviceSupportsImportExport ( const std::string & deviceName ) const

pure virtual

Checks whether device supports Export & Import functionality of network.

Parameters

deviceName - A name of a device to get a metric value.

Returns: True if device has IMPORT_EXPORT_SUPPORT metric in SUPPORTED_METRICS and this metric returns 'true', False otherwise.

◆ GetAvailableDevices()

virtual std::vector<std::string> InferenceEngine::ICore::GetAvailableDevices ( ) const

pure virtual

Returns devices available for neural networks inference.

Returns: A vector of devices. The devices are returned as { CPU, FPGA.0, FPGA.1, MYRIAD } If there more than one device of specific type, they are enumerated with .# suffix.

◆ GetMetric()

virtual Parameter InferenceEngine::ICore::GetMetric	(	const std::string &	deviceName,
		const std::string &	name
	)		const

pure virtual

Gets general runtime metric for dedicated hardware.

The method is needed to request common device properties which are executable network agnostic. It can be device name, temperature, other devices-specific values.

Parameters

deviceName	- A name of a device to get a metric value.
name	- metric name to request.

Returns: Metric value corresponding to metric key.

◆ GetTaskExecutor()

virtual std::shared_ptr<ITaskExecutor> InferenceEngine::ICore::GetTaskExecutor ( ) const

pure virtual

Returns global to Inference Engine class task executor.

Returns: Reference to task executor

◆ ImportNetwork()

virtual SoExecutableNetworkInternal InferenceEngine::ICore::ImportNetwork	(	std::istream &	networkModel,
		const std::string &	deviceName = `{}`,
		const std::map< std::string, std::string > &	config = `{}`
	)

pure virtual

Creates an executable network from a previously exported network.

Parameters

networkModel	network model stream
deviceName	Name of device load executable network on
config	Optional map of pairs: (config parameter name, config parameter value) relevant only for this load operation*

Returns: An executable network reference

◆ LoadNetwork() [1/2]

virtual SoExecutableNetworkInternal InferenceEngine::ICore::LoadNetwork	(	const CNNNetwork &	network,
		const std::string &	deviceName,
		const std::map< std::string, std::string > &	config = `{}`
	)

pure virtual

Creates an executable network from a network object.

Users can create as many networks as they need and use them simultaneously (up to the limitation of the hardware resources)

Parameters

network	CNNNetwork object acquired from Core::ReadNetwork
deviceName	Name of device to load network to
config	Optional map of pairs: (config parameter name, config parameter value) relevant only for this load operation

Returns: An executable network reference

◆ LoadNetwork() [2/2]

virtual SoExecutableNetworkInternal InferenceEngine::ICore::LoadNetwork	(	const std::string &	modelPath,
		const std::string &	deviceName,
		const std::map< std::string, std::string > &	config
	)

pure virtual

Creates an executable network from a model file.

Users can create as many networks as they need and use them simultaneously (up to the limitation of the hardware resources)

Parameters

modelPath	Path to model
deviceName	Name of device to load network to
config	Optional map of pairs: (config parameter name, config parameter value) relevant only for this load operation

Returns: An executable network reference

◆ QueryNetwork()

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

pure virtual

Query device if it supports specified network with specified configuration.

Parameters

deviceName	A name of a device to query
network	Network object to query
config	Optional map of pairs: (config parameter name, config parameter value)

Returns: An object containing a map of pairs a layer name -> a device name supporting this layer.

◆ ReadNetwork() [1/2]

virtual CNNNetwork InferenceEngine::ICore::ReadNetwork	(	const std::string &	model,
		const Blob::CPtr &	weights
	)		const

pure virtual

Reads IR xml and bin (with the same name) files.

Parameters

model	string with IR
weights	shared pointer to constant blob with weights

Returns: CNNNetwork

◆ ReadNetwork() [2/2]

virtual CNNNetwork InferenceEngine::ICore::ReadNetwork	(	const std::string &	modelPath,
		const std::string &	binPath
	)		const

pure virtual

Reads IR xml and bin files.

Parameters

modelPath	path to IR file
binPath	path to bin file, if path is empty, will try to read bin file with the same name as xml and if bin file with the same name was not found, will load IR without weights.

Returns: CNNNetwork

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

ie_icore.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ DeviceSupportsImportExport()

◆ GetAvailableDevices()

◆ GetMetric()

◆ GetTaskExecutor()

◆ ImportNetwork()

◆ LoadNetwork() [1/2]

◆ LoadNetwork() [2/2]

◆ QueryNetwork()

◆ ReadNetwork() [1/2]

◆ ReadNetwork() [2/2]