Public Member Functions | Protected Attributes
InferenceEngine::CNNNetwork Class Reference

This class contains all the information about the Neural Network and the related binary information. More...

#include <ie_cnn_network.h>

Collaboration diagram for InferenceEngine::CNNNetwork:
Collaboration graph
[legend]

Public Member Functions

 CNNNetwork ()=default
 A default constructor.
 
 CNNNetwork (std::shared_ptr< ICNNNetwork > network)
 Allows helper class to manage lifetime of network object. More...
 
 CNNNetwork (const std::shared_ptr< const ngraph::Function > &network)
 A constructor from ngraph::Function object. More...
 
 CNNNetwork (CNNNetReaderPtr reader_)
 A constructor from ICNNNetReader object. More...
 
virtual ~CNNNetwork ()
 A destructor.
 
virtual Precision getPrecision () const
 
virtual OutputsDataMap getOutputsInfo () const
 
virtual InputsDataMap getInputsInfo () const
 
size_t layerCount () const
 
const std::string & getName () const
 
virtual void setBatchSize (const size_t size)
 
virtual size_t getBatchSize () const
 
 operator ICNNNetwork::Ptr ()
 An overloaded operator cast to get pointer on current network. More...
 
 operator ICNNNetwork & ()
 An overloaded operator & to get current network. More...
 
 operator const ICNNNetwork & () const
 An overloaded operator & to get current network. More...
 
std::shared_ptr< ngraph::Function > getFunction ()
 Returns constant nGraph function. More...
 
std::shared_ptr< const ngraph::Function > getFunction () const
 Returns constant nGraph function. More...
 
void addOutput (const std::string &layerName, size_t outputIndex=0)
 
CNNLayerPtr getLayerByName (const char *layerName) const
 
details::CNNNetworkIterator begin () const
 Begin layer iterator. More...
 
details::CNNNetworkIterator end () const
 End layer iterator. More...
 
size_t size () const
 Number of layers in network object. More...
 
void AddExtension (InferenceEngine::IShapeInferExtensionPtr extension)
 Registers extension within the plugin. More...
 
virtual ICNNNetwork::InputShapes getInputShapes () const
 Helper method to get collect all input shapes with names of corresponding Data objects. More...
 
virtual void reshape (const ICNNNetwork::InputShapes &inputShapes)
 Run shape inference with new input shapes for the network. More...
 
void serialize (const std::string &xmlPath, const std::string &binPath="") const
 Serialize network to IR and weights files. More...
 

Protected Attributes

CNNNetReaderPtr reader
 Reader extra reference, might be nullptr.
 
std::shared_ptr< ICNNNetworknetwork
 Network extra interface, might be nullptr.
 
ICNNNetworkactual = nullptr
 A pointer to the current network.
 
DataPtr output
 A pointer to output data.
 

Detailed Description

This class contains all the information about the Neural Network and the related binary information.

Constructor & Destructor Documentation

§ CNNNetwork() [1/3]

InferenceEngine::CNNNetwork::CNNNetwork ( std::shared_ptr< ICNNNetwork network)
inlineexplicit

Allows helper class to manage lifetime of network object.

Parameters
networkPointer to the network object

§ CNNNetwork() [2/3]

InferenceEngine::CNNNetwork::CNNNetwork ( const std::shared_ptr< const ngraph::Function > &  network)
explicit

A constructor from ngraph::Function object.

Parameters
networkPointer to the ngraph::Function object

§ CNNNetwork() [3/3]

InferenceEngine::CNNNetwork::CNNNetwork ( CNNNetReaderPtr  reader_)
inlineexplicit

A constructor from ICNNNetReader object.

Parameters
readerPointer to the ICNNNetReader object

Member Function Documentation

§ AddExtension()

void InferenceEngine::CNNNetwork::AddExtension ( InferenceEngine::IShapeInferExtensionPtr  extension)

Registers extension within the plugin.

Deprecated:
Use Core::AddExtension to add an extension to the library
Parameters
extensionPointer to already loaded reader extension with shape propagation implementations

§ addOutput()

void InferenceEngine::CNNNetwork::addOutput ( const std::string &  layerName,
size_t  outputIndex = 0 
)
inline

Adds output to the layer.

Wraps ICNNNetwork::addOutput

Parameters
layerNameName of the layer
outputIndexIndex of the output

§ begin()

details::CNNNetworkIterator InferenceEngine::CNNNetwork::begin ( ) const

Begin layer iterator.

Deprecated:
Use CNNNetwork::getFunction() and work with ngraph::Function directly. The method will be removed in 2021.1

Order of layers is implementation specific, and can be changed in future

Returns
Iterator pointing to a layer

§ end()

details::CNNNetworkIterator InferenceEngine::CNNNetwork::end ( ) const

