diff options
Diffstat (limited to 'include/armnn/INetwork.hpp')
| -rw-r--r-- | include/armnn/INetwork.hpp | 217 |
1 files changed, 125 insertions, 92 deletions
diff --git a/include/armnn/INetwork.hpp b/include/armnn/INetwork.hpp index 5cff810db5..cefcbfb06c 100644 --- a/include/armnn/INetwork.hpp +++ b/include/armnn/INetwork.hpp @@ -11,6 +11,7 @@ #include "armnn/Types.hpp" #include <memory> +#include <vector> namespace armnn { @@ -25,7 +26,8 @@ public: virtual IOutputSlot* GetConnection() = 0; protected: - ~IInputSlot() {} /// Not user deletable + /// Not user deletable. + ~IInputSlot() {} }; /// @brief An output connection slot for a layer. @@ -45,7 +47,8 @@ public: virtual void Disconnect(IInputSlot& slot) = 0; protected: - ~IOutputSlot() {} /// Not user deletable + /// Not user deletable. + ~IOutputSlot() {} }; /// @brief Interface for a layer that is connectable to other layers via InputSlots and OutputSlots. @@ -63,9 +66,12 @@ public: virtual const IOutputSlot& GetOutputSlot(unsigned int index) const = 0; virtual IOutputSlot& GetOutputSlot(unsigned int index) = 0; + virtual std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const = 0; + virtual LayerGuid GetGuid() const = 0; protected: - ~IConnectableLayer() {} // Objects are not deletable via the handle + /// Objects are not deletable via the handle + ~IConnectableLayer() {} }; using INetworkPtr = std::unique_ptr<INetwork, void(*)(INetwork* network)>; @@ -81,19 +87,19 @@ public: virtual Status PrintGraph() = 0; - /// Add an input layer to the network. - /// @param id User generated id to uniquely identify a particular input. The same id needs to be specified + /// Adds an input layer to the network. + /// @param 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. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddInputLayer(LayerBindingId id, const char* name = nullptr) = 0; - /// Add a 2D convolution layer to the network. - /// @param convolution2dDescriptor Description of the 2D convolution layer - /// @param weights Tensor for the weights data. - /// @param biases (Optional) Tensor for the bias data. Must match the output tensor shape. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a 2D convolution layer to the network. + /// @param convolution2dDescriptor - Description of the 2D convolution layer. + /// @param weights - Tensor for the weights data. + /// @param biases - (Optional) Tensor for the bias data. Must match the output tensor shape. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddConvolution2dLayer(const Convolution2dDescriptor& convolution2dDescriptor, const ConstTensor& weights, const char* name = nullptr) = 0; @@ -103,12 +109,12 @@ public: const ConstTensor& biases, const char* name = nullptr) = 0; - /// Add a 2D depthwise convolution layer to the network. - /// @param convolution2dDescriptor Description of the 2D depthwise convolution layer - /// @param weights Tensor for the weights data. Expected format: [1, outputChannels, height, width] - /// @param biases (Optional) Tensor for the bias data. Must match the output tensor shape. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a 2D depthwise convolution layer to the network. + /// @param convolution2dDescriptor - Description of the 2D depthwise convolution layer. + /// @param weights - Tensor for the weights data. Expected format: [1, outputChannels, height, width]. + /// @param biases (Optional) - Tensor for the bias data. Must match the output tensor shape. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddDepthwiseConvolution2dLayer( const DepthwiseConvolution2dDescriptor& convolution2dDescriptor, const ConstTensor& weights, @@ -120,12 +126,12 @@ public: const ConstTensor& biases, const char* name = nullptr) = 0; - /// Add a fully connected layer to the network. - /// @param fullyConnectedDescriptor Description of the fully connected layer - /// @param weights Tensor for the weights data. - /// @param biases (Optional) Tensor for the bias data. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a fully connected layer to the network. + /// @param fullyConnectedDescriptor - Description of the fully connected layer. + /// @param weights - Tensor for the weights data. + /// @param biases - (Optional) Tensor for the bias data. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddFullyConnectedLayer(const FullyConnectedDescriptor& fullyConnectedDescriptor, const ConstTensor& weights, const char* name = nullptr) = 0; @@ -135,76 +141,77 @@ public: const ConstTensor& biases, const char* name = nullptr) = 0; - /// Add a permute layer to the network. - /// @param permuteDescriptor PermuteDescriptor to configure the permute - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a permute layer to the network. + /// @param permuteDescriptor - PermuteDescriptor to configure the permute. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddPermuteLayer(const PermuteDescriptor& permuteDescriptor, const char* name = nullptr) = 0; - /// Add a pooling layer to the network. - /// @param pooling2dDescriptor Pooling2dDescriptor to configure the pooling - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a pooling layer to the network. + /// @param pooling2dDescriptor - Pooling2dDescriptor to configure the pooling. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddPooling2dLayer(const Pooling2dDescriptor& pooling2dDescriptor, const char* name = nullptr) = 0; - /// Add an activation layer to the network. - /// @param activationDescriptor ActivationDescriptor to configure the activation - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds an activation layer to the network. + /// @param activationDescriptor - ActivationDescriptor to configure the activation. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddActivationLayer(const ActivationDescriptor& activationDescriptor, const char* name = nullptr) = 0; - /// Add a normalization layer to the network. - /// @param normalizationDescriptor NormalizationDescriptor to configure the normalization - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a normalization layer to the network. + /// @param normalizationDescriptor - NormalizationDescriptor to configure the normalization. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddNormalizationLayer(const NormalizationDescriptor& normalizationDescriptor, const char* name = nullptr) = 0; - /// Add a softmax layer to the network. - /// @param softmaxDescriptor SoftmaxDescriptor to configure the softmax - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a softmax layer to the network. + /// @param softmaxDescriptor - SoftmaxDescriptor to configure the softmax. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddSoftmaxLayer(const SoftmaxDescriptor& softmaxDescriptor, const char* name = nullptr) = 0; - /// Add a splitter layer to the network. - /// @param splitterDescriptor WindowsDescriptor 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.... - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a splitter layer to the network. + /// @param splitterDescriptor - WindowsDescriptor 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.... + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddSplitterLayer(const ViewsDescriptor& splitterDescriptor , const char* name = nullptr) = 0; - /// Add a merger layer to the network. - /// @param mergerDescriptor WindowsDescriptor to configure the merging process. Number of Views must be equal to + /// Adds a merger layer to the network. + /// @param mergerDescriptor - WindowsDescriptor to configure the merging 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.... - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddMergerLayer(const OriginsDescriptor& mergerDescriptor, const char* name = nullptr) = 0; - /// Add an addition layer to the network. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds an addition layer to the network. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddAdditionLayer(const char* name = nullptr) = 0; - /// Add a multiplication layer to the network. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a multiplication layer to the network. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddMultiplicationLayer(const char* name = nullptr) = 0; - /// Add a batch normalization layer to the network. - /// @param mean Pre-calculated mean for each channel - /// @param variance Pre-calculated variance for each channel - /// @param beta Per-channel additive factor - /// @param gamma Per-channel multiplicative factor - /// @return Interface for configuring the layer. - /// @param name Optional name for the layer + /// Adds a batch normalization layer to the network. + /// @param mean - Pre-calculated mean for each channel. + /// @param variance - Pre-calculated variance for each channel. + /// @param beta - Per-channel additive factor. + /// @param gamma - Per-channel multiplicative factor. + /// @return - Interface for configuring the layer. + /// @param name - Optional name for the layer. virtual IConnectableLayer* AddBatchNormalizationLayer(const BatchNormalizationDescriptor& desc, const ConstTensor& mean, const ConstTensor& variance, @@ -212,47 +219,55 @@ public: const ConstTensor& gamma, const char* name = nullptr) = 0; - /// Add a resize bilinear layer to the network. - /// @param resizeDesc Parameters for the resize operation - /// @param name Optional name for the layer - /// @return Interface for configuring the layer + /// Adds a resize bilinear layer to the network. + /// @param resizeDesc - Parameters for the resize operation. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddResizeBilinearLayer(const ResizeBilinearDescriptor& resizeDesc, const char* name = nullptr) = 0; - /// Add an L2 normalization layer to the network. + /// Adds an L2 normalization layer to the network. /// Normalization is performed along dimension 1, but requires a 4d input. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddL2NormalizationLayer(const char* name = nullptr) = 0; /// Adds a layer with no inputs and a single output, which always corresponds to /// the passed in constant tensor. - /// @param 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 @a input can be freed or reused after this function is - /// called. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer + /// @param 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 @a input can + /// be freed or reused after this function is called. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddConstantLayer(const ConstTensor& input, const char* name = nullptr) = 0; - /// Add a reshape layer to the network. - /// @param reshapeDescriptor Parameters for the reshape operation - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a reshape layer to the network. + /// @param reshapeDescriptor - Parameters for the reshape operation. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddReshapeLayer(const ReshapeDescriptor& reshapeDescriptor, const char* name = nullptr) = 0; - /// Add a floor layer to the network. - /// @param name Optional name for the layer - /// @return Interface for configuring the layer. + /// Adds a floor layer to the network. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. virtual IConnectableLayer* AddFloorLayer(const char* name = nullptr) = 0; - /// Add an output layer to the network. - /// @param id User generated id to uniquely identify a particular output. The same id needs to be specified + /// Adds an output layer to the network. + /// @param 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. + /// @param name - Optional name for the layer. + /// @return - Interface for configuring the layer. + virtual IConnectableLayer* AddOutputLayer(LayerBindingId id, const char* name = nullptr) = 0; + + /// Add a Lstm layer to the network + /// @param descriptor Parameters for the Lstm operation /// @param name Optional name for the layer /// @return Interface for configuring the layer. - virtual IConnectableLayer* AddOutputLayer(LayerBindingId id, const char* name = nullptr) = 0; + virtual IConnectableLayer* AddLstmLayer(const LstmDescriptor& descriptor, + const LstmInputParams& params, + const char* name = nullptr) = 0; protected: ~INetwork() {} @@ -268,16 +283,34 @@ public: virtual Status PrintGraph() = 0; virtual Status SerializeToDot(std::ostream& stream) const = 0; + protected: ~IOptimizedNetwork() {} }; +struct OptimizerOptions +{ + OptimizerOptions() : m_ReduceFp32ToFp16(false) {} + + OptimizerOptions(bool reduceFp32ToFp16) + : m_ReduceFp32ToFp16(reduceFp32ToFp16) + { + } + + // Reduce Fp32 data to Fp16 for faster processing + bool m_ReduceFp32ToFp16; +}; /// Create an optimized version of the network /// @param network INetwork description of the network to be optimized. -/// @param deviceSpec The choice of the default computation backend. +/// @param backendPreferences The choice of the backend ordered by user preferences. +/// @param deviceSpec DeviceSpec object as queried from the runtime. See IRuntime::GetDeviceSpec() +/// @param options OptimizerOptions object with optimizer configuration options /// @return An IOptimizedNetworkPtr interface to the optimized network, throws an exception derived from /// armnn::Exception if process fails. -IOptimizedNetworkPtr Optimize(const INetwork& network, const DeviceSpec& deviceSpec); +IOptimizedNetworkPtr Optimize(const INetwork& network, + const std::vector<armnn::Compute>& backendPreferences, + const IDeviceSpec& deviceSpec, + const OptimizerOptions& options = OptimizerOptions()); } //namespace armnn |