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/L2NormalizationLayer.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/L2NormalizationLayer.hpp')
-rw-r--r-- | src/armnn/layers/L2NormalizationLayer.hpp | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/src/armnn/layers/L2NormalizationLayer.hpp b/src/armnn/layers/L2NormalizationLayer.hpp index bf4d49e7c8..bae3d820ba 100644 --- a/src/armnn/layers/L2NormalizationLayer.hpp +++ b/src/armnn/layers/L2NormalizationLayer.hpp @@ -9,18 +9,32 @@ namespace armnn { +/// This layer represents a L2 normalization operation. class L2NormalizationLayer : public LayerWithParameters<L2NormalizationDescriptor> { public: + /// Makes a workload for the L2Normalization 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. L2NormalizationLayer* Clone(Graph& graph) const override; + /// Check if the input tensor shape(s) + /// will lead to a valid configuration of @ref L2NormalizationLayer. void ValidateTensorShapesFromInputs() override; protected: + /// Constructor to create a L2NormalizationLayer. + /// @param [in] param L2NormalizationDescriptor to configure the L2 normalization operation. + /// @param [in] name Optional name for the layer. L2NormalizationLayer(const L2NormalizationDescriptor& param, const char* name); + + /// Default destructor ~L2NormalizationLayer() = default; }; |