From ae050524109f1ce827962665436ef7430f2ac479 Mon Sep 17 00:00:00 2001 From: David Monahan Date: Wed, 22 Mar 2023 16:48:58 +0000 Subject: IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub. * Updating Doxygen documentation for 23.02 release. Signed-off-by: David Monahan Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82 --- 23.02/_constant_layer_8hpp_source.xhtml | 118 ++++++++++++++++++++++++-------- 1 file changed, 90 insertions(+), 28 deletions(-) (limited to '23.02/_constant_layer_8hpp_source.xhtml') diff --git a/23.02/_constant_layer_8hpp_source.xhtml b/23.02/_constant_layer_8hpp_source.xhtml index dcee18e9a1..3ae6edda46 100644 --- a/23.02/_constant_layer_8hpp_source.xhtml +++ b/23.02/_constant_layer_8hpp_source.xhtml @@ -8,7 +8,7 @@ - + ArmNN: src/armnn/layers/ConstantLayer.hpp Source File @@ -19,9 +19,6 @@ - @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); - + + @@ -51,18 +49,21 @@ - + +/* @license-end */
@@ -76,7 +77,9 @@ $(function() {
@@ -98,33 +101,92 @@ $(document).ready(function(){initNavTree('_constant_layer_8hpp_source.xhtml','')
ConstantLayer.hpp
-Go to the documentation of this file.
1 //
2 // Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
7 #include <Layer.hpp>
8 
9 namespace armnn
10 {
11 
12 class ScopedTensorHandle;
13 
14 /// A layer that the constant data can be bound to.
15 class ConstantLayer : public Layer
16 {
17 public:
18  /// Makes a workload for the Constant type.
19  /// @param [in] graph The graph where this layer can be found.
20  /// @param [in] factory The workload factory which will create the workload.
21  /// @return A pointer to the created workload, or nullptr if not created.
22  virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
23 
24  /// Creates a dynamically-allocated copy of this layer.
25  /// @param [in] graph The graph into which this layer is being cloned.
26  ConstantLayer* Clone(Graph& graph) const override;
27 
28  /// Check if the input tensor shape(s)
29  /// will lead to a valid configuration of @ref ConstantLayer
30  /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
31  void ValidateTensorShapesFromInputs() override;
32 
33  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
34  /// otherwise infers the output shapes from given input shapes and layer properties.
35  /// @param [in] inputShapes The input shapes layer has.
36  /// @return a vector to the inferred output shape.
37  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
38 
39  /// Free up the constant source data stored by the layer.
40  void ReleaseConstantData() override {}
41 
42  void ExecuteStrategy(IStrategy& strategy) const override;
43 
44  std::shared_ptr<ConstTensorHandle> m_LayerOutput;
45 
46 protected:
47  /// Constructor to create a ConstantLayer.
48  /// @param [in] name Optional name for the layer.
49  ConstantLayer(const char* name);
50 
51  /// Default destructor
52  ~ConstantLayer() = default;
53 
54  /// Retrieve the handles to the constant values stored by the layer.
55  // For API stability DO NOT ALTER order and add new members to the end of vector
56  ConstantTensors GetConstantTensorsByRef() override { return {m_LayerOutput}; }
57 };
58 
59 } // namespace
A layer that the constant data can be bound to.
-
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Constant type.
- -
std::shared_ptr< ConstTensorHandle > m_LayerOutput
-
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of ConstantLayer.
-
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
-
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const 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.
-
Copyright (c) 2021 ARM Limited and Contributors.
- -
~ConstantLayer()=default
Default destructor.
-
std::vector< std::reference_wrapper< std::shared_ptr< ConstTensorHandle > >> ConstantTensors
Definition: INetwork.hpp:124
-
ConstantLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
- - -
void ReleaseConstantData() override
Free up the constant source data stored by the layer.
-
ConstantTensors GetConstantTensorsByRef() override
Retrieve the handles to the constant values stored by the layer.
-
ConstantLayer(const char *name)
Constructor to create a ConstantLayer.
- +Go to the documentation of this file.
1 //
+
2 // Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
+
3 // SPDX-License-Identifier: MIT
+
4 //
+
5 #pragma once
+
6 
+
7 #include <Layer.hpp>
+
8 
+
9 namespace armnn
+
10 {
+
11 
+
12 class ScopedTensorHandle;
+
13 
+
14 /// A layer that the constant data can be bound to.
+
15 class ConstantLayer : public Layer
+
16 {
+
17 public:
+
18  /// Makes a workload for the Constant type.
+
19  /// @param [in] graph The graph where this layer can be found.
+
20  /// @param [in] factory The workload factory which will create the workload.
+
21  /// @return A pointer to the created workload, or nullptr if not created.
+
22  virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
+
23 
+
24  /// Creates a dynamically-allocated copy of this layer.
+
25  /// @param [in] graph The graph into which this layer is being cloned.
+
26  ConstantLayer* Clone(Graph& graph) const override;
+
27 
+
28  /// Check if the input tensor shape(s)
+
29  /// will lead to a valid configuration of @ref ConstantLayer
+
30  /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
+
31  void ValidateTensorShapesFromInputs() override;
+
32 
+
33  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
+
34  /// otherwise infers the output shapes from given input shapes and layer properties.
+
35  /// @param [in] inputShapes The input shapes layer has.
+
36  /// @return a vector to the inferred output shape.
+
37  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
+
38 
+
39  /// Free up the constant source data stored by the layer.
+
40  void ReleaseConstantData() override {}
+
41 
+
42  void ExecuteStrategy(IStrategy& strategy) const override;
+
43 
+
44  std::shared_ptr<ConstTensorHandle> m_LayerOutput;
+
45 
+
46 protected:
+
47  /// Constructor to create a ConstantLayer.
+
48  /// @param [in] name Optional name for the layer.
+
49  ConstantLayer(const char* name);
+
50 
+
51  /// Default destructor
+
52  ~ConstantLayer() = default;
+
53 
+
54  /// Retrieve the handles to the constant values stored by the layer.
+
55  // For API stability DO NOT ALTER order and add new members to the end of vector
+ +
57 };
+
58 
+
59 } // namespace
+
void ReleaseConstantData() override
Free up the constant source data stored by the layer.
+
ConstantTensors GetConstantTensorsByRef() override
Retrieve the handles to the constant values stored by the layer.
+
A layer that the constant data can be bound to.
+
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Constant type.
+
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
By default returns inputShapes if the number of inputs are equal to number of outputs,...
+ +
std::vector< std::reference_wrapper< std::shared_ptr< ConstTensorHandle > >> ConstantTensors
Definition: INetwork.hpp:124
+ +
ConstantLayer(const char *name)
Constructor to create a ConstantLayer.
+
Copyright (c) 2021 ARM Limited and Contributors.
+ +
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
+
ConstantLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
+
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of ConstantLayer.
+ +
std::shared_ptr< ConstTensorHandle > m_LayerOutput
+ +
~ConstantLayer()=default
Default destructor.
-- cgit v1.2.1