Public Types | Public Member Functions
InferenceEngine::ExecutableNetwork Class Reference

wrapper over IExecutableNetwork More...

#include <ie_executable_network.hpp>

Public Types

using Ptr = std::shared_ptr< ExecutableNetwork >
 A smart pointer to the ExecutableNetwork object.
 

Public Member Functions

 ExecutableNetwork ()=default
 Default constructor.
 
 ~ExecutableNetwork ()
 Destructor.
 
 ExecutableNetwork (IExecutableNetwork::Ptr actual, details::SharedObjectLoader::Ptr plg={})
 Constructs ExecutableNetwork from the initialized shared_pointer. More...
 
ConstOutputsDataMap GetOutputsInfo () const
 Gets the Executable network output Data node information. More...
 
ConstInputsDataMap GetInputsInfo () const
 Gets the executable network input Data node information. More...
 
void reset (IExecutableNetwork::Ptr newActual)
 reset owned object to new pointer. More...
 
InferRequest CreateInferRequest ()
 Creates an inference request object used to infer the network. More...
 
InferRequest::Ptr CreateInferRequestPtr ()
 Creates an inference request object used to infer the network. More...
 
void Export (const std::string &modelFileName)
 Exports the current executable network. More...
 
void Export (std::ostream &networkModel)
 Exports the current executable network. More...
 
 operator IExecutableNetwork::Ptr & ()
 cast operator is used when this wrapper initialized by LoadNetwork More...
 
CNNNetwork GetExecGraphInfo ()
 Get executable graph information from a device. More...
 
std::vector< MemoryStateQueryState ()
 Gets state control interface for given executable network. More...
 
void SetConfig (const std::map< std::string, Parameter > &config)
 Sets configuration for current executable network. More...
 
Parameter GetConfig (const std::string &name) const
 Gets configuration for current executable network. More...
 
Parameter GetMetric (const std::string &name) const
 Gets general runtime metric for an executable network. More...
 
RemoteContext::Ptr GetContext () const
 Returns pointer to plugin-specific shared context on remote accelerator device that was used to create this ExecutableNetwork. More...
 

Detailed Description

wrapper over IExecutableNetwork

Constructor & Destructor Documentation

◆ ExecutableNetwork()

InferenceEngine::ExecutableNetwork::ExecutableNetwork ( IExecutableNetwork::Ptr  actual,
details::SharedObjectLoader::Ptr  plg = {} 
)
inlineexplicit

Constructs ExecutableNetwork from the initialized shared_pointer.

Parameters
actualInitialized shared pointer
plgPlugin to use

Member Function Documentation

◆ CreateInferRequest()

InferRequest InferenceEngine::ExecutableNetwork::CreateInferRequest ( )
inline

Creates an inference request object used to infer the network.

Wraps IExecutableNetwork::CreateInferRequest.

Returns
InferRequest object

◆ CreateInferRequestPtr()

InferRequest::Ptr InferenceEngine::ExecutableNetwork::CreateInferRequestPtr ( )
inline

Creates an inference request object used to infer the network.

Wraps IExecutableNetwork::CreateInferRequest.

Returns
shared pointer on InferenceEngine::InferRequest object

◆ Export() [1/2]

void InferenceEngine::ExecutableNetwork::Export ( const std::string &  modelFileName)
inline

Exports the current executable network.

Wraps IExecutableNetwork::Export.

See also
Core::ImportNetwork
Parameters
modelFileNameFull path to the location of the exported file

◆ Export() [2/2]

void InferenceEngine::ExecutableNetwork::Export ( std::ostream &  networkModel)
inline

Exports the current executable network.

Wraps IExecutableNetwork::Export.

See also
Core::ImportNetwork
Parameters
networkModelnetwork model output stream

◆ GetConfig()

Parameter InferenceEngine::ExecutableNetwork::GetConfig ( const std::string &  name) const
inline

Gets configuration for current executable network.

Wraps IExecutableNetwork::GetConfig

Parameters
name- config key, can be found in ie_plugin_config.hpp
Returns
Configuration paramater value

◆ GetContext()

RemoteContext::Ptr InferenceEngine::ExecutableNetwork::GetContext ( ) const
inline

Returns pointer to plugin-specific shared context on remote accelerator device that was used to create this ExecutableNetwork.

Returns
A context

◆ GetExecGraphInfo()

CNNNetwork InferenceEngine::ExecutableNetwork::GetExecGraphInfo ( )
inline

Get executable graph information from a device.

Wraps IExecutableNetwork::GetExecGraphInfo.

Returns
CNNetwork containing Executable Graph Info

◆ GetInputsInfo()

ConstInputsDataMap InferenceEngine::ExecutableNetwork::GetInputsInfo ( ) const
inline

Gets the executable network input Data node information.

Wraps IExecutableNetwork::GetInputsInfo

Returns
A collection that contains string as key, and const InputInfo smart pointer as value

◆ GetMetric()

Parameter InferenceEngine::ExecutableNetwork::GetMetric ( const std::string &  name) const
inline

Gets general runtime metric for an executable network.

Wraps IExecutableNetwork::GetMetric

Parameters
name- metric name to request
Returns
Metric paramater value

◆ GetOutputsInfo()

ConstOutputsDataMap InferenceEngine::ExecutableNetwork::GetOutputsInfo ( ) const
inline

Gets the Executable network output Data node information.

Wraps IExecutableNetwork::GetOutputsInfo.

Returns
A collection that contains string as key, and const Data smart pointer as value

◆ operator IExecutableNetwork::Ptr &()

InferenceEngine::ExecutableNetwork::operator IExecutableNetwork::Ptr & ( )
inline

cast operator is used when this wrapper initialized by LoadNetwork

Returns
A shared pointer to IExecutableNetwork interface.

◆ QueryState()

std::vector<MemoryState> InferenceEngine::ExecutableNetwork::QueryState ( )
inline

Gets state control interface for given executable network.

Wraps IExecutableNetwork::QueryState

Returns
A vector of Memory State objects

◆ reset()

void InferenceEngine::ExecutableNetwork::reset ( IExecutableNetwork::Ptr  newActual)
inline

reset owned object to new pointer.

Eessential for cases when simultaneously loaded networks not expected.

Parameters
newActualactual pointed object

◆ SetConfig()

void InferenceEngine::ExecutableNetwork::SetConfig ( const std::map< std::string, Parameter > &  config)
inline

Sets configuration for current executable network.

Wraps IExecutableNetwork::SetConfig.

Parameters
configMap of pairs: (config parameter name, config parameter value)

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