Public Types | Public Member Functions | Static Public Member Functions
InferenceEngine::Builder::Layer Class Reference

This class implements a builder for IE Layer. More...

#include <ie_layer_builder.hpp>

Inheritance diagram for InferenceEngine::Builder::Layer:
Inheritance graph
[legend]
Collaboration diagram for InferenceEngine::Builder::Layer:
Collaboration graph
[legend]

Public Types

using Ptr = std::shared_ptr< Layer >
 A shared pointer to the Layer builder.
 
using CPtr = std::shared_ptr< const Layer >
 A shared pointer to the constant Layer builder.
 
- Public Types inherited from InferenceEngine::ILayer
using CPtr = std::shared_ptr< const ILayer >
 A shared pointer to the const ILayer object.
 

Public Member Functions

 Layer (const std::string &type, const std::string &name="")
 The constructor creates a Layer builder with layer type and layer name. More...
 
 Layer (const ILayer::CPtr &layer)
 The constructor creates a Layer builder from shared pointer to constant ILayer. More...
 
 Layer (idx_t id, const Layer &layer)
 The constructor creates a Layer builder with layer ID and layer builder. More...
 
bool operator== (const Layer &rhs) const
 Compares the given Layer builder with the current one. More...
 
idx_t getId () const noexcept override
 Returns layer ID. More...
 
const std::string & getName () const noexcept override
 Returns a constant reference to layer name. More...
 
LayersetName (const std::string &name)
 Sets layer name. More...
 
const std::string & getType () const noexcept override
 Returns a constant reference to layer type. More...
 
LayersetType (const std::string &type)
 Sets layer type. More...
 
const std::map< std::string, Parameter > & getParameters () const noexcept override
 Returns map of parameters. More...
 
std::map< std::string, Parameter > & getParameters ()
 Returns map of parameters. More...
 
LayersetParameters (const std::map< std::string, Parameter > &params)
 Sets parameters for layer. More...
 
const std::vector< Port > & getInputPorts () const noexcept override
 Returns vector of input ports. More...
 
std::vector< Port > & getInputPorts ()
 Returns vector of input ports. More...
 
LayersetInputPorts (const std::vector< Port > &ports)
 Sets input ports. More...
 
const std::vector< Port > & getOutputPorts () const noexcept override
 Returns vector of output ports. More...
 
std::vector< Port > & getOutputPorts ()
 Returns vector of output ports. More...
 
LayersetOutputPorts (const std::vector< Port > &ports)
 Sets output ports. More...
 
const ILayer::CPtr build () const
 Validates the current builder and generates ILayer object. More...
 
void validate (bool partial=false) const
 Validates layer builder.
 
- Public Member Functions inherited from InferenceEngine::ILayer
virtual ~ILayer ()=default
 Virtual destructor for the layer interface.
 

Static Public Member Functions

static void addValidator (const std::string &type, const std::function< void(const Layer::CPtr &, bool)> &validator)
 Registers a new validator for type. More...
 

Detailed Description

This class implements a builder for IE Layer.

Deprecated:
Use ngraph API instead.

Constructor & Destructor Documentation

§ Layer() [1/3]

InferenceEngine::Builder::Layer::Layer ( const std::string &  type,
const std::string &  name = "" 
)
explicit

The constructor creates a Layer builder with layer type and layer name.

Parameters
typeLayer type
nameLayer name

§ Layer() [2/3]

InferenceEngine::Builder::Layer::Layer ( const ILayer::CPtr layer)
explicit

The constructor creates a Layer builder from shared pointer to constant ILayer.

Parameters
layershared pointer to constant ILayer

§ Layer() [3/3]

InferenceEngine::Builder::Layer::Layer ( idx_t  id,
const Layer layer 
)

The constructor creates a Layer builder with layer ID and layer builder.

Parameters
idLayer ID
layerlayer builder

Member Function Documentation

§ addValidator()

static void InferenceEngine::Builder::Layer::addValidator ( const std::string &  type,
const std::function< void(const Layer::CPtr &, bool)> &  validator 
)
static

Registers a new validator for type.

Parameters
typeLayer type
validatorLayer validator

§ build()

const ILayer::CPtr InferenceEngine::Builder::Layer::build ( ) const

Validates the current builder and generates ILayer object.

Returns
constant shared pointer to ILayer

§ getId()

idx_t InferenceEngine::Builder::Layer::getId ( ) const
overridevirtualnoexcept

Returns layer ID.

Returns
Layer ID

Implements InferenceEngine::ILayer.

§ getInputPorts() [1/2]

const std::vector<Port>& InferenceEngine::Builder::Layer::getInputPorts ( ) const
overridevirtualnoexcept

Returns vector of input ports.

Returns
Vector of input ports

Implements InferenceEngine::ILayer.

§ getInputPorts() [2/2]

std::vector<Port>& InferenceEngine::Builder::Layer::getInputPorts ( )

Returns vector of input ports.

Returns
Vector of input ports

§ getName()

const std::string& InferenceEngine::Builder::Layer::getName ( ) const
overridevirtualnoexcept

Returns a constant reference to layer name.

Returns
Layer name

Implements InferenceEngine::ILayer.

§ getOutputPorts() [1/2]

const std::vector<Port>& InferenceEngine::Builder::Layer::getOutputPorts ( ) const
overridevirtualnoexcept

Returns vector of output ports.

Returns
Vector of output ports

Implements InferenceEngine::ILayer.

§ getOutputPorts() [2/2]

std::vector<Port>& InferenceEngine::Builder::Layer::getOutputPorts ( )

Returns vector of output ports.

Returns
Vector of output ports

§ getParameters() [1/2]

const std::map<std::string, Parameter>& InferenceEngine::Builder::Layer::getParameters ( ) const
overridevirtualnoexcept

Returns map of parameters.

Returns
map of parameters

Implements InferenceEngine::ILayer.

§ getParameters() [2/2]

std::map<std::string, Parameter>& InferenceEngine::Builder::Layer::getParameters ( )

Returns map of parameters.

Returns
map of parameters

§ getType()

const std::string& InferenceEngine::Builder::Layer::getType ( ) const
overridevirtualnoexcept

Returns a constant reference to layer type.

Returns
Layer type

Implements InferenceEngine::ILayer.

§ operator==()

bool InferenceEngine::Builder::Layer::operator== ( const Layer rhs) const
inline

Compares the given Layer builder with the current one.

Parameters
rhsLayer builder to compare with
Returns
true if the given Layer builder is equal to the current one, false - otherwise

§ setInputPorts()

Layer& InferenceEngine::Builder::Layer::setInputPorts ( const std::vector< Port > &  ports)

Sets input ports.

Parameters
portsvector of ports
Returns
Reference to Layer builder

§ setName()

Layer& InferenceEngine::Builder::Layer::setName ( const std::string &  name)

Sets layer name.

Parameters
nameLayer name
Returns
Reference to Layer builder

§ setOutputPorts()

Layer& InferenceEngine::Builder::Layer::setOutputPorts ( const std::vector< Port > &  ports)

Sets output ports.

Parameters
portsvector of ports
Returns
Reference to Layer builder

§ setParameters()

Layer& InferenceEngine::Builder::Layer::setParameters ( const std::map< std::string, Parameter > &  params)

Sets parameters for layer.

Parameters
paramsconstant map of parameters
Returns
Reference to Layer builder

§ setType()

Layer& InferenceEngine::Builder::Layer::setType ( const std::string &  type)

Sets layer type.

Parameters
typeLayer type
Returns
Reference to Layer builder

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