ArmNN
 21.11
INetwork Class Reference

Main network class which provides the interface for building up a neural network. More...

#include <INetwork.hpp>

Public Member Functions

Status PrintGraph ()
 
IConnectableLayerAddInputLayer (LayerBindingId id, const char *name=nullptr)
 Adds an input layer to the network. More...
 
IConnectableLayerAddArgMinMaxLayer (const ArgMinMaxDescriptor &desc, const char *name=nullptr)
 Adds an ArgMinMax layer to the network. More...
 
IConnectableLayerAddCastLayer (const char *name=nullptr)
 Adds a cast layer to the network. More...
 
IConnectableLayerAddComparisonLayer (const ComparisonDescriptor &comparisonDescriptor, const char *name=nullptr)
 Add a Comparison layer to the network. More...
 
IConnectableLayerAddConcatLayer (const ConcatDescriptor &concatDescriptor, const char *name=nullptr)
 Adds a concatenation layer to the network. More...
 
IConnectableLayerAddConvolution2dLayer (const Convolution2dDescriptor &convolution2dDescriptor, const ConstTensor &weights, const Optional< ConstTensor > &biases, const char *name=nullptr)
 Adds a 2D convolution layer to the network. More...
 
IConnectableLayerAddConvolution2dLayer (const Convolution2dDescriptor &convolution2dDescriptor, const ConstTensor &weights, const char *name=nullptr)
 
IConnectableLayerAddConvolution2dLayer (const Convolution2dDescriptor &convolution2dDescriptor, const ConstTensor &weights, const ConstTensor &biases, const char *name=nullptr)
 
IConnectableLayerAddConvolution3dLayer (const Convolution3dDescriptor &convolution3dDescriptor, const char *name=nullptr)
 Adds a 3D convolution layer to the network. More...
 
IConnectableLayerAddDepthToSpaceLayer (const DepthToSpaceDescriptor &depthToSpaceDescriptor, const char *name=nullptr)
 Adds a depth to space layer to the network. More...
 
IConnectableLayerAddDepthwiseConvolution2dLayer (const DepthwiseConvolution2dDescriptor &convolution2dDescriptor, const ConstTensor &weights, const Optional< ConstTensor > &biases, const char *name=nullptr)
 Adds a 2D depthwise convolution layer to the network. More...
 
IConnectableLayerAddDequantizeLayer (const char *name=nullptr)
 Adds a Dequantize layer to the network. More...
 
IConnectableLayerAddDetectionPostProcessLayer (const DetectionPostProcessDescriptor &descriptor, const ConstTensor &anchors, const char *name=nullptr)
 Adds a Detection PostProcess layer to the network. More...
 
IConnectableLayerAddElementwiseUnaryLayer (const ElementwiseUnaryDescriptor &elementwiseUnaryDescriptor, const char *name=nullptr)
 Add an ElementwiseUnary layer to the network. More...
 
IConnectableLayerAddFillLayer (const FillDescriptor &fillDescriptor, const char *name=nullptr)
 Add an Fill layer to the network. More...
 
IConnectableLayerAddFullyConnectedLayer (const FullyConnectedDescriptor &fullyConnectedDescriptor, const char *name=nullptr)
 Adds a fully connected layer to the network. More...
 
IConnectableLayerAddFullyConnectedLayer (const FullyConnectedDescriptor &fullyConnectedDescriptor, const Optional< ConstTensor > &weights, const Optional< ConstTensor > &biases, const char *name=nullptr)
 
IConnectableLayerAddFullyConnectedLayer (const FullyConnectedDescriptor &fullyConnectedDescriptor, const ConstTensor &weights, const Optional< ConstTensor > &biases, const char *name=nullptr)
 
IConnectableLayerAddPermuteLayer (const PermuteDescriptor &permuteDescriptor, const char *name=nullptr)
 Adds a permute layer to the network. More...
 
IConnectableLayerAddBatchToSpaceNdLayer (const BatchToSpaceNdDescriptor &batchToSpaceNdDescriptor, const char *name=nullptr)
 Adds a batch to space ND layer to the network. More...
 
IConnectableLayerAddPooling2dLayer (const Pooling2dDescriptor &pooling2dDescriptor, const char *name=nullptr)
 Adds a pooling layer to the network. More...
 
IConnectableLayerAddActivationLayer (const ActivationDescriptor &activationDescriptor, const char *name=nullptr)
 Adds an activation layer to the network. More...
 
IConnectableLayerAddNormalizationLayer (const NormalizationDescriptor &normalizationDescriptor, const char *name=nullptr)
 Adds a normalization layer to the network. More...
 
IConnectableLayerAddSliceLayer (const SliceDescriptor &sliceDescriptor, const char *name=nullptr)
 Adds a slice layer to the network. More...
 
IConnectableLayerAddSoftmaxLayer (const SoftmaxDescriptor &softmaxDescriptor, const char *name=nullptr)
 Adds a softmax layer to the network. More...
 
IConnectableLayerAddSplitterLayer (const ViewsDescriptor &splitterDescriptor, const char *name=nullptr)
 Adds a splitter layer to the network. More...
 
IConnectableLayerAddMergeLayer (const char *name=nullptr)
 Adds a merge layer to the network. More...
 
IConnectableLayerAddAdditionLayer (const char *name=nullptr)
 Adds an addition layer to the network. More...
 
IConnectableLayerAddMultiplicationLayer (const char *name=nullptr)
 Adds a multiplication layer to the network. More...
 
IConnectableLayerAddBatchNormalizationLayer (const BatchNormalizationDescriptor &desc, const ConstTensor &mean, const ConstTensor &variance, const ConstTensor &beta, const ConstTensor &gamma, const char *name=nullptr)
 Adds a batch normalization layer to the network. More...
 
IConnectableLayerAddRankLayer (const char *name=nullptr)
 Adds a rank layer to the network. More...
 
IConnectableLayerAddResizeLayer (const ResizeDescriptor &resizeDescriptor, const char *name=nullptr)
 Adds a resize layer to the network. More...
 
IConnectableLayerAddReduceLayer (const ReduceDescriptor &reduceDescriptor, const char *name=nullptr)
 Adds a reduce layer to the network. More...
 
IConnectableLayerAddInstanceNormalizationLayer (const InstanceNormalizationDescriptor &desc, const char *name=nullptr)
 Adds an instance normalization layer to the network. More...
 
IConnectableLayerAddL2NormalizationLayer (const L2NormalizationDescriptor &desc, const char *name=nullptr)
 Adds an L2 normalization layer to the network. More...
 
IConnectableLayerAddLogSoftmaxLayer (const LogSoftmaxDescriptor &logSoftmaxDescriptor, const char *name=nullptr)
 Adds a log softmax layer to the network. More...
 
IConnectableLayerAddConstantLayer (const ConstTensor &input, const char *name=nullptr)
 Adds a layer with no inputs and a single output, which always corresponds to the passed in constant tensor. More...
 
IConnectableLayerAddReshapeLayer (const ReshapeDescriptor &reshapeDescriptor, const char *name=nullptr)
 Adds a reshape layer to the network. More...
 
IConnectableLayerAddShapeLayer (const char *name=nullptr)
 Adds a shape layer to the network. More...
 
IConnectableLayerAddSpaceToBatchNdLayer (const SpaceToBatchNdDescriptor &spaceToBatchNdDescriptor, const char *name=nullptr)
 Adds a space to batch layer to the network. More...
 
IConnectableLayerAddSpaceToDepthLayer (const SpaceToDepthDescriptor &spaceToDepthDescriptor, const char *name=nullptr)
 Adds a space to depth layer to the network. More...
 
IConnectableLayerAddFloorLayer (const char *name=nullptr)
 Adds a floor layer to the network. More...
 
IConnectableLayerAddOutputLayer (LayerBindingId id, const char *name=nullptr)
 Adds an output layer to the network. More...
 
IConnectableLayerAddLstmLayer (const LstmDescriptor &descriptor, const LstmInputParams &params, const char *name=nullptr)
 Add a Lstm layer to the network. More...
 