End layer iterator.

Deprecated:
Use CNNNetwork::getFunction() and work with ngraph::Function directly. The method will be removed in 2021.1
Returns
Iterator pointing to a layer

§ getBatchSize()

virtual size_t InferenceEngine::CNNNetwork::getBatchSize ( ) const
inlinevirtual

Gets the inference batch size.

Wraps ICNNNetwork::getBatchSize

Returns
The size of batch as a size_t value

§ getFunction() [1/2]

std::shared_ptr<ngraph::Function> InferenceEngine::CNNNetwork::getFunction ( )
inline

Returns constant nGraph function.

Returns
constant nGraph function

§ getFunction() [2/2]

std::shared_ptr<const ngraph::Function> InferenceEngine::CNNNetwork::getFunction ( ) const
inline

Returns constant nGraph function.

Returns
constant nGraph function

§ getInputShapes()

virtual ICNNNetwork::InputShapes InferenceEngine::CNNNetwork::getInputShapes ( ) const
inlinevirtual

Helper method to get collect all input shapes with names of corresponding Data objects.

Returns
Map of pairs: input name and its dimension.

§ getInputsInfo()

virtual InputsDataMap InferenceEngine::CNNNetwork::getInputsInfo ( ) const
inlinevirtual

Gets the network input Data node information. The received info is stored in the given InputsDataMap object.

Wraps ICNNNetwork::getInputsInfo

Returns
inputs Reference to InputsDataMap object

§ getLayerByName()

CNNLayerPtr InferenceEngine::CNNNetwork::getLayerByName ( const char *  layerName) const
Deprecated:
Migrate to IR v10 and work with ngraph::Function directly. The method will be removed in 2021.1 ICNNNetwork::getLayerByName

Wraps ICNNNetwork::getLayerByName

Parameters
layerNameGiven name of the layer
Returns
Status code of the operation. InferenceEngine::OK if succeeded

§ getName()

const std::string& InferenceEngine::CNNNetwork::getName ( ) const
inline

Gets the network name. The name is stored in the given pName string.

Wraps ICNNNetwork::getName

Returns
Network name

§ getOutputsInfo()

virtual OutputsDataMap InferenceEngine::CNNNetwork::getOutputsInfo ( ) const
inlinevirtual

Gets the network output Data node information. The received info is stored in the given Data node.

Wraps ICNNNetwork::getOutputsInfo

Returns
outputs Reference to the OutputsDataMap object

§ getPrecision()

virtual Precision InferenceEngine::CNNNetwork::getPrecision ( ) const
virtual
Deprecated:
Network precision does not make sence, use precision on egdes. The method will be removed in 2021.1 ICNNNetwork::getPrecision

Wraps ICNNNetwork::getPrecision

Returns
A precision type

§ layerCount()

size_t InferenceEngine::CNNNetwork::layerCount ( ) const
inline

Returns the number of layers in the network as an integer value.

Wraps ICNNNetwork::layerCount

Returns
The number of layers as an integer value

§ operator const ICNNNetwork &()

InferenceEngine::CNNNetwork::operator const ICNNNetwork & ( ) const
inline

An overloaded operator & to get current network.

Returns
A const reference of the current network

§ operator ICNNNetwork &()

InferenceEngine::CNNNetwork::operator ICNNNetwork & ( )
inline

An overloaded operator & to get current network.

Returns
An instance of the current network

§ operator ICNNNetwork::Ptr()

InferenceEngine::CNNNetwork::operator ICNNNetwork::Ptr ( )
inline

An overloaded operator cast to get pointer on current network.

Returns
A shared pointer of the current network

§ reshape()

virtual void InferenceEngine::CNNNetwork::reshape ( const ICNNNetwork::InputShapes inputShapes)
inlinevirtual

Run shape inference with new input shapes for the network.

Parameters
inputShapes- map of pairs: name of corresponding data and its dimension.

§ serialize()

void InferenceEngine::CNNNetwork::serialize ( const std::string &  xmlPath,
const std::string &  binPath = "" 
) const
inline

Serialize network to IR and weights files.

Parameters
xmlPathPath to output IR file.
binPathPath to output weights file. The parameter is skipped in case of executable graph info serialization.

§ setBatchSize()

virtual void InferenceEngine::CNNNetwork::setBatchSize ( const size_t  size)
inlinevirtual

Changes the inference batch size.

Wraps ICNNNetwork::setBatchSize

Parameters
sizeSize of batch to set
Returns
Status code of the operation

§ size()

size_t InferenceEngine::CNNNetwork::size ( ) const

Number of layers in network object.

Deprecated:
Use CNNNetwork::layerCount() instead. The method will be removed in 2021.1
Returns
Number of layers.

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