Release 18.02

Change-Id: Id3c11dc5ee94ef664374a988fcc6901e9a232fa6

1 files changed, 281 insertions, 0 deletions

diff --git a/include/armnn/INetwork.hpp b/include/armnn/INetwork.hpp
new file mode 100644
index 0000000000..8545629c96
--- /dev/null
+++ b/include/armnn/INetwork.hpp
@@ -0,0 +1,281 @@
+//
+// Copyright © 2017 Arm Ltd. All rights reserved.
+// See LICENSE file in the project root for full license information.
+//
+#pragma once
+
+#include "armnn/NetworkFwd.hpp"
+#include "armnn/DescriptorsFwd.hpp"
+#include "armnn/TensorFwd.hpp"
+
+#include "armnn/Types.hpp"
+
+#include <memory>
+
+namespace armnn
+{
+
+/// @brief An input connection slot for a layer.
+/// The input slot can be connected to an output slot of the preceding layer in the graph.
+/// Only one connection to the input slot is allowed.
+class IInputSlot
+{
+public:
+    virtual const IOutputSlot* GetConnection() const = 0;
+    virtual IOutputSlot* GetConnection() = 0;
+
+protected:
+    ~IInputSlot() {} /// Not user deletable
+};
+
+/// @brief An output connection slot for a layer.
+/// The output slot may be connected to 1 or more input slots of subsequent layers in the graph.
+class IOutputSlot
+{
+public:
+    virtual unsigned int GetNumConnections() const = 0;
+    virtual const IInputSlot* GetConnection(unsigned int index) const = 0;
+    virtual IInputSlot* GetConnection(unsigned int index) = 0;
+
+    virtual void SetTensorInfo(const TensorInfo& tensorInfo) = 0;
+    virtual const TensorInfo& GetTensorInfo() const = 0;
+    virtual bool IsTensorInfoSet() const = 0;
+
+    virtual int Connect(IInputSlot& destination) = 0;
+    virtual void Disconnect(IInputSlot& slot) = 0;
+
+protected:
+    ~IOutputSlot() {} /// Not user deletable
+};
+
+/// @brief Interface for a layer that is connectable to other layers via InputSlots and OutputSlots.
+class IConnectableLayer
+{
+public:
+    virtual const char* GetName() const = 0;
+
+    virtual unsigned int GetNumInputSlots() const = 0;
+    virtual unsigned int GetNumOutputSlots() const = 0;
+
+    virtual const IInputSlot& GetInputSlot(unsigned int index) const = 0;
+    virtual IInputSlot& GetInputSlot(unsigned int index) = 0;
+
+    virtual const IOutputSlot& GetOutputSlot(unsigned int index) const = 0;
+    virtual IOutputSlot& GetOutputSlot(unsigned int index) = 0;
+
+protected:
+    ~IConnectableLayer() {} // Objects are not deletable via the handle
+};
+
+using INetworkPtr = std::unique_ptr<INetwork, void(*)(INetwork* network)>;
+
+/// Main network class which provides the interface for building up a neural network.
+/// This object is subsequently required by the IRuntime::Load() method.
+class INetwork
+{
+public:
+    static INetwork* CreateRaw();
+    static INetworkPtr Create();
+    static void Destroy(INetwork* network);
+
+    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
+    /// when passing the inputs to the IRuntime::EnqueueWorkload() function.
+    /// @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.
+    virtual IConnectableLayer* AddConvolution2dLayer(const Convolution2dDescriptor& convolution2dDescriptor,
+        const ConstTensor& weights,
+        const char* name = nullptr) = 0;
+
+    virtual IConnectableLayer* AddConvolution2dLayer(const Convolution2dDescriptor& convolution2dDescriptor,
+        const ConstTensor& weights,
+        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.
+    virtual IConnectableLayer* AddDepthwiseConvolution2dLayer(
+        const DepthwiseConvolution2dDescriptor& convolution2dDescriptor,
+        const ConstTensor& weights,
+        const char* name = nullptr) = 0;
+
+    virtual IConnectableLayer* AddDepthwiseConvolution2dLayer(
+        const DepthwiseConvolution2dDescriptor& convolution2dDescriptor,
+        const ConstTensor& weights,
+        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.
+    virtual IConnectableLayer* AddFullyConnectedLayer(const FullyConnectedDescriptor& fullyConnectedDescriptor,
+        const ConstTensor& weights,
+        const char* name = nullptr) = 0;
+
+    virtual IConnectableLayer* AddFullyConnectedLayer(const FullyConnectedDescriptor& fullyConnectedDescriptor,
+        const ConstTensor& weights,
+        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.
+    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.
+    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.
+    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.
+    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.
+    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.
+    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
+    ///                           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.
+    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.
+    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.
+    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
+    virtual IConnectableLayer* AddBatchNormalizationLayer(const BatchNormalizationDescriptor& desc,
+        const ConstTensor& mean,
+        const ConstTensor& variance,
+        const ConstTensor& beta,
+        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
+    virtual IConnectableLayer* AddResizeBilinearLayer(const ResizeBilinearDescriptor& resizeDesc,
+                                                      const char* name = nullptr) = 0;
+
+    /// Add 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
+    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
+    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.
+    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.
+    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
+    /// 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;
+
+protected:
+    ~INetwork() {}
+};
+
+using IOptimizedNetworkPtr = std::unique_ptr<IOptimizedNetwork, void(*)(IOptimizedNetwork* network)>;
+
+class IOptimizedNetwork
+{
+public:
+    static void Destroy(IOptimizedNetwork* network);
+
+    virtual Status PrintGraph() = 0;
+
+protected:
+    ~IOptimizedNetwork() {}
+};
+
+
+/// 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.
+/// @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);
+
+} //namespace armnn