IConnectableLayerAddDivisionLayer (const char *name=nullptr)
 Adds a division layer to the network. More...
 
IConnectableLayerAddSubtractionLayer (const char *name=nullptr)
 Adds a subtraction layer to the network. More...
 
IConnectableLayerAddMaximumLayer (const char *name=nullptr)
 Add a Maximum layer to the network. More...
 
IConnectableLayerAddMeanLayer (const MeanDescriptor &meanDescriptor, const char *name=nullptr)
 Add a Mean layer to the network. More...
 
IConnectableLayerAddPadLayer (const PadDescriptor &padDescriptor, const char *name=nullptr)
 Adds a fully pad layer to the network. More...
 
IConnectableLayerAddQuantizeLayer (const char *name=nullptr)
 Add a quantize layer to the network. More...
 
IConnectableLayerAddStridedSliceLayer (const StridedSliceDescriptor &stridedSliceDescriptor, const char *name=nullptr)
 Adds a strided slice layer to the network. More...
 
IConnectableLayerAddMinimumLayer (const char *name=nullptr)
 Add a Minimum layer to the network. More...
 
IConnectableLayerAddGatherLayer (const GatherDescriptor &descriptor, const char *name=nullptr)
 Add Gather layer to the network. More...
 
IConnectableLayerAddSwitchLayer (const char *name=nullptr)
 Adds a switch layer to the network. More...
 
IConnectableLayerAddPreluLayer (const char *name=nullptr)
 Adds a PReLU layer to the network. More...
 
IConnectableLayerAddTransposeConvolution2dLayer (const TransposeConvolution2dDescriptor &descriptor, const ConstTensor &weights, const Optional< ConstTensor > &biases, const char *name=nullptr)
 Adds a 2D transpose convolution layer to the network. More...
 
IConnectableLayerAddTransposeLayer (const TransposeDescriptor &transposeDescriptor, const char *name=nullptr)
 Adds a transpose layer to the network. More...
 
IConnectableLayerAddStackLayer (const StackDescriptor &descriptor, const char *name=nullptr)
 Adds a stack layer to the network. More...
 
IConnectableLayerAddStandInLayer (const StandInDescriptor &descriptor, const char *name=nullptr)
 Add a stand-in layer for a type unknown to the Arm NN framework. More...
 
IConnectableLayerAddQuantizedLstmLayer (const QuantizedLstmInputParams &params, const char *name=nullptr)
 Add a QuantizedLstm layer to the network. More...
 
IConnectableLayerAddQLstmLayer (const QLstmDescriptor &descriptor, const LstmInputParams &params, const char *name=nullptr)
 Add a QLstm layer to the network. More...
 
IConnectableLayerAddLogicalBinaryLayer (const LogicalBinaryDescriptor &descriptor, const char *name=nullptr)
 Adds a Logical Binary layer to the network. More...
 
IConnectableLayerAddUnidirectionalSequenceLstmLayer (const UnidirectionalSequenceLstmDescriptor &descriptor, const LstmInputParams &params, const char *name=nullptr)
 Add a UnidirectionalSequenceLstm layer to the network. More...
 
IConnectableLayerAddChannelShuffleLayer (const ChannelShuffleDescriptor &descriptor, const char *name=nullptr)
 Add a ChannelShuffle layer to the network. More...
 
ARMNN_NO_DEPRECATE_WARN_BEGIN ARMNN_DEPRECATED_MSG_REMOVAL_DATE ("Accept is deprecated. The ILayerVisitor that works in conjunction with this " "Accept function is deprecated. Use IStrategy in combination with " "ExecuteStrategy instead, which is an ABI/API stable version of the " "visitor pattern.", "22.05") void Accept(ILayerVisitor &visitor) const
 Apply a visitor to this layer. More...
 
ARMNN_NO_DEPRECATE_WARN_END void ExecuteStrategy (IStrategy &strategy) const
 

Static Public Member Functions

static INetworkCreateRaw (NetworkOptions networkOptions={})
 
static INetworkPtr Create (NetworkOptions networkOptions={})
 
static void Destroy (INetwork *network)
 

Protected Member Functions

 ~INetwork ()
 
 INetwork (NetworkOptions networkOptions={})
 

Protected Attributes

std::unique_ptr< NetworkImplpNetworkImpl
 

Friends

class TestConnectionPreservation
 
void VisitLayersTopologically (const INetwork *inputNetwork, IStrategy &strategy)
 
TensorInfo GetInputTensorInfo (const INetwork *network)
 
IOptimizedNetworkPtr Optimize (const INetwork &network, const std::vector< BackendId > &backendPreferences, const IDeviceSpec &deviceSpec, const OptimizerOptions &options, Optional< std::vector< std::string > &> messages)
 Create an optimized version of the network. More...
 

Detailed Description

Main network class which provides the interface for building up a neural network.

This object is subsequently required by the IRuntime::Load() method.

Definition at line 202 of file INetwork.hpp.

Constructor & Destructor Documentation

◆ ~INetwork()

~INetwork ( )
protecteddefault

Referenced by INetwork::INetwork().

◆ INetwork()

INetwork ( NetworkOptions  networkOptions = {})
protected

Definition at line 45 of file Network.cpp.

References INetwork::~INetwork().

Referenced by INetwork::CreateRaw().

45 : pNetworkImpl(new NetworkImpl(networkOptions)) {}
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

Member Function Documentation

◆ AddActivationLayer()

IConnectableLayer * AddActivationLayer ( const ActivationDescriptor activationDescriptor,
const char *  name = nullptr 
)

Adds an activation layer to the network.

Parameters
activationDescriptor- ActivationDescriptor to configure the activation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 211 of file Network.cpp.

References INetwork::pNetworkImpl.

213 {
214  return pNetworkImpl->AddActivationLayer(activationDescriptor, name);
215 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddAdditionLayer()

IConnectableLayer * AddAdditionLayer ( const char *  name = nullptr)

Adds an addition layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 244 of file Network.cpp.

References INetwork::pNetworkImpl.

245 {
246  return pNetworkImpl->AddAdditionLayer(name);
247 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddArgMinMaxLayer()

IConnectableLayer * AddArgMinMaxLayer ( const ArgMinMaxDescriptor desc,
const char *  name = nullptr 
)

Adds an ArgMinMax layer to the network.

Parameters
desc- Parameters for the L2 normalization operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 60 of file Network.cpp.

References INetwork::pNetworkImpl.

62 {
63  return pNetworkImpl->AddArgMinMaxLayer(desc, name);
64 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddBatchNormalizationLayer()

IConnectableLayer * AddBatchNormalizationLayer ( const BatchNormalizationDescriptor desc,
const ConstTensor mean,
const ConstTensor variance,
const ConstTensor beta,
const ConstTensor gamma,
const char *  name = nullptr 
)

Adds a batch normalization layer to the network.

Parameters
mean- Pre-calculated mean for each channel.
variance- Pre-calculated variance for each channel.
beta- Per-channel additive factor.
gamma- Per-channel multiplicative factor.
Returns
- Interface for configuring the layer.
Parameters
name- Optional name for the layer.

Definition at line 254 of file Network.cpp.

References INetwork::pNetworkImpl.

260 {
261  return pNetworkImpl->AddBatchNormalizationLayer(desc, mean, variance, beta, gamma, name);
262 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddBatchToSpaceNdLayer()

IConnectableLayer * AddBatchToSpaceNdLayer ( const BatchToSpaceNdDescriptor batchToSpaceNdDescriptor,
const char *  name = nullptr 
)

Adds a batch to space ND layer to the network.

Parameters
batchToSpaceNdDescriptor- Description of the layer.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 199 of file Network.cpp.

References INetwork::pNetworkImpl.

201 {
202  return pNetworkImpl->AddBatchToSpaceNdLayer(batchToSpaceNdDescriptor, name);
203 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddCastLayer()

IConnectableLayer * AddCastLayer ( const char *  name = nullptr)

Adds a cast layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 66 of file Network.cpp.

References INetwork::pNetworkImpl.

67 {
68  return pNetworkImpl->AddCastLayer(name);
69 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddChannelShuffleLayer()

IConnectableLayer * AddChannelShuffleLayer ( const ChannelShuffleDescriptor descriptor,
const char *  name = nullptr 
)

Add a ChannelShuffle layer to the network.

Parameters
descriptor- Parameters for the ChannelShuffle operation
name- Optional name for the layer
Returns
- Interface for configuring the layer

Definition at line 455 of file Network.cpp.

References ARMNN_NO_DEPRECATE_WARN_BEGIN, ARMNN_NO_DEPRECATE_WARN_END, and INetwork::pNetworkImpl.

457 {
458  return pNetworkImpl->AddChannelShuffleLayer(descriptor, name);
459 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddComparisonLayer()

IConnectableLayer * AddComparisonLayer ( const ComparisonDescriptor comparisonDescriptor,
const char *  name = nullptr 
)

Add a Comparison layer to the network.

Parameters
name- Optional name for the layer.
desc- Descriptor for the comparison operation.
Returns
- Interface for configuring the layer.

Definition at line 71 of file Network.cpp.

References INetwork::pNetworkImpl.

73 {
74  return pNetworkImpl->AddComparisonLayer(comparisonDescriptor, name);
75 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddConcatLayer()

IConnectableLayer * AddConcatLayer ( const ConcatDescriptor concatDescriptor,
const char *  name = nullptr 
)

Adds a concatenation layer to the network.

Parameters
concatDescriptor- ConcatDescriptor (synonym for OriginsDescriptor) to configure the concatenation process. Number of Views must be equal to the number of inputs, and their order must match - e.g. first view corresponds to the first input, second view to the second input, etc....
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 78 of file Network.cpp.

References INetwork::pNetworkImpl.

80 {
81  return pNetworkImpl->AddConcatLayer(concatDescriptor, name);
82 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddConstantLayer()

IConnectableLayer * AddConstantLayer ( const ConstTensor input,
const char *  name = nullptr 
)

Adds a layer with no inputs and a single output, which always corresponds to the passed in constant tensor.

Parameters
input- Tensor to be provided as the only output of the layer. The layer will maintain its own copy of the tensor data, meaning the memory referenced by input can be freed or reused after this function is called.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 299 of file Network.cpp.

References INetwork::pNetworkImpl.

301 {
302  return pNetworkImpl->AddConstantLayer(input, name);
303 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddConvolution2dLayer() [1/3]

IConnectableLayer * AddConvolution2dLayer ( const Convolution2dDescriptor convolution2dDescriptor,
const ConstTensor weights,
const Optional< ConstTensor > &  biases,
const char *  name = nullptr 
)

Adds a 2D convolution layer to the network.

Parameters
convolution2dDescriptor- Description of the 2D convolution layer.
weights- Tensor for the weights data.
biases- Optional tensor for the bias data. If specified, must match the output tensor shape.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 85 of file Network.cpp.

References INetwork::pNetworkImpl.

Referenced by TEST_SUITE().

89 {
90  return pNetworkImpl->AddConvolution2dLayer(convolution2dDescriptor, weights, biases, name);
91 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddConvolution2dLayer() [2/3]

IConnectableLayer * AddConvolution2dLayer ( const Convolution2dDescriptor convolution2dDescriptor,
const ConstTensor weights,
const char *  name = nullptr 
)

Definition at line 94 of file Network.cpp.

References INetwork::pNetworkImpl.

97 {
98  Optional<ConstTensor> biases;
99  return pNetworkImpl->AddConvolution2dLayer(convolution2dDescriptor, weights, biases, name);
100 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddConvolution2dLayer() [3/3]

IConnectableLayer * AddConvolution2dLayer ( const Convolution2dDescriptor convolution2dDescriptor,
const ConstTensor weights,
const ConstTensor biases,
const char *  name = nullptr 
)

Definition at line 103 of file Network.cpp.

References INetwork::pNetworkImpl.

107 {
108 
109  return pNetworkImpl->AddConvolution2dLayer(convolution2dDescriptor,
110  weights,
112  name);
113 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddConvolution3dLayer()

IConnectableLayer * AddConvolution3dLayer ( const Convolution3dDescriptor convolution3dDescriptor,
const char *  name = nullptr 
)

Adds a 3D convolution layer to the network.

Parameters
convolution3dDescriptor- Description of the 3D convolution layer.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 116 of file Network.cpp.

References INetwork::pNetworkImpl.

118 {
119  return pNetworkImpl->AddConvolution3dLayer(convolution3dDescriptor, name);
120 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddDepthToSpaceLayer()

IConnectableLayer * AddDepthToSpaceLayer ( const DepthToSpaceDescriptor depthToSpaceDescriptor,
const char *  name = nullptr 
)

Adds a depth to space layer to the network.

Parameters
depthToSpaceDescriptor- Parameters for the depth to space operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 123 of file Network.cpp.

References INetwork::pNetworkImpl.

125 {
126  return pNetworkImpl->AddDepthToSpaceLayer(depthToSpaceDescriptor, name);
127 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddDepthwiseConvolution2dLayer()

IConnectableLayer * AddDepthwiseConvolution2dLayer ( const DepthwiseConvolution2dDescriptor convolution2dDescriptor,
const ConstTensor weights,
const Optional< ConstTensor > &  biases,
const char *  name = nullptr 
)

Adds a 2D depthwise convolution layer to the network.

Parameters
convolution2dDescriptor- Description of the 2D depthwise convolution layer.
weights- Tensor for the weights. Expected format: [channelMultiplier, inputChannels, height, width].
biasesOptional tensor for the bias data. If specified, must match the output tensor shape.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 130 of file Network.cpp.

References INetwork::pNetworkImpl.

Referenced by TEST_SUITE().

135 {
136  return pNetworkImpl->AddDepthwiseConvolution2dLayer(convolution2dDescriptor, weights, biases, name);
137 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddDequantizeLayer()

IConnectableLayer * AddDequantizeLayer ( const char *  name = nullptr)

Adds a Dequantize layer to the network.

Returns
- Interface for configuring the layer.

Definition at line 140 of file Network.cpp.

References INetwork::pNetworkImpl.

141 {
142  return pNetworkImpl->AddDequantizeLayer(name);
143 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddDetectionPostProcessLayer()

IConnectableLayer * AddDetectionPostProcessLayer ( const DetectionPostProcessDescriptor descriptor,
const ConstTensor anchors,
const char *  name = nullptr 
)

Adds a Detection PostProcess layer to the network.

Parameters
descriptor- Description of the Detection PostProcess layer.
anchors- Tensor for anchors.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 146 of file Network.cpp.

References INetwork::pNetworkImpl.

150 {
151  return pNetworkImpl->AddDetectionPostProcessLayer(descriptor, anchors, name);
152 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddDivisionLayer()

IConnectableLayer * AddDivisionLayer ( const char *  name = nullptr)

Adds a division layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 339 of file Network.cpp.

References INetwork::pNetworkImpl.

340 {
341  return pNetworkImpl->AddDivisionLayer(name);
342 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddElementwiseUnaryLayer()

IConnectableLayer * AddElementwiseUnaryLayer ( const ElementwiseUnaryDescriptor elementwiseUnaryDescriptor,
const char *  name = nullptr 
)

Add an ElementwiseUnary layer to the network.

Parameters
name- Optional name for the layer.
desc- Descriptor for the elementwiseUnary operation.
Returns
- Interface for configuring the layer.

Definition at line 155 of file Network.cpp.

References INetwork::pNetworkImpl.

157 {
158  return pNetworkImpl->AddElementwiseUnaryLayer(elementwiseUnaryDescriptor, name);
159 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddFillLayer()

IConnectableLayer * AddFillLayer ( const FillDescriptor fillDescriptor,
const char *  name = nullptr 
)

Add an Fill layer to the network.

Parameters
name- Optional name for the layer.
fillDescriptor- Descriptor for the fill operation.
Returns
- Interface for configuring the layer.

Definition at line 162 of file Network.cpp.

References INetwork::pNetworkImpl.

164 {
165  return pNetworkImpl->AddFillLayer(fillDescriptor, name);
166 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddFloorLayer()

IConnectableLayer * AddFloorLayer ( const char *  name = nullptr)

Adds a floor layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 323 of file Network.cpp.

References INetwork::pNetworkImpl.

324 {
325  return pNetworkImpl->AddFloorLayer(name);
326 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddFullyConnectedLayer() [1/3]

IConnectableLayer * AddFullyConnectedLayer ( const FullyConnectedDescriptor fullyConnectedDescriptor,
const char *  name = nullptr 
)

Adds a fully connected layer to the network.

Parameters
fullyConnectedDescriptor- Description of the fully connected layer.
Returns
- Interface for configuring the layer.
Note
Weights and biases are passed in as inputs. If they are constant tensors you can simply store them in a ConstantLayer as seen below. A full example can be found in samples/SimpleSample.cpp.
// Make sure the IsConstant flag is set on the weightsInfo before passing it to the ConstTensor.
ConstTensor weights(weightsInfo, weightsData);
// Constant layer that now holds weights data for FullyConnected
IConnectableLayer* const constantWeightsLayer = myNetwork->AddConstantLayer(weights, "weights");
FullyConnectedDescriptor fullyConnectedDesc;
IConnectableLayer* const fullyConnectedLayer = myNetwork->AddFullyConnectedLayer(fullyConnectedDesc,
"fully connected");
IConnectableLayer* InputLayer = myNetwork->AddInputLayer(0);
InputLayer->GetOutputSlot(0).Connect(fullyConnectedLayer->GetInputSlot(0));
constantWeightsLayer->GetOutputSlot(0).Connect(fullyConnectedLayer->GetInputSlot(1));

Definition at line 168 of file Network.cpp.

References INetwork::pNetworkImpl.

170 {
171  return pNetworkImpl->AddFullyConnectedLayer(fullyConnectedDescriptor, name);
172 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddFullyConnectedLayer() [2/3]

IConnectableLayer * AddFullyConnectedLayer ( const FullyConnectedDescriptor fullyConnectedDescriptor,
const Optional< ConstTensor > &  weights,
const Optional< ConstTensor > &  biases,
const char *  name = nullptr 
)

Definition at line 185 of file Network.cpp.

References INetwork::pNetworkImpl.

189 {
190  return pNetworkImpl->AddFullyConnectedLayer(fullyConnectedDescriptor, weights, biases, name);
191 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddFullyConnectedLayer() [3/3]

IConnectableLayer * AddFullyConnectedLayer ( const FullyConnectedDescriptor fullyConnectedDescriptor,
const ConstTensor weights,
const Optional< ConstTensor > &  biases,
const char *  name = nullptr 
)

Definition at line 174 of file Network.cpp.

References INetwork::pNetworkImpl.

178 {
179  return pNetworkImpl->AddFullyConnectedLayer(fullyConnectedDescriptor,
181  biases,
182  name);
183 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddGatherLayer()

IConnectableLayer * AddGatherLayer ( const GatherDescriptor descriptor,
const char *  name = nullptr 
)

Add Gather layer to the network.

Parameters
descriptor- Description of the gather layer.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 381 of file Network.cpp.

References INetwork::pNetworkImpl.

383 {
384  return pNetworkImpl->AddGatherLayer(descriptor, name);
385 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddInputLayer()

IConnectableLayer * AddInputLayer ( LayerBindingId  id,
const char *  name = nullptr 
)

Adds an input layer to the network.

Parameters
id- User generated id to uniquely identify a particular input. The same id needs to be specified. when passing the inputs to the IRuntime::EnqueueWorkload() function.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 54 of file Network.cpp.

References INetwork::pNetworkImpl.

55 {
56  return pNetworkImpl->AddInputLayer(id, name);
57 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddInstanceNormalizationLayer()

IConnectableLayer * AddInstanceNormalizationLayer ( const InstanceNormalizationDescriptor desc,
const char *  name = nullptr 
)

Adds an instance normalization layer to the network.

Parameters
desc- Parameters for the instance normalization operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 281 of file Network.cpp.

References INetwork::pNetworkImpl.

283 {
284  return pNetworkImpl->AddInstanceNormalizationLayer(desc, name);
285 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddL2NormalizationLayer()

IConnectableLayer * AddL2NormalizationLayer ( const L2NormalizationDescriptor desc,
const char *  name = nullptr 
)

Adds an L2 normalization layer to the network.

Normalization is performed along dimension 1, but requires a 4d input.

Parameters
desc- Parameters for the L2 normalization operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 287 of file Network.cpp.

References INetwork::pNetworkImpl.

289 {
290  return pNetworkImpl->AddL2NormalizationLayer(desc, name);
291 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddLogicalBinaryLayer()

IConnectableLayer * AddLogicalBinaryLayer ( const LogicalBinaryDescriptor descriptor,
const char *  name = nullptr 
)

Adds a Logical Binary layer to the network.

Parameters
descriptor- Description of the Logical Binary layer.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 441 of file Network.cpp.

References INetwork::pNetworkImpl.

443 {
444  return pNetworkImpl->AddLogicalBinaryLayer(descriptor, name);
445 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddLogSoftmaxLayer()

IConnectableLayer * AddLogSoftmaxLayer ( const LogSoftmaxDescriptor logSoftmaxDescriptor,
const char *  name = nullptr 
)

Adds a log softmax layer to the network.

Parameters
logSoftmaxDescriptor- LogSoftmaxDescriptor to configure the log softmax.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 293 of file Network.cpp.

References INetwork::pNetworkImpl.

295 {
296  return pNetworkImpl->AddLogSoftmaxLayer(logSoftmaxDescriptor, name);
297 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddLstmLayer()

IConnectableLayer * AddLstmLayer ( const LstmDescriptor descriptor,
const LstmInputParams params,
const char *  name = nullptr 
)

Add a Lstm layer to the network.

Parameters
descriptor- Parameters for the Lstm operation
params- Weights and biases for the LSTM cell
name- Optional name for the layer
Returns
- Interface for configuring the layer.

Definition at line 332 of file Network.cpp.

References INetwork::pNetworkImpl.

335 {
336  return pNetworkImpl->AddLstmLayer(descriptor, params, name);
337 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddMaximumLayer()

IConnectableLayer * AddMaximumLayer ( const char *  name = nullptr)

Add a Maximum layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 349 of file Network.cpp.

References INetwork::pNetworkImpl.

350 {
351  return pNetworkImpl->AddMaximumLayer(name);
352 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddMeanLayer()

IConnectableLayer * AddMeanLayer ( const MeanDescriptor meanDescriptor,
const char *  name = nullptr 
)

Add a Mean layer to the network.

Parameters
meanDescriptor- Parameters for the mean operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 354 of file Network.cpp.

References INetwork::pNetworkImpl.

355 {
356  return pNetworkImpl->AddMeanLayer(meanDescriptor, name);
357 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddMergeLayer()

IConnectableLayer * AddMergeLayer ( const char *  name = nullptr)

Adds a merge layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 239 of file Network.cpp.

References INetwork::pNetworkImpl.

240 {
241  return pNetworkImpl->AddMergeLayer(name);
242 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddMinimumLayer()

IConnectableLayer * AddMinimumLayer ( const char *  name = nullptr)

Add a Minimum layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 376 of file Network.cpp.

References INetwork::pNetworkImpl.

377 {
378  return pNetworkImpl->AddMinimumLayer(name);
379 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddMultiplicationLayer()

IConnectableLayer * AddMultiplicationLayer ( const char *  name = nullptr)

Adds a multiplication layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 249 of file Network.cpp.

References INetwork::pNetworkImpl.

250 {
251  return pNetworkImpl->AddMultiplicationLayer(name);
252 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddNormalizationLayer()

IConnectableLayer * AddNormalizationLayer ( const NormalizationDescriptor normalizationDescriptor,
const char *  name = nullptr 
)

Adds a normalization layer to the network.

Parameters
normalizationDescriptor- NormalizationDescriptor to configure the normalization.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 217 of file Network.cpp.

References INetwork::pNetworkImpl.

219 {
220  return pNetworkImpl->AddNormalizationLayer(normalizationDescriptor, name);
221 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddOutputLayer()

IConnectableLayer * AddOutputLayer ( LayerBindingId  id,
const char *  name = nullptr 
)

Adds an output layer to the network.

Parameters
id- User generated id to uniquely identify a particular output. The same id needs to be specified when passing the outputs to the IRuntime::EnqueueWorkload() function.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 327 of file Network.cpp.

References INetwork::pNetworkImpl.

328 {
329  return pNetworkImpl->AddOutputLayer(id, name);
330 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddPadLayer()

IConnectableLayer * AddPadLayer ( const PadDescriptor padDescriptor,
const char *  name = nullptr 
)

Adds a fully pad layer to the network.

Parameters
paddings- n by 2 tensor, where n is the rank of the input tensor, such that paddings[i,0] indicates the amount of padding to add in front of dimonsion i, and paddings[i,1] indicates the amount of padding to add after the end of dimension i
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 359 of file Network.cpp.

References INetwork::pNetworkImpl.

361 {
362  return pNetworkImpl->AddPadLayer(padDescriptor, name);
363 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddPermuteLayer()

IConnectableLayer * AddPermuteLayer ( const PermuteDescriptor permuteDescriptor,
const char *  name = nullptr 
)

Adds a permute layer to the network.

Parameters
permuteDescriptor- PermuteDescriptor to configure the permute.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 193 of file Network.cpp.

References INetwork::pNetworkImpl.

195 {
196  return pNetworkImpl->AddPermuteLayer(permuteDescriptor, name);
197 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddPooling2dLayer()

IConnectableLayer * AddPooling2dLayer ( const Pooling2dDescriptor pooling2dDescriptor,
const char *  name = nullptr 
)

Adds a pooling layer to the network.

Parameters
pooling2dDescriptor- Pooling2dDescriptor to configure the pooling.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 205 of file Network.cpp.

References INetwork::pNetworkImpl.

207 {
208  return pNetworkImpl->AddPooling2dLayer(pooling2dDescriptor, name);
209 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddPreluLayer()

IConnectableLayer * AddPreluLayer ( const char *  name = nullptr)

Adds a PReLU layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 392 of file Network.cpp.

References INetwork::pNetworkImpl.

393 {
394  return pNetworkImpl->AddPreluLayer(name);
395 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddQLstmLayer()

IConnectableLayer * AddQLstmLayer ( const QLstmDescriptor descriptor,
const LstmInputParams params,
const char *  name = nullptr 
)

Add a QLstm layer to the network.

Parameters
descriptor- Parameters for the QLstm operation
params- Weights and biases for the layer
name- Optional name for the layer
Returns
- Interface for configuring the layer.

Definition at line 434 of file Network.cpp.

References INetwork::pNetworkImpl.

437 {
438  return pNetworkImpl->AddQLstmLayer(descriptor, params, name);
439 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddQuantizedLstmLayer()

IConnectableLayer * AddQuantizedLstmLayer ( const QuantizedLstmInputParams params,
const char *  name = nullptr 
)

Add a QuantizedLstm layer to the network.

Parameters
params- The weights and biases for the Quantized LSTM cell
name- Optional name for the layer
Returns
- Interface for configuring the layer.

Definition at line 428 of file Network.cpp.

References INetwork::pNetworkImpl.

430 {
431  return pNetworkImpl->AddQuantizedLstmLayer(params, name);
432 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddQuantizeLayer()

IConnectableLayer * AddQuantizeLayer ( const char *  name = nullptr)

Add a quantize layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 365 of file Network.cpp.

References INetwork::pNetworkImpl.

366 {
367  return pNetworkImpl->AddQuantizeLayer(name);
368 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddRankLayer()

IConnectableLayer * AddRankLayer ( const char *  name = nullptr)

Adds a rank layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 264 of file Network.cpp.

References INetwork::pNetworkImpl.

265 {
266  return pNetworkImpl->AddRankLayer(name);
267 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddReduceLayer()

IConnectableLayer * AddReduceLayer ( const ReduceDescriptor reduceDescriptor,
const char *  name = nullptr 
)

Adds a reduce layer to the network.

Parameters
ReduceDescriptor- Parameters for the reduce operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 275 of file Network.cpp.

References INetwork::pNetworkImpl.

277 {
278  return pNetworkImpl->AddReduceLayer(reduceDescriptor, name);
279 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddReshapeLayer()

IConnectableLayer * AddReshapeLayer ( const ReshapeDescriptor reshapeDescriptor,
const char *  name = nullptr 
)

Adds a reshape layer to the network.

Parameters
reshapeDescriptor- Parameters for the reshape operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 305 of file Network.cpp.

References INetwork::pNetworkImpl.

307 {
308  return pNetworkImpl->AddReshapeLayer(reshapeDescriptor, name);
309 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddResizeLayer()

IConnectableLayer * AddResizeLayer ( const ResizeDescriptor resizeDescriptor,
const char *  name = nullptr 
)

Adds a resize layer to the network.

Parameters
resizeDescriptor- Parameters for the resize operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 269 of file Network.cpp.

References INetwork::pNetworkImpl.

271 {
272  return pNetworkImpl->AddResizeLayer(resizeDescriptor, name);
273 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddShapeLayer()

IConnectableLayer * AddShapeLayer ( const char *  name = nullptr)

Adds a shape layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 411 of file Network.cpp.

References INetwork::pNetworkImpl.

412 {
413  return pNetworkImpl->AddShapeLayer(name);
414 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddSliceLayer()

IConnectableLayer * AddSliceLayer ( const SliceDescriptor sliceDescriptor,
const char *  name = nullptr 
)

Adds a slice layer to the network.

Parameters
sliceDescriptor- SliceDescriptor to configure the slice operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 223 of file Network.cpp.

References INetwork::pNetworkImpl.

224 {
225  return pNetworkImpl->AddSliceLayer(sliceDescriptor, name);
226 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddSoftmaxLayer()

IConnectableLayer * AddSoftmaxLayer ( const SoftmaxDescriptor softmaxDescriptor,
const char *  name = nullptr 
)

Adds a softmax layer to the network.

If the data type is QAsymm8, then the output quantization parameters must have a scale of 1/256 and an offset of 0

Parameters
softmaxDescriptor- SoftmaxDescriptor to configure the softmax.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 227 of file Network.cpp.

References INetwork::pNetworkImpl.

229 {
230  return pNetworkImpl->AddSoftmaxLayer(softmaxDescriptor, name);
231 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddSpaceToBatchNdLayer()

IConnectableLayer * AddSpaceToBatchNdLayer ( const SpaceToBatchNdDescriptor spaceToBatchNdDescriptor,
const char *  name = nullptr 
)

Adds a space to batch layer to the network.

Parameters
spaceToBatchNdDescriptor- Parameters for the space to batch operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 311 of file Network.cpp.

References INetwork::pNetworkImpl.

313 {
314  return pNetworkImpl->AddSpaceToBatchNdLayer(spaceToBatchNdDescriptor, name);
315 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddSpaceToDepthLayer()

IConnectableLayer * AddSpaceToDepthLayer ( const SpaceToDepthDescriptor spaceToDepthDescriptor,
const char *  name = nullptr 
)

Adds a space to depth layer to the network.

Parameters
spaceToDepthDescriptor- Parameters for the space to depth operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 317 of file Network.cpp.

References INetwork::pNetworkImpl.

319 {
320  return pNetworkImpl->AddSpaceToDepthLayer(spaceToDepthDescriptor, name);
321 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddSplitterLayer()

IConnectableLayer * AddSplitterLayer ( const ViewsDescriptor splitterDescriptor,
const char *  name = nullptr 
)

Adds a splitter layer to the network.

Parameters
splitterDescriptor- ViewsDescriptor to configure the splitting process. Number of Views must be equal to the number of outputs, and their order must match - e.g. first view corresponds to the first output, second view to the second output, etc....
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 233 of file Network.cpp.

References INetwork::pNetworkImpl.

235 {
236  return pNetworkImpl->AddSplitterLayer(splitterDescriptor, name);
237 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddStackLayer()

IConnectableLayer * AddStackLayer ( const StackDescriptor descriptor,
const char *  name = nullptr 
)

Adds a stack layer to the network.

Parameters
descriptor- Description of the stack layer.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 416 of file Network.cpp.

References INetwork::pNetworkImpl.

418 {
419  return pNetworkImpl->AddStackLayer(descriptor, name);
420 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddStandInLayer()

IConnectableLayer * AddStandInLayer ( const StandInDescriptor descriptor,
const char *  name = nullptr 
)

Add a stand-in layer for a type unknown to the Arm NN framework.

Note: Due to the nature of this layer, no validation can be performed by the framework. Furthermore, Any model containing this layer cannot make use of dynamic tensors since the tensor sizes cannot be inferred. - Descriptor for the StandIn layer.

Returns
- Interface for configuring the layer.

Definition at line 422 of file Network.cpp.

References INetwork::pNetworkImpl.

424 {
425  return pNetworkImpl->AddStandInLayer(descriptor, name);
426 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddStridedSliceLayer()

IConnectableLayer * AddStridedSliceLayer ( const StridedSliceDescriptor stridedSliceDescriptor,
const char *  name = nullptr 
)

Adds a strided slice layer to the network.

Parameters
StridedSliceDescriptor- Parameters for the strided slice operation.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 370 of file Network.cpp.

References INetwork::pNetworkImpl.

372 {
373  return pNetworkImpl->AddStridedSliceLayer(stridedSliceDescriptor, name);
374 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddSubtractionLayer()

IConnectableLayer * AddSubtractionLayer ( const char *  name = nullptr)

Adds a subtraction layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 344 of file Network.cpp.

References INetwork::pNetworkImpl.

345 {
346  return pNetworkImpl->AddSubtractionLayer(name);
347 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddSwitchLayer()

IConnectableLayer * AddSwitchLayer ( const char *  name = nullptr)

Adds a switch layer to the network.

Parameters
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 387 of file Network.cpp.

References INetwork::pNetworkImpl.

388 {
389  return pNetworkImpl->AddSwitchLayer(name);
390 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddTransposeConvolution2dLayer()

IConnectableLayer * AddTransposeConvolution2dLayer ( const TransposeConvolution2dDescriptor descriptor,
const ConstTensor weights,
const Optional< ConstTensor > &  biases,
const char *  name = nullptr 
)

Adds a 2D transpose convolution layer to the network.

Parameters
descriptor- Description of the 2D transpose convolution layer.
weights- Tensor for the weights data.
biases- Optional tensor for the bias data.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 397 of file Network.cpp.

References INetwork::pNetworkImpl.

401 {
402  return pNetworkImpl->AddTransposeConvolution2dLayer(descriptor, weights, biases, name);
403 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddTransposeLayer()

IConnectableLayer * AddTransposeLayer ( const TransposeDescriptor transposeDescriptor,
const char *  name = nullptr 
)

Adds a transpose layer to the network.

Parameters
transposeDescriptor- TransposeDescriptor to configure the transpose.
name- Optional name for the layer.
Returns
- Interface for configuring the layer.

Definition at line 405 of file Network.cpp.

References INetwork::pNetworkImpl.

407 {
408  return pNetworkImpl->AddTransposeLayer(transposeDescriptor, name);
409 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ AddUnidirectionalSequenceLstmLayer()

IConnectableLayer * AddUnidirectionalSequenceLstmLayer ( const UnidirectionalSequenceLstmDescriptor descriptor,
const LstmInputParams params,
const char *  name = nullptr 
)

Add a UnidirectionalSequenceLstm layer to the network.

Parameters
descriptor- Parameters for the UnidirectionalSequenceLstm operation
params- Weights and biases for the UnidirectionalSequenceLstm
name- Optional name for the layer
Returns
- Interface for configuring the layer.

Definition at line 447 of file Network.cpp.

References INetwork::pNetworkImpl.

451 {
452  return pNetworkImpl->AddUnidirectionalSequenceLstmLayer(descriptor, params, name);
453 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ ARMNN_DEPRECATED_MSG_REMOVAL_DATE()

ARMNN_NO_DEPRECATE_WARN_BEGIN ARMNN_DEPRECATED_MSG_REMOVAL_DATE ( "Accept is deprecated. The ILayerVisitor that works in conjunction with this " "Accept function is deprecated. Use IStrategy in combination with " "ExecuteStrategy  instead,
which is an ABI/API stable version of the " "visitor pattern."  ,
"22.05"   
) const &

Apply a visitor to this layer.

◆ Create()

armnn::INetworkPtr Create ( NetworkOptions  networkOptions = {})
static
Examples:
AsyncExecutionSample.cpp, DynamicSample.cpp, and SimpleSample.cpp.

Definition at line 478 of file Network.cpp.

References INetwork::CreateRaw(), and INetwork::Destroy().

Referenced by armnn::experimental::CreateStridedSliceNetwork(), GetSoftmaxProfilerJson(), QLstmEndToEnd(), TEST_SUITE(), and VerifyPostOptimisationStructureTestImpl().

479 {
480  return INetworkPtr(CreateRaw(networkOptions), &INetwork::Destroy);
481 }
static void Destroy(INetwork *network)
Definition: Network.cpp:483
static INetwork * CreateRaw(NetworkOptions networkOptions={})
Definition: Network.cpp:473
std::unique_ptr< INetwork, void(*)(INetwork *network)> INetworkPtr
Definition: INetwork.hpp:197

◆ CreateRaw()

armnn::INetwork * CreateRaw ( NetworkOptions  networkOptions = {})
static

Definition at line 473 of file Network.cpp.

References INetwork::INetwork().

Referenced by INetwork::Create().

474 {
475  return new INetwork(networkOptions);
476 }
INetwork(NetworkOptions networkOptions={})
Definition: Network.cpp:45

◆ Destroy()

void Destroy ( INetwork network)
static

Definition at line 483 of file Network.cpp.

Referenced by INetwork::Create().

484 {
485  delete network;
486 }

◆ ExecuteStrategy()

ARMNN_NO_DEPRECATE_WARN_END void ExecuteStrategy ( IStrategy strategy) const

Definition at line 468 of file Network.cpp.

References INetwork::pNetworkImpl.

Referenced by ISerializer::SerializerImpl::Serialize().

469 {
470  return pNetworkImpl->ExecuteStrategy(strategy);
471 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

◆ PrintGraph()

Status PrintGraph ( )

Definition at line 49 of file Network.cpp.

References INetwork::pNetworkImpl.

50 {
51  return pNetworkImpl->PrintGraph();
52 }
std::unique_ptr< NetworkImpl > pNetworkImpl
Definition: INetwork.hpp:712

Friends And Related Function Documentation

◆ GetInputTensorInfo

TensorInfo GetInputTensorInfo ( const INetwork network)
friend

◆ Optimize

IOptimizedNetworkPtr Optimize ( const INetwork network,
const std::vector< BackendId > &  backendPreferences,
const IDeviceSpec deviceSpec,
const OptimizerOptions options = OptimizerOptions(),
Optional< std::vector< std::string > &>  messages = EmptyOptional() 
)
friend

Create an optimized version of the network.

Parameters
networkINetwork description of the network to be optimized.
backendPreferencesThe choice of the backend ordered by user preferences.
deviceSpecDeviceSpec object as queried from the runtime. See IRuntime::GetDeviceSpec()
messagesIf there are failures or warnings a string describing same will be added to the vector
optionsOptimizerOptions object with optimizer configuration options
Returns
An IOptimizedNetworkPtr interface to the optimized network, throws an exception derived from armnn::Exception if process fails.

Definition at line 1605 of file Network.cpp.

1610 {
1611  // Enable profiling
1612  auto profiler = inNetwork.pNetworkImpl->GetGraph().GetProfiler();
1614  profiler->EnableProfiling(options.m_ProfilingEnabled);
1615 
1617  if (backendPreferences.empty())
1618  {
1619  throw InvalidArgumentException("Invoked Optimize with no backends specified");
1620  }
1621 
1622  if (options.m_ReduceFp32ToFp16 && options.m_ReduceFp32ToBf16)
1623  {
1624  throw InvalidArgumentException("BFloat16 and Float16 optimization cannot be enabled at the same time.");
1625  }
1626 
1627  // Ensure TensorInfo is set on all output slots of ConstantLayers in the graph
1628  inNetwork.pNetworkImpl->GetGraph().VerifyConstantLayerSetTensorInfo();
1629 
1630  std::unique_ptr<Graph> graph = std::make_unique<Graph>(inNetwork.pNetworkImpl->GetGraph());
1631 
1632  auto optNet = IOptimizedNetworkPtr(new IOptimizedNetwork(std::move(graph), options.m_ModelOptions),
1634 
1635  IOptimizedNetwork* optNetObjPtr = optNet.get();
1636 
1637  // Get the optimized graph
1638  Graph& optGraph = optNetObjPtr->pOptimizedNetworkImpl->GetGraph();
1639 
1640  if(options.m_shapeInferenceMethod == ShapeInferenceMethod::InferAndValidate)
1641  {
1642  // Infer the tensor infos for all output slots. Throws an exception on failure
1643  optGraph.InferTensorInfos();
1644  }
1645 
1646  // Perform AddBroadcastReshapeLayer optimisation
1647  using namespace optimizations;
1649 
1650  if(options.m_shapeInferenceMethod == ShapeInferenceMethod::ValidateOnly)
1651  {
1652  // Validate the tensor infos for all output slots. Throws an exception on failure
1653  optGraph.InferTensorInfos();
1654  }
1655 
1656  // Perform optimisation passes
1662  MovePermuteUp(),
1663  MoveTransposeUp(),
1664  PermuteAsReshape(),
1677 
1678  // If Fp32 to Fp16 optimization is set convert Fp32 network to Fp16
1679  if (options.m_ReduceFp32ToFp16)
1680  {
1681  ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "Optimizer_ReduceFp32ToFp16");
1684  }
1685 
1686  // If Fp32 to Bf16 optimization is set convert Fp32 network to Bf16
1687  // Convert input of Convolution2d and FullyConnected from Fp32 to Bf16
1688  // Only Constant weight of Convolution2d and FullyConnected are converted from Fp32 to Bf16
1689  if (options.m_ReduceFp32ToBf16)
1690  {
1691  ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "Optimizer_ReduceFp32ToBf16");
1693  }
1694 
1695  // Initialize backend settings
1696  BackendSettings backendSettings(backendPreferences, deviceSpec);
1697  if (backendSettings.GetAvailablePreferredBackends().empty())
1698  {
1699  std::stringstream failureMsg;
1700  failureMsg << "None of the preferred backends " << backendPreferences
1701  << " are supported. Current platform provides " << backendSettings.m_SupportedBackends;
1702  ReportError(failureMsg.str(), messages);
1703  throw InvalidArgumentException(failureMsg.str());
1704  }
1705 
1706  // Create a map to temporarily hold initialized backend objects
1707  TensorHandleFactoryRegistry tensorHandleFactoryRegistry;
1708  BackendsMap backends = CreateSupportedBackends(tensorHandleFactoryRegistry, backendSettings);
1709 
1710  // Assign an available backend to each layer
1711  Graph::Iterator firstLayer = optGraph.begin();
1712  Graph::Iterator lastLayer = optGraph.end();
1713  OptimizationResult assignBackendsResult = AssignBackends(optNetObjPtr->pOptimizedNetworkImpl.get(),
1714  backendSettings,
1715  firstLayer,
1716  lastLayer,
1717  messages);
1718  if (assignBackendsResult.m_Error)
1719  {
1720  // Failed to assign a backend to each layer
1721  throw InvalidArgumentException("Failed to assign a backend to each layer");
1722  }
1723 
1726 
1727  // Apply the backend-specific optimizations
1728  OptimizationResult backendOptimizationResult = ApplyBackendOptimizations(optNetObjPtr->pOptimizedNetworkImpl.get(),
1729  backendSettings,
1730  backends,
1731  options.m_ModelOptions,
1732  messages);
1733  if (backendOptimizationResult.m_Error)
1734  {
1735  // Failed to apply the backend-specific optimizations
1736  throw InvalidArgumentException("Failed to apply the backend-specific optimizations");
1737  }
1738 
1739  // If the debug flag is set, then insert a DebugLayer after each layer
1740  // Doing this after applying the backend optimizations as they might have changed some layers
1741  if (options.m_Debug)
1742  {
1744  }
1745 
1746  // Calculate the compatibility strategies for tensor handles
1747  OptimizationResult strategyResult = SelectTensorHandleStrategy(optGraph,
1748  backends,
1749  tensorHandleFactoryRegistry,
1750  options.m_ImportEnabled,
1751  messages);
1752  if (strategyResult.m_Error)
1753  {
1754  // Failed to apply the backend-specific optimizations
1756  }
1757 
1758  // Based on the tensor handle strategy determined above, insert copy layers where required.
1759  {
1760  ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "Optimizer_AddCompatibilityLayers");
1761  optGraph.AddCompatibilityLayers(backends, tensorHandleFactoryRegistry);
1762  }
1763 
1764  // Convert constants
1765  {
1766  ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "Optimizer_ConvertConstants");
1769  }
1770  return optNet;
1771 }
OptimizeForConnection< Layer, PermuteLayer, SquashEqualSiblingsImpl< PermuteLayer > > SquashEqualPermuteSiblings
void ReportError(const std::string &errorMessage, Optional< std::vector< std::string > &> errorMessages)
Definition: Network.cpp:558
OptimizationResult AssignBackends(OptimizedNetworkImpl *optNetObjPtr, BackendSettings &backendSettings, Graph::Iterator &firstLayer, Graph::Iterator &lastLayer, Optional< std::vector< std::string > &> errMessages)
Definition: Network.cpp:906
OptimizeForConnection< PermuteLayer, PermuteLayer, OptimizeInversePermutesImpl< PermuteLayer > > OptimizeInversePermutes
OptimizeForExclusiveConnection< PadLayer, Convolution2dLayer, pad_fold::FoldPadIntoConvolution2dImpl > FoldPadIntoConvolution2d
Optimizer::Optimizations MakeOptimizations(Args &&... args)
Definition: Optimizer.hpp:43
OptimizeForConnection< TransposeLayer, TransposeLayer, OptimizeInversePermutesImpl< TransposeLayer > > OptimizeInverseTransposes
OptimizeForExclusiveConnection< PadLayer, DepthwiseConvolution2dLayer, pad_fold::FoldPadIntoDepthwiseConvolution2dImpl > FoldPadIntoDepthwiseConvolution2d
static ProfilerManager & GetInstance()
Definition: Profiling.cpp:568
OptimizeForConnection< TransposeLayer, BatchToSpaceNdLayer, PermuteAndBatchToSpaceAsDepthToSpaceImpl< TransposeLayer > > TransposeAndBatchToSpaceAsDepthToSpace
OptimizeForExclusiveConnection< DepthwiseConvolution2dLayer, BatchNormalizationLayer, FuseBatchNorm< DepthwiseConvolution2dLayer, armnn::DataType::Float32 > > FuseBatchNormIntoDepthwiseConvolution2DFloat32
static void Pass(Graph &graph, const Optimizations &optimizations)
Definition: Optimizer.cpp:16
OptimizeForExclusiveConnection< DepthwiseConvolution2dLayer, BatchNormalizationLayer, FuseBatchNorm< DepthwiseConvolution2dLayer, armnn::DataType::Float16 > > FuseBatchNormIntoDepthwiseConvolution2DFloat16
OptimizeForExclusiveConnection< Convolution2dLayer, BatchNormalizationLayer, FuseBatchNorm< Convolution2dLayer, armnn::DataType::Float16 > > FuseBatchNormIntoConvolution2DFloat16
OptimizeForExclusiveConnection< Convolution2dLayer, BatchNormalizationLayer, FuseBatchNorm< Convolution2dLayer, armnn::DataType::Float32 > > FuseBatchNormIntoConvolution2DFloat32
OptimizeForConnection< Layer, ReshapeLayer, SquashEqualSiblingsImpl< ReshapeLayer > > SquashEqualReshapeSiblings
OptimizeForConnection< Layer, TransposeLayer, MoveTransposeUpImpl > MoveTransposeUp
LayerList::const_iterator Iterator
Definition: Graph.hpp:51
OptimizeForType< Layer, AddDebugImpl > InsertDebugLayer
Definition: AddDebug.hpp:34
OptimizeForConnection< ReshapeLayer, ReshapeLayer, OptimizeConsecutiveReshapesImpl > OptimizeConsecutiveReshapes
#define ARMNN_SCOPED_PROFILING_EVENT(backendId, name)
Definition: Profiling.hpp:220
OptimizeForConnection< ConvertFp16ToFp32Layer, ConvertFp32ToFp16Layer, OptimizeInverseConversionsImpl > OptimizeInverseConversionsFp16
OptimizeForConnection< PermuteLayer, BatchToSpaceNdLayer, PermuteAndBatchToSpaceAsDepthToSpaceImpl< PermuteLayer > > PermuteAndBatchToSpaceAsDepthToSpace
OptimizeForConnection< Layer, PermuteLayer, MovePermuteUpImpl > MovePermuteUp
ConvertConstants< Float32ToFloat16, IsFloat16Layer > ConvertConstantsFloatToHalf
OptimizeForType< TransposeLayer, TransposeAsReshapeImpl > TransposeAsReshape
OptimizationResult ApplyBackendOptimizations(OptimizedNetworkImpl *optNetObjPtr, BackendSettings &backendSettings, BackendsMap &backends, const ModelOptions &modelOptions, Optional< std::vector< std::string > &> errMessages)
Definition: Network.cpp:1082
Validate all output shapes.
std::unique_ptr< IOptimizedNetwork, void(*)(IOptimizedNetwork *network)> IOptimizedNetworkPtr
Definition: INetwork.hpp:198
OptimizeForType< PermuteLayer, PermuteAsReshapeImpl > PermuteAsReshape
OptimizeForConnection< Layer, TransposeLayer, SquashEqualSiblingsImpl< TransposeLayer > > SquashEqualTransposeSiblings
void RegisterProfiler(IProfiler *profiler)
Definition: Profiling.cpp:575
ConvertConstants< Float16ToFloat32, IsFloat32Layer > ConvertConstantsHalfToFloat
BackendsMap CreateSupportedBackends(TensorHandleFactoryRegistry &handleFactoryRegistry, BackendSettings &backendSettings)
Definition: Network.cpp:1063
OptimizeForConnection< ConvertFp32ToFp16Layer, ConvertFp16ToFp32Layer, OptimizeInverseConversionsImpl > OptimizeInverseConversionsFp32
OptimizeForExclusiveConnection< PadLayer, Pooling2dLayer, pad_fold::FoldPadIntoPooling2dImpl > FoldPadIntoPooling2d
Infer missing output shapes and validate all output shapes.
OptimizeForType< Layer, ConvertFp32NetworkToFp16Impl > Fp32NetworkToFp16Converter
OptimizationResult SelectTensorHandleStrategy(Graph &optGraph, BackendsMap &backends, TensorHandleFactoryRegistry &registry, bool importEnabled, Optional< std::vector< std::string > &> errMessages)
Definition: Network.cpp:1536
OptimizeForType< Layer, AddBroadcastReshapeLayerImpl > AddBroadcastReshapeLayer
static void Destroy(IOptimizedNetwork *network)
Definition: Network.cpp:502
OptimizeForType< Layer, ConvertFp32NetworkToBf16Impl > Fp32NetworkToBf16Converter
std::map< BackendId, std::unique_ptr< class IBackendInternal > > BackendsMap
Definition: Network.hpp:279
OptimizeForType< FullyConnectedLayer, RedirectMembersToConstantInputsImpl > RedirectMembersToConstantInputs

◆ TestConnectionPreservation

friend class TestConnectionPreservation
friend

Definition at line 702 of file INetwork.hpp.

◆ VisitLayersTopologically

void VisitLayersTopologically ( const INetwork inputNetwork,
IStrategy strategy 
)
friend

Member Data Documentation

◆ pNetworkImpl

std::unique_ptr<NetworkImpl> pNetworkImpl
protected

Definition at line 712 of file INetwork.hpp.

Referenced by INetwork::AddActivationLayer(), INetwork::AddAdditionLayer(), INetwork::AddArgMinMaxLayer(), INetwork::AddBatchNormalizationLayer(), INetwork::AddBatchToSpaceNdLayer(), INetwork::AddCastLayer(), INetwork::AddChannelShuffleLayer(), INetwork::AddComparisonLayer(), INetwork::AddConcatLayer(), INetwork::AddConstantLayer(), INetwork::AddConvolution2dLayer(), INetwork::AddConvolution3dLayer(), INetwork::AddDepthToSpaceLayer(), INetwork::AddDepthwiseConvolution2dLayer(), INetwork::AddDequantizeLayer(), INetwork::AddDetectionPostProcessLayer(), INetwork::AddDivisionLayer(), INetwork::AddElementwiseUnaryLayer(), INetwork::AddFillLayer(), INetwork::AddFloorLayer(), INetwork::AddFullyConnectedLayer(), INetwork::AddGatherLayer(), INetwork::AddInputLayer(), INetwork::AddInstanceNormalizationLayer(), INetwork::AddL2NormalizationLayer(), INetwork::AddLogicalBinaryLayer(), INetwork::AddLogSoftmaxLayer(), INetwork::AddLstmLayer(), INetwork::AddMaximumLayer(), INetwork::AddMeanLayer(), INetwork::AddMergeLayer(), INetwork::AddMinimumLayer(), INetwork::AddMultiplicationLayer(), INetwork::AddNormalizationLayer(), INetwork::AddOutputLayer(), INetwork::AddPadLayer(), INetwork::AddPermuteLayer(), INetwork::AddPooling2dLayer(), INetwork::AddPreluLayer(), INetwork::AddQLstmLayer(), INetwork::AddQuantizedLstmLayer(), INetwork::AddQuantizeLayer(), INetwork::AddRankLayer(), INetwork::AddReduceLayer(), INetwork::AddReshapeLayer(), INetwork::AddResizeLayer(), INetwork::AddShapeLayer(), INetwork::AddSliceLayer(), INetwork::AddSoftmaxLayer(), INetwork::AddSpaceToBatchNdLayer(), INetwork::AddSpaceToDepthLayer(), INetwork::AddSplitterLayer(), INetwork::AddStackLayer(), INetwork::AddStandInLayer(), INetwork::AddStridedSliceLayer(), INetwork::AddSubtractionLayer(), INetwork::AddSwitchLayer(), INetwork::AddTransposeConvolution2dLayer(), INetwork::AddTransposeLayer(), INetwork::AddUnidirectionalSequenceLstmLayer(), INetwork::ExecuteStrategy(), armnn::Optimize(), and INetwork::PrintGraph().


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