From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- 21.02/classarmnn_1_1_depth_to_space_layer.xhtml | 630 ++++++++++++++++++++++++ 1 file changed, 630 insertions(+) create mode 100644 21.02/classarmnn_1_1_depth_to_space_layer.xhtml (limited to '21.02/classarmnn_1_1_depth_to_space_layer.xhtml') diff --git a/21.02/classarmnn_1_1_depth_to_space_layer.xhtml b/21.02/classarmnn_1_1_depth_to_space_layer.xhtml new file mode 100644 index 0000000000..21b7dc1497 --- /dev/null +++ b/21.02/classarmnn_1_1_depth_to_space_layer.xhtml @@ -0,0 +1,630 @@ + + + + + + + + + + + + + +ArmNN: DepthToSpaceLayer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
DepthToSpaceLayer Class Reference
+
+
+ +

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

+ +

#include <DepthToSpaceLayer.hpp>

+
+Inheritance diagram for DepthToSpaceLayer:
+
+
+ + +LayerWithParameters< DepthToSpaceDescriptor > +Layer +IConnectableLayer + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the DepthToSpace type. More...
 
DepthToSpaceLayerClone (Graph &graph) const override
 Creates a dynamically-allocated copy of this layer. 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...
 
void ValidateTensorShapesFromInputs () override
 Check if the input tensor shape(s) will lead to a valid configuration of DepthToSpaceLayer. More...
 
void Accept (ILayerVisitor &visitor) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< DepthToSpaceDescriptor >
const DepthToSpaceDescriptorGetParameters () const
 
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
 
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)
 
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)
 
template<typename T >
std::shared_ptr< T > GetAdditionalInformation () const
 
void SetAdditionalInfoForObject (const AdditionalInfoObjectPtr &additionalInfo)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

 DepthToSpaceLayer (const DepthToSpaceDescriptor &param, const char *name)
 Constructor to create a DepthToSpaceLayer. More...
 
 ~DepthToSpaceLayer ()=default
 Default destructor. More...
 
- Protected Member Functions inherited from LayerWithParameters< DepthToSpaceDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DepthToSpaceDescriptor &param, const char *name)
 
 ~LayerWithParameters ()=default
 
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *LayerCreateWorkload. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
- 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 *LayerCreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerTypeCloneBase (Graph &graph, Params &&... params) const
 
virtual ConstantTensors GetConstantTensorsByRef ()
 
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< DepthToSpaceDescriptor >
using DescriptorType = DepthToSpaceDescriptor
 
- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from LayerWithParameters< DepthToSpaceDescriptor >
DepthToSpaceDescriptor 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 DepthToSpace operation.

+ +

Definition at line 14 of file DepthToSpaceLayer.hpp.

+

Constructor & Destructor Documentation

+ +

◆ DepthToSpaceLayer()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DepthToSpaceLayer (const DepthToSpaceDescriptorparam,
const char * name 
)
+
+protected
+
+ +

Constructor to create a DepthToSpaceLayer.

+
Parameters
+ + + +
[in]paramDepthToSpaceDescriptor to configure the DepthToSpaceLayer operation.
[in]nameOptional name for the layer.
+
+
+ +

Definition at line 21 of file DepthToSpaceLayer.cpp.

+
22  : LayerWithParameters(1, 1, LayerType::DepthToSpace, param, name)
23 {}
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DepthToSpaceDescriptor &param, const char *name)
+ +
+
+
+ +

◆ ~DepthToSpaceLayer()

+ +
+
+ + + + + +
+ + + + + + + +
~DepthToSpaceLayer ()
+
+protecteddefault
+
+ +

Default destructor.

+ +
+
+

Member Function Documentation

+ +

◆ Accept()

+ +
+
+ + + + + +
+ + + + + + + + +
void Accept (ILayerVisitorvisitor) const
+
+overridevirtual
+
+ +

Apply a visitor to this layer.

+ +

Implements IConnectableLayer.

+ +

Definition at line 78 of file DepthToSpaceLayer.cpp.

+ +

References Layer::GetName(), LayerWithParameters< DepthToSpaceDescriptor >::GetParameters(), and ILayerVisitor::VisitDepthToSpaceLayer().

+
79 {
80  visitor.VisitDepthToSpaceLayer(this, GetParameters(), GetName());
81 }
const DepthToSpaceDescriptor & GetParameters() const
+
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:311
+
+
+
+ +

◆ Clone()

+ +
+
+ + + + + +
+ + + + + + + + +
DepthToSpaceLayer * 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 36 of file DepthToSpaceLayer.cpp.

+ +

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

+
37 {
38  return CloneBase<DepthToSpaceLayer>(graph, m_Param, GetName());
39 }
DepthToSpaceDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
+
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:311
+
+
+
+ +

◆ CreateWorkload()

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

Makes a workload for the DepthToSpace 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 25 of file DepthToSpaceLayer.cpp.

+ +

References IWorkloadFactory::CreateDepthToSpace(), SpaceToDepthDescriptor::m_BlockSize, SpaceToDepthDescriptor::m_DataLayout, LayerWithParameters< DepthToSpaceDescriptor >::m_Param, QueueDescriptorWithParameters< LayerDescriptor >::m_Parameters, LayerWithParameters< DepthToSpaceDescriptor >::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

+
26 {
27  DepthToSpaceQueueDescriptor descriptor;
28  descriptor.m_Parameters.m_BlockSize = m_Param.m_BlockSize;
29  descriptor.m_Parameters.m_DataLayout = m_Param.m_DataLayout;
30 
31  SetAdditionalInfo(descriptor);
32 
33  return factory.CreateDepthToSpace(descriptor, PrepInfoAndDesc(descriptor));
34 }
DepthToSpaceDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
+
unsigned int m_BlockSize
Scalar specifying the input block size. It must be >= 1.
+
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:245
+
DataLayout m_DataLayout
The data layout to be used (NCHW, NHWC).
+
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *LayerCreateWorkload.
+
+
+
+ +

◆ 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 41 of file DepthToSpaceLayer.cpp.

+ +

References ARMNN_ASSERT, DataLayoutIndexed::GetChannelsIndex(), DataLayoutIndexed::GetHeightIndex(), DataLayoutIndexed::GetWidthIndex(), SpaceToDepthDescriptor::m_BlockSize, SpaceToDepthDescriptor::m_DataLayout, and LayerWithParameters< DepthToSpaceDescriptor >::m_Param.

+ +

Referenced by DepthToSpaceLayer::ValidateTensorShapesFromInputs().

+
42 {
43  ARMNN_ASSERT(inputShapes.size() == 1);
44 
45  TensorShape inputShape = inputShapes[0];
46  TensorShape outputShape(inputShape);
47 
49 
50  unsigned int hIndex = dimensionIndices.GetHeightIndex();
51  unsigned int wIndex = dimensionIndices.GetWidthIndex();
52  unsigned int cIndex = dimensionIndices.GetChannelsIndex();
53 
54  outputShape[hIndex] = inputShape[hIndex] * m_Param.m_BlockSize;
55  outputShape[wIndex] = inputShape[wIndex] * m_Param.m_BlockSize;
56 
57  outputShape[cIndex] = inputShape[cIndex] / (m_Param.m_BlockSize * m_Param.m_BlockSize);
58 
59  return std::vector<TensorShape>({ outputShape });
60 }
DepthToSpaceDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
+
Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout...
+
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
unsigned int m_BlockSize
Scalar specifying the input block size. It must be >= 1.
+
DataLayout m_DataLayout
The data layout to be used (NCHW, NHWC).
+
+
+
+ +

◆ ValidateTensorShapesFromInputs()

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

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

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

Implements Layer.

+ +

Definition at line 62 of file DepthToSpaceLayer.cpp.

+ +

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

+
63 {
65 
66  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
67 
69 
70  std::vector<TensorShape> inferredShapes = InferOutputShapes({
72 
73  ARMNN_ASSERT(inferredShapes.size() == 1);
74 
75  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "DepthToSpaceLayer");
76 }
const TensorShape & GetShape() const
Definition: Tensor.hpp:187
+
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.
+
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:432
+
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:199
+
void ValidateAndCopyShape(const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)
Definition: Layer.cpp:392
+
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:348
+
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:316
+
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
#define CHECK_LOCATION()
Definition: Exceptions.hpp:197
+
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:318
+
virtual const TensorInfo & GetTensorInfo() const =0
+
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63
+
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:408
+
+
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1