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_reshape_layer.xhtml | 723 +++++++++++++++++++++++++++++++ 1 file changed, 723 insertions(+) create mode 100644 23.05/classarmnn_1_1_reshape_layer.xhtml (limited to '23.05/classarmnn_1_1_reshape_layer.xhtml') diff --git a/23.05/classarmnn_1_1_reshape_layer.xhtml b/23.05/classarmnn_1_1_reshape_layer.xhtml new file mode 100644 index 0000000000..5eab06fa68 --- /dev/null +++ b/23.05/classarmnn_1_1_reshape_layer.xhtml @@ -0,0 +1,723 @@ + + + + + + + + + + + + + +ArmNN: ReshapeLayer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  23.05 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
ReshapeLayer Class Reference
+
+
+ +

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

+ +

#include <ReshapeLayer.hpp>

+
+Inheritance diagram for ReshapeLayer:
+
+
+ + +LayerWithParameters< ReshapeDescriptor > +Layer +IConnectableLayer + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the Reshape type. More...
 
ReshapeLayerClone (Graph &graph) const override
 Creates a dynamically-allocated copy of this layer. More...
 
void ValidateTensorShapesFromInputs () override
 Check if the input tensor shape(s) will lead to a valid configuration of ReshapeLayer. More...
 
std::vector< TensorShapeInferOutputShapes (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. More...
 
bool IsEqual (const Layer &other) const
 Indicates if the other layer received is equal to this one. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< ReshapeDescriptor >
const ReshapeDescriptorGetParameters () 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

 ReshapeLayer (const ReshapeDescriptor &desc, const char *name)
 Constructor to create a ReshapeLayer. More...
 
 ~ReshapeLayer ()=default
 Default destructor. More...
 
- Protected Member Functions inherited from LayerWithParameters< ReshapeDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const ReshapeDescriptor &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< ReshapeDescriptor >
using DescriptorType = ReshapeDescriptor
 
- 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< ReshapeDescriptor >
ReshapeDescriptor 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 reshape operation.

+ +

Definition at line 15 of file ReshapeLayer.hpp.

+

Constructor & Destructor Documentation

+ +

◆ ReshapeLayer()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
ReshapeLayer (const ReshapeDescriptordesc,
const char * name 
)
+
+protected
+
+ +

Constructor to create a ReshapeLayer.

+
Parameters
+ + + +
[in]paramReshapeDescriptor to configure the reshape operation.
[in]nameOptional name for the layer.
+
+
+ +

Definition at line 17 of file ReshapeLayer.cpp.

+
18  : LayerWithParameters(1, 1, LayerType::Reshape, param, name)
+
19 {
+
20 }
+
+

References armnn::Reshape.

+ +
+
+ +

◆ ~ReshapeLayer()

+ +
+
+ + + + + +
+ + + + + + + +
~ReshapeLayer ()
+
+protecteddefault
+
+ +

Default destructor.

+ +
+
+

Member Function Documentation

+ +

◆ Clone()

+ +
+
+ + + + + +
+ + + + + + + + +
ReshapeLayer * 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 30 of file ReshapeLayer.cpp.

+
31 {
+
32  return CloneBase<ReshapeLayer>(graph, m_Param, GetName());
+
33 }
+
+

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

+ +
+
+ +

◆ CreateWorkload()

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

Makes a workload for the Reshape 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 22 of file ReshapeLayer.cpp.

+
23 {
+
24  ReshapeQueueDescriptor descriptor;
+
25  SetAdditionalInfo(descriptor);
+
26 
+
27  return factory.CreateWorkload(LayerType::Reshape, descriptor, PrepInfoAndDesc(descriptor));
+
28 }
+
+

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

+ +
+
+ +

◆ ExecuteStrategy()

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

Apply a visitor to this layer.

+ +

Reimplemented from Layer.

+ +

Definition at line 57 of file ReshapeLayer.cpp.

+
58 {
+
59  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
+
60 }
+
+

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

+ +
+
+ +

◆ InferOutputShapes()

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

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.

+
Parameters
+ + +
[in]inputShapesThe input shapes layer has.
+
+
+
Returns
A vector to the inferred output shape.
+ +

Reimplemented from Layer.

+ +

Definition at line 35 of file ReshapeLayer.cpp.

+
36 {
+
37  IgnoreUnused(inputShapes);
+
38  return std::vector<TensorShape>({ m_Param.m_TargetShape });
+
39 }
+
+

References armnn::IgnoreUnused(), LayerWithParameters< ReshapeDescriptor >::m_Param, and ReshapeDescriptor::m_TargetShape.

+ +

Referenced by ReshapeLayer::ValidateTensorShapesFromInputs().

+ +
+
+ +

◆ IsEqual()

+ +
+
+ + + + + +
+ + + + + + + + +
bool IsEqual (const Layerother) const
+
+inline
+
+ +

Indicates if the other layer received is equal to this one.

+
Parameters
+ + +
otherThe other layer to be compared with.
+
+
+
Returns
true if other layer is equal to this false otherwise.
+ +

Definition at line 42 of file ReshapeLayer.hpp.

+
43  {
+
44  return (other.GetType() == LayerType::Reshape) &&
+
45  m_Param.m_TargetShape == PolymorphicDowncast<const ReshapeLayer*>(&other)->m_Param.m_TargetShape;
+
46  }
+
+

References Layer::GetType(), LayerWithParameters< ReshapeDescriptor >::m_Param, ReshapeDescriptor::m_TargetShape, and armnn::Reshape.

+ +
+
+ +

◆ ValidateTensorShapesFromInputs()

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

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

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

Implements Layer.

+ +

Definition at line 41 of file ReshapeLayer.cpp.

+
42 {
+ +
44 
+
45  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
+
46 
+ +
48 
+
49  auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape() });
+
50 
+
51  ARMNN_ASSERT(inferredShapes.size() == 1);
+
52  ARMNN_ASSERT(inferredShapes[0].GetDimensionality() == Dimensionality::Specified);
+
53 
+
54  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "ReshapeLayer");
+
55 }
+
+

References ARMNN_ASSERT, CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), ReshapeLayer::InferOutputShapes(), Layer::m_ShapeInferenceMethod, armnn::Specified, 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
+
void IgnoreUnused(Ts &&...)
+
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
+ +
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 ReshapeDescriptor &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
+
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,...
+
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:319
+
TensorShape m_TargetShape
Target shape value.
+
const ReshapeDescriptor & GetParameters() const override
+
ReshapeDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
+ + + + -- cgit v1.2.1