From 8efb48a6847c5cd166c561127ae6611150963ce3 Mon Sep 17 00:00:00 2001 From: Nikhil Raj Date: Fri, 19 May 2023 11:14:28 +0100 Subject: Update Doxygen docu for 23.05 Signed-off-by: Nikhil Raj Change-Id: I0a992286f14fa68fcc6e5eba31ac39fed003cbbe --- 23.05/classarmnn_1_1_arg_min_max_layer.xhtml | 704 +++++++++++++++++++++++++++ 1 file changed, 704 insertions(+) create mode 100644 23.05/classarmnn_1_1_arg_min_max_layer.xhtml (limited to '23.05/classarmnn_1_1_arg_min_max_layer.xhtml') diff --git a/23.05/classarmnn_1_1_arg_min_max_layer.xhtml b/23.05/classarmnn_1_1_arg_min_max_layer.xhtml new file mode 100644 index 0000000000..33d92e383f --- /dev/null +++ b/23.05/classarmnn_1_1_arg_min_max_layer.xhtml @@ -0,0 +1,704 @@ + + + + + + + + + + + + + +ArmNN: ArgMinMaxLayer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  23.05 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
ArgMinMaxLayer Class Reference
+
+
+ +

This layer represents a ArgMinMax operation. + More...

+ +

#include <ArgMinMaxLayer.hpp>

+
+Inheritance diagram for ArgMinMaxLayer:
+
+
+ + +LayerWithParameters< ArgMinMaxDescriptor > +Layer +IConnectableLayer + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the ArgMinMax type. More...
 
ArgMinMaxLayerClone (Graph &graph) const override
 Creates a dynamically-allocated copy of this layer. More...
 
std::vector< TensorShapeInferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 Infers the output shape from a given input shape and axis parameter. More...
 
void ValidateTensorShapesFromInputs () override
 Check if the input tensor shape(s) will lead to a valid configuration of ArgMinMaxLayer. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< ArgMinMaxDescriptor >
const ArgMinMaxDescriptorGetParameters () const override
 If the layer has a descriptor return it. More...
 
void SerializeLayerParameters (ParameterStringifyFunction &fn) const override
 Helper to serialize the layer parameters to string (currently used in DotSerializer and company). More...
 
- Public Member Functions inherited from Layer
 Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
 
 Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, DataLayout layout, const char *name)
 
const std::string & GetNameStr () const
 
const OutputHandlerGetOutputHandler (unsigned int i=0) const
 
OutputHandlerGetOutputHandler (unsigned int i=0)
 
ShapeInferenceMethod GetShapeInferenceMethod () const
 
bool GetAllowExpandedDims () const
 
const std::vector< InputSlot > & GetInputSlots () const
 
const std::vector< OutputSlot > & GetOutputSlots () const
 
std::vector< InputSlot >::iterator BeginInputSlots ()
 
std::vector< InputSlot >::iterator EndInputSlots ()
 
std::vector< OutputSlot >::iterator BeginOutputSlots ()
 
std::vector< OutputSlot >::iterator EndOutputSlots ()
 
bool IsOutputUnconnected ()
 
void ResetPriority () const
 
LayerPriority GetPriority () const
 
LayerType GetType () const override
 Returns the armnn::LayerType of this layer. More...
 
DataType GetDataType () const
 
const BackendIdGetBackendId () const
 
void SetBackendId (const BackendId &id) override
 Set the backend of the IConnectableLayer. More...
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
void VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const
 
virtual void ReleaseConstantData ()
 
template<typename Op >
void OperateOnConstantTensors (Op op)
 
const char * GetName () const override
 Returns the name of the layer. More...
 
unsigned int GetNumInputSlots () const override
 Returns the number of connectable input slots. More...
 
unsigned int GetNumOutputSlots () const override
 Returns the number of connectable output slots. More...
 
const InputSlotGetInputSlot (unsigned int index) const override
 Get a const input slot handle by slot index. More...
 
InputSlotGetInputSlot (unsigned int index) override
 Get the input slot handle by slot index. More...
 
const OutputSlotGetOutputSlot (unsigned int index=0) const override
 Get the const output slot handle by slot index. More...
 
OutputSlotGetOutputSlot (unsigned int index=0) override
 Get the output slot handle by slot index. More...
 
void SetGuid (LayerGuid guid)
 
LayerGuid GetGuid () const final
 Returns the unique id of the layer. More...
 
void AddRelatedLayerName (const std::string layerName)
 
const std::list< std::string > & GetRelatedLayerNames ()
 
virtual void Reparent (Graph &dest, std::list< Layer * >::const_iterator iterator)=0
 
void BackendSelectionHint (Optional< BackendId > backend) final
 Provide a hint for the optimizer as to which backend to prefer for this layer. More...
 
Optional< BackendIdGetBackendHint () const
 
void SetShapeInferenceMethod (ShapeInferenceMethod shapeInferenceMethod)
 
void SetAllowExpandedDims (bool allowExpandedDims)
 
template<typename T >
std::shared_ptr< T > GetAdditionalInformation () const
 
void SetAdditionalInfoForObject (const AdditionalInfoObjectPtr &additionalInfo)
 
virtual const BaseDescriptorGetParameters () const override
 If the layer has a descriptor return it. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

 ArgMinMaxLayer (const ArgMinMaxDescriptor &param, const char *name)
 Constructor to create a ArgMinMaxLayer. More...
 
 ~ArgMinMaxLayer ()=default
 Default destructor. More...
 
- Protected Member Functions inherited from LayerWithParameters< ArgMinMaxDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const ArgMinMaxDescriptor &param, const char *name)
 
 ~LayerWithParameters ()=default
 
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *Layer::CreateWorkload. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
Layer::ImmutableConstantTensors GetConnectedConstantAsInputTensors () const
 
- Protected Member Functions inherited from Layer
virtual ~Layer ()=default
 
template<typename QueueDescriptor >
void CollectQueueDescriptorInputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
 
template<typename QueueDescriptor >
void CollectQueueDescriptorOutputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
 
void ValidateAndCopyShape (const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)
 
void VerifyShapeInferenceType (const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
 
template<typename QueueDescriptor >
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *Layer::CreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerTypeCloneBase (Graph &graph, Params &&... params) const
 
virtual ConstantTensors GetConstantTensorsByRef () override final
 
virtual ImmutableConstantTensors GetConstantTensorsByRef () const override
 
void SetAdditionalInfo (QueueDescriptor &descriptor) const
 
- Protected Member Functions inherited from IConnectableLayer
 ~IConnectableLayer ()
 Objects are not deletable via the handle. More...
 
+ + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from LayerWithParameters< ArgMinMaxDescriptor >
using DescriptorType = ArgMinMaxDescriptor
 
- Public Types inherited from IConnectableLayer
using ConstantTensors = std::vector< std::reference_wrapper< std::shared_ptr< ConstTensorHandle > >>
 
using ImmutableConstantTensors = std::vector< std::reference_wrapper< const std::shared_ptr< ConstTensorHandle > >>
 
- Protected Attributes inherited from LayerWithParameters< ArgMinMaxDescriptor >
ArgMinMaxDescriptor m_Param
 The parameters for the layer (not including tensor-valued weights etc.). More...
 
- Protected Attributes inherited from Layer
AdditionalInfoObjectPtr m_AdditionalInfoObject
 
std::vector< OutputHandlerm_OutputHandlers
 
ShapeInferenceMethod m_ShapeInferenceMethod
 
+

Detailed Description

+

This layer represents a ArgMinMax operation.

+ +

Definition at line 14 of file ArgMinMaxLayer.hpp.

+

Constructor & Destructor Documentation

+ +

◆ ArgMinMaxLayer()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
ArgMinMaxLayer (const ArgMinMaxDescriptorparam,
const char * name 
)
+
+protected
+
+ +

Constructor to create a ArgMinMaxLayer.

+
Parameters
+ + + +
[in]paramArgMinMaxDescriptor to configure the ArgMinMax operation.
[in]nameOptional name for the layer.
+
+
+ +

Definition at line 19 of file ArgMinMaxLayer.cpp.

+
20  : LayerWithParameters(1, 1, LayerType::ArgMinMax, param, name)
+
21 {
+
22 }
+
+
+
+ +

◆ ~ArgMinMaxLayer()

+ +
+
+ + + + + +
+ + + + + + + +
~ArgMinMaxLayer ()
+
+protecteddefault
+
+ +

Default destructor.

+ +
+
+

Member Function Documentation

+ +

◆ Clone()

+ +
+
+ + + + + +
+ + + + + + + + +
ArgMinMaxLayer * Clone (Graphgraph) const
+
+overridevirtual
+
+ +

Creates a dynamically-allocated copy of this layer.

+
Parameters
+ + +
[in]graphThe graph into which this layer is being cloned.
+
+
+ +

Implements Layer.

+ +

Definition at line 32 of file ArgMinMaxLayer.cpp.

+
33 {
+
34  return CloneBase<ArgMinMaxLayer>(graph, m_Param, GetName());
+
35 }
+
+

References Layer::GetName(), and LayerWithParameters< ArgMinMaxDescriptor >::m_Param.

+ +
+
+ +

◆ CreateWorkload()

+ +
+
+ + + + + +
+ + + + + + + + +
std::unique_ptr< IWorkload > CreateWorkload (const IWorkloadFactoryfactory) const
+
+overridevirtual
+
+ +

Makes a workload for the ArgMinMax type.

+
Parameters
+ + + +
[in]graphThe graph where this layer can be found.
[in]factoryThe workload factory which will create the workload.
+
+
+
Returns
A pointer to the created workload, or nullptr if not created.
+ +

Implements Layer.

+ +

Definition at line 24 of file ArgMinMaxLayer.cpp.

+
25 {
+
26  ArgMinMaxQueueDescriptor descriptor;
+
27  SetAdditionalInfo(descriptor);
+
28 
+
29  return factory.CreateWorkload(LayerType::ArgMinMax, descriptor, PrepInfoAndDesc(descriptor));
+
30 }
+
+

References armnn::ArgMinMax, IWorkloadFactory::CreateWorkload(), LayerWithParameters< ArgMinMaxDescriptor >::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

+ +
+
+ +

◆ ExecuteStrategy()

+ +
+
+ + + + + +
+ + + + + + + + +
void ExecuteStrategy (IStrategystrategy) const
+
+overridevirtual
+
+ +

Apply a visitor to this layer.

+ +

Reimplemented from Layer.

+ +

Definition at line 89 of file ArgMinMaxLayer.cpp.

+
90 {
+
91  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
+
92 }
+
+

References IStrategy::ExecuteStrategy(), Layer::GetName(), and LayerWithParameters< ArgMinMaxDescriptor >::GetParameters().

+ +
+
+ +

◆ InferOutputShapes()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< TensorShape > InferOutputShapes (const std::vector< TensorShape > & inputShapes) const
+
+overridevirtual
+
+ +

Infers the output shape from a given input shape and axis parameter.

+
Parameters
+ + +
[in]inputShapesThe vector of input shapes for ArgMinMax.
+
+
+
Returns
A vector of inferred output shapes.
+ +

Reimplemented from Layer.

+ +

Definition at line 37 of file ArgMinMaxLayer.cpp.

+
38 {
+
39  ARMNN_ASSERT(inputShapes.size() == 1);
+
40 
+
41  TensorShape inputShape = inputShapes[0];
+
42  auto inputNumDimensions = inputShape.GetNumDimensions();
+
43 
+
44  auto axis = m_Param.m_Axis;
+
45  auto unsignedAxis = armnnUtils::GetUnsignedAxis(inputNumDimensions, axis);
+
46 
+
47  ARMNN_ASSERT(unsignedAxis <= inputNumDimensions);
+
48 
+
49  // 1D input shape results in scalar output
+
50  if (inputShape.GetNumDimensions() == 1)
+
51  {
+
52  std::vector<unsigned int> tensorDimensions(1, 1);
+
53  TensorShape outputShape(1, tensorDimensions.data());
+
54 
+
55  return std::vector<TensorShape>({ outputShape });
+
56  }
+
57 
+
58  std::vector<unsigned int> tensorDimensions(inputNumDimensions - 1, 0);
+
59  for (unsigned int i = 0; i < unsignedAxis; ++i)
+
60  {
+
61  tensorDimensions[i] = inputShape[i];
+
62  }
+
63 
+
64  for (unsigned int i = unsignedAxis + 1; i < inputNumDimensions; ++i)
+
65  {
+
66  tensorDimensions[i - 1] = inputShape[i];
+
67  }
+
68 
+
69  TensorShape outputShape = TensorShape(inputNumDimensions - 1, tensorDimensions.data());
+
70 
+
71  return std::vector<TensorShape>({ outputShape });
+
72 }
+
+

References ARMNN_ASSERT, TensorShape::GetNumDimensions(), armnnUtils::GetUnsignedAxis(), ArgMinMaxDescriptor::m_Axis, and LayerWithParameters< ArgMinMaxDescriptor >::m_Param.

+ +

Referenced by ArgMinMaxLayer::ValidateTensorShapesFromInputs().

+ +
+
+ +

◆ ValidateTensorShapesFromInputs()

+ +
+
+ + + + + +
+ + + + + + + +
void ValidateTensorShapesFromInputs ()
+
+overridevirtual
+
+ +

Check if the input tensor shape(s) will lead to a valid configuration of ArgMinMaxLayer.

+
Parameters
+ + +
[in]shapeInferenceMethodIndicates if output shape shall be overwritten or just validated.
+
+
+ +

Implements Layer.

+ +

Definition at line 74 of file ArgMinMaxLayer.cpp.

+
75 {
+ +
77 
+
78  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
+
79 
+ +
81 
+
82  auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape() });
+
83 
+
84  ARMNN_ASSERT(inferredShapes.size() == 1);
+
85 
+
86  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "ArgMinMaxLayer");
+
87 }
+
+

References ARMNN_ASSERT, CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), ArgMinMaxLayer::InferOutputShapes(), Layer::m_ShapeInferenceMethod, Layer::ValidateAndCopyShape(), Layer::VerifyLayerConnections(), and Layer::VerifyShapeInferenceType().

+ +
+
+
The documentation for this class was generated from the following files: +
+
+
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
+
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:378
+
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:206
+
int m_Axis
Axis to reduce across the input tensor.
Definition: Descriptors.hpp:83
+ +
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:491
+
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:274
+
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:427
+
void ValidateAndCopyShape(const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)
Definition: Layer.cpp:422
+
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:92
+
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
Infers the output shape from a given input shape and axis parameter.
+
virtual const TensorInfo & GetTensorInfo() const =0
+
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:326
+
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const ArgMinMaxDescriptor &param, const char *name)
+
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
+
const TensorShape & GetShape() const
Definition: Tensor.hpp:191
+
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:324
+
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:319
+
const ArgMinMaxDescriptor & GetParameters() const override
+
ArgMinMaxDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
+
unsigned int GetUnsignedAxis(const unsigned int inputDimension, const int axis)
+ + + + -- cgit v1.2.1