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/_reduce_layer_8hpp_source.xhtml | 102 +++++++++++++++++++++++++--------- 1 file changed, 77 insertions(+), 25 deletions(-) (limited to '23.02/_reduce_layer_8hpp_source.xhtml') diff --git a/23.02/_reduce_layer_8hpp_source.xhtml b/23.02/_reduce_layer_8hpp_source.xhtml index 9d2fe1a4dc..63da343414 100644 --- a/23.02/_reduce_layer_8hpp_source.xhtml +++ b/23.02/_reduce_layer_8hpp_source.xhtml @@ -8,7 +8,7 @@ - + ArmNN: src/armnn/layers/ReduceLayer.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,30 +101,79 @@ $(document).ready(function(){initNavTree('_reduce_layer_8hpp_source.xhtml','');}
ReduceLayer.hpp
-Go to the documentation of this file.
1 //
2 // Copyright © 2020 Samsung Electronics Co Ltd and Contributors. All rights reserved.
3 // Copyright © 2023 Arm Ltd and Contributors. All rights reserved.
4 // SPDX-License-Identifier: MIT
5 //
6 #pragma once
7 
9 
10 namespace armnn
11 {
12 
13 /// This layer represents a reduction operation.
14 class ReduceLayer : public LayerWithParameters<ReduceDescriptor>
15 {
16 public:
17  /// Makes a workload for the Reduce type.
18  /// @param [in] graph The graph where this layer can be found.
19  /// @param [in] factory The workload factory which will create the workload.
20  /// @return A pointer to the created workload, or nullptr if not created.
21  virtual std::unique_ptr<IWorkload>CreateWorkload(const IWorkloadFactory& factory) const override;
22 
23  /// Creates a dynamically-allocated copy of this layer.
24  /// @param [in] graph The graph into which this layer is being cloned.
25  ReduceLayer* Clone(Graph& graph) const override;
26 
27  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
28  /// otherwise infers the output shapes from given input shapes and layer properties.
29  /// @param [in] inputShapes The input shapes layer has.
30  /// @return A vector to the inferred output shape.
31  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
32 
33  /// Check if the input tensor shape(s)
34  /// will lead to a valid configuration of @ref ReduceLayer.
35  void ValidateTensorShapesFromInputs() override;
36 
37  void ExecuteStrategy(IStrategy& strategy) const override;
38 
39 protected:
40  /// Constructor to create a ReduceLayer.
41  /// @param [in] param ReduceDescriptor to configure the reduction operation.
42  /// @param [in] name Optional name for the layer.
43  ReduceLayer(const ReduceDescriptor& param, const char* name);
44 
45  /// Default destructor
46  ~ReduceLayer() = default;
47 };
48 
49 } // namespace armnn
~ReduceLayer()=default
Default destructor.
- - -
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of ReduceLayer.
Definition: ReduceLayer.cpp:44
-
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Reduce type.
Definition: ReduceLayer.cpp:23
-
Copyright (c) 2021 ARM Limited and Contributors.
-
This layer represents a reduction operation.
Definition: ReduceLayer.hpp:14
-
ReduceLayer(const ReduceDescriptor &param, const char *name)
Constructor to create a ReduceLayer.
Definition: ReduceLayer.cpp:18
- -
A ReduceDescriptor for the REDUCE operators.
- -
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
- -
ReduceLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: ReduceLayer.cpp:34
-
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.
Definition: ReduceLayer.cpp:62
+Go to the documentation of this file.
1 //
+
2 // Copyright © 2020 Samsung Electronics Co Ltd and Contributors. All rights reserved.
+
3 // Copyright © 2023 Arm Ltd and Contributors. All rights reserved.
+
4 // SPDX-License-Identifier: MIT
+
5 //
+
6 #pragma once
+
7 
+ +
9 
+
10 namespace armnn
+
11 {
+
12 
+
13 /// This layer represents a reduction operation.
+
14 class ReduceLayer : public LayerWithParameters<ReduceDescriptor>
+
15 {
+
16 public:
+
17  /// Makes a workload for the Reduce type.
+
18  /// @param [in] graph The graph where this layer can be found.
+
19  /// @param [in] factory The workload factory which will create the workload.
+
20  /// @return A pointer to the created workload, or nullptr if not created.
+
21  virtual std::unique_ptr<IWorkload>CreateWorkload(const IWorkloadFactory& factory) const override;
+
22 
+
23  /// Creates a dynamically-allocated copy of this layer.
+
24  /// @param [in] graph The graph into which this layer is being cloned.
+
25  ReduceLayer* Clone(Graph& graph) const override;
+
26 
+
27  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
+
28  /// otherwise infers the output shapes from given input shapes and layer properties.
+
29  /// @param [in] inputShapes The input shapes layer has.
+
30  /// @return A vector to the inferred output shape.
+
31  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
+
32 
+
33  /// Check if the input tensor shape(s)
+
34  /// will lead to a valid configuration of @ref ReduceLayer.
+
35  void ValidateTensorShapesFromInputs() override;
+
36 
+
37  void ExecuteStrategy(IStrategy& strategy) const override;
+
38 
+
39 protected:
+
40  /// Constructor to create a ReduceLayer.
+
41  /// @param [in] param ReduceDescriptor to configure the reduction operation.
+
42  /// @param [in] name Optional name for the layer.
+
43  ReduceLayer(const ReduceDescriptor& param, const char* name);
+
44 
+
45  /// Default destructor
+
46  ~ReduceLayer() = default;
+
47 };
+
48 
+
49 } // namespace armnn
+
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of ReduceLayer.
Definition: ReduceLayer.cpp:44
+ +
~ReduceLayer()=default
Default destructor.
+
A ReduceDescriptor for the REDUCE operators.
+
ReduceLayer(const ReduceDescriptor &param, const char *name)
Constructor to create a ReduceLayer.
Definition: ReduceLayer.cpp:18
+ +
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Reduce type.
Definition: ReduceLayer.cpp:23
+ +
Copyright (c) 2021 ARM Limited and Contributors.
+ +
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
+
This layer represents a reduction operation.
Definition: ReduceLayer.hpp:14
+ +
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,...
Definition: ReduceLayer.cpp:62
+
ReduceLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: ReduceLayer.cpp:34
-- cgit v1.2.1