diff options
author | Conor Kennedy <conor.kennedy@arm.com> | 2018-12-21 14:38:36 +0000 |
---|---|---|
committer | Les Bell <les.bell@arm.com> | 2018-12-24 09:33:39 +0000 |
commit | 35052ae3f44d24cd71f437a2011c5032d34c94a7 (patch) | |
tree | 21cdc0f077606f80713f75c6eaeace2adcd4bb20 /src/armnn/layers/ConstantLayer.hpp | |
parent | a06bf31afabfb84e60740ea3219406ab13c8e6a6 (diff) | |
download | armnn-35052ae3f44d24cd71f437a2011c5032d34c94a7.tar.gz |
IVGCVSW-59 Add documentation to the public API
* Add documentation to the Descriptors
* Add documentation to the layers
Change-Id: I5e0849753903565227fd47d329a600fd90b2feb9
Diffstat (limited to 'src/armnn/layers/ConstantLayer.hpp')
-rw-r--r-- | src/armnn/layers/ConstantLayer.hpp | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/src/armnn/layers/ConstantLayer.hpp b/src/armnn/layers/ConstantLayer.hpp index a9c91110da..c3316b78b1 100644 --- a/src/armnn/layers/ConstantLayer.hpp +++ b/src/armnn/layers/ConstantLayer.hpp @@ -11,26 +11,44 @@ namespace armnn class ScopedCpuTensorHandle; +/// A layer that the constant data can be bound to. class ConstantLayer : public Layer { public: + /// Makes a workload for the Constant type. + /// @param [in] graph The graph where this layer can be found. + /// @param [in] factory The workload factory which will create the workload. + /// @return A pointer to the created workload, or nullptr if not created. virtual std::unique_ptr<IWorkload> CreateWorkload(const Graph& graph, - const IWorkloadFactory& factory) const override; + const IWorkloadFactory& factory) const override; + /// Creates a dynamically-allocated copy of this layer. + /// @param [in] graph The graph into which this layer is being cloned. ConstantLayer* Clone(Graph& graph) const override; + /// Check if the input tensor shape(s) + /// will lead to a valid configuration of @ref ConstantLayer void ValidateTensorShapesFromInputs() override; + /// By default returns inputShapes if the number of inputs are equal to number of outputs, + /// otherwise infers the output shapes from given input shapes and layer properties. + /// @param [in] inputShapes The input shapes layer has. + /// @return a vector to the inferred output shape. std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override; - // Free up the constant source data + /// Free up the constant source data stored by the layer. void ReleaseConstantData() override {}; std::unique_ptr<ScopedCpuTensorHandle> m_LayerOutput; protected: + /// Constructor to create a ConstantLayer. + /// @param [in] name Optional name for the layer. ConstantLayer(const char* name); + + /// Default destructor ~ConstantLayer() = default; + /// Retrieve the handles to the constant values stored by the layer. ConstantTensors GetConstantTensorsByRef() override { return {m_LayerOutput}; } }; |