ArmNN
 24.08
GatherLayer Class Reference

This layer represents a Gather operator. More...

#include <GatherLayer.hpp>

Inheritance diagram for GatherLayer:
[legend]
Collaboration diagram for GatherLayer:
[legend]

Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the Gather type. More...
 
GatherLayerClone (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 shapes from given input shapes and layer properties. More...
 
void ValidateTensorShapesFromInputs () override
 Check if the input tensor shape(s). More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< GatherDescriptor >
const GatherDescriptorGetParameters () 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

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

Definition at line 14 of file GatherLayer.hpp.

Constructor & Destructor Documentation

◆ GatherLayer()

GatherLayer ( const GatherDescriptor param,
const char *  name 
)
protected

Constructor to create a GatherLayer.

Parameters
[in]paramGatherDescriptor to configure the stack operation.
[in]nameOptional name for the layer.

Definition at line 16 of file GatherLayer.cpp.

17  : LayerWithParameters(2, 1, LayerType::Gather, param, name)
18 {
19 }

◆ ~GatherLayer()

~GatherLayer ( )
protecteddefault

Default destructor.

Member Function Documentation

◆ Clone()

GatherLayer * Clone ( Graph graph) 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 29 of file GatherLayer.cpp.

30 {
31  return CloneBase<GatherLayer>(graph, m_Param, GetName());
32 }

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

◆ CreateWorkload()

std::unique_ptr< IWorkload > CreateWorkload ( const IWorkloadFactory factory) const
overridevirtual

Makes a workload for the Gather 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 21 of file GatherLayer.cpp.

22 {
23  GatherQueueDescriptor descriptor;
24  SetAdditionalInfo(descriptor);
25 
26  return factory.CreateWorkload(LayerType::Gather, descriptor, PrepInfoAndDesc(descriptor));
27 }

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

◆ ExecuteStrategy()

void ExecuteStrategy ( IStrategy strategy) const
overridevirtual

Apply a visitor to this layer.

Reimplemented from Layer.

Definition at line 107 of file GatherLayer.cpp.

108 {
109  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
110 }

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

◆ InferOutputShapes()

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

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 34 of file GatherLayer.cpp.

35 {
36  if (inputShapes.size() != 2)
37  {
38  throw armnn::Exception("inputShapes' size is \"" + std::to_string(inputShapes.size()) +
39  "\" - should be \"2\".");
40  }
41 
42  const TensorShape& params = inputShapes[0];
43  const TensorShape& indices = inputShapes[1];
44 
45  if (indices.GetDimensionality() == Dimensionality::Scalar && indices.GetNumDimensions() == 1)
46  {
47  return std::vector<TensorShape>({ TensorShape(Dimensionality::Scalar)});
48  }
49 
50  const unsigned int paramsDim = params.GetNumDimensions();
51  const unsigned int indicesDim = indices.GetNumDimensions();
52  const unsigned int outputDim = paramsDim - 1 + indicesDim;
53 
54  std::vector<unsigned int> dimSizes;
55 
56  unsigned int axis = static_cast<unsigned int>(m_Param.m_Axis);
57  if (m_Param.m_Axis < 0)
58  {
59  int32_t axis_aux = static_cast<int32_t>(paramsDim) + m_Param.m_Axis;
60  axis = static_cast<unsigned int> (axis_aux);
61  }
62 
63  for (unsigned int i = 0; i < axis; ++i)
64  {
65  dimSizes.push_back(params[i]);
66  }
67  for (unsigned int i = axis; i < indicesDim + axis; ++i)
68  {
69  dimSizes.push_back(indices[i - axis]);
70  }
71  for (unsigned int i = 1 + axis; i < paramsDim; ++i)
72  {
73  dimSizes.push_back(params[i]);
74  }
75 
76  return std::vector<TensorShape>({ TensorShape({outputDim, dimSizes.data()})});
77 }

References TensorShape::GetDimensionality(), TensorShape::GetNumDimensions(), GatherDescriptor::m_Axis, LayerWithParameters< GatherDescriptor >::m_Param, and armnn::Scalar.

Referenced by GatherLayer::ValidateTensorShapesFromInputs().

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )
overridevirtual

Check if the input tensor shape(s).

will lead to a valid configuration of GatherLayer.

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

Implements Layer.

Definition at line 79 of file GatherLayer.cpp.

80 {
82 
83  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
84 
86 
87  std::vector<TensorShape> inferredShapes = InferOutputShapes(
90 
91  if (inferredShapes.size() != 1)
92  {
93  throw armnn::LayerValidationException("inferredShapes has "
94  + std::to_string(inferredShapes.size()) +
95  " elements - should only have 1.");
96  }
97 
98  if (inferredShapes[0].GetDimensionality() != Dimensionality::Specified &&
99  inferredShapes[0].GetDimensionality() != Dimensionality::Scalar)
100  {
101  throw armnn::LayerValidationException("inferredShapes' dimensionality is neither specified nor scalar.");
102  }
103 
104  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "GatherLayer");
105 }

References CHECK_LOCATION, Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), InputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), GatherLayer::InferOutputShapes(), Layer::m_ShapeInferenceMethod, armnn::Scalar, armnn::Specified, Layer::ValidateAndCopyShape(), Layer::VerifyLayerConnections(), and Layer::VerifyShapeInferenceType().


The documentation for this class was generated from the following files:
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:100
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
armnn::Layer::ValidateAndCopyShape
void ValidateAndCopyShape(const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)
Definition: Layer.cpp:457
armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:339
armnn::Layer::GetInputSlot
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:337
armnn::LayerWithParameters< GatherDescriptor >::GetParameters
const GatherDescriptor & GetParameters() const override
Definition: LayerWithParameters.hpp:19
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:332
armnn::InputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Gets the TensorInfo for this InputSlot.
Definition: Layer.cpp:614
armnn::LayerWithParameters< GatherDescriptor >::m_Param
GatherDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
armnn::LayerWithParameters< GatherDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: LayerWithParameters.hpp:44
armnn::Dimensionality::Scalar
@ Scalar
armnn::LayerValidationException
Definition: Exceptions.hpp:105
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:526
armnn::Layer::SetAdditionalInfo
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:303
armnn::GatherDescriptor::m_Axis
int32_t m_Axis
The axis in params to gather indices from.
Definition: Descriptors.hpp:981
armnn::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
armnn::LayerType::Gather
@ Gather
armnn::Dimensionality::Specified
@ Specified
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:193
armnn::GatherLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
Infers the output shapes from given input shapes and layer properties.
Definition: GatherLayer.cpp:34
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:410
armnn::LayerWithParameters< GatherDescriptor >::LayerWithParameters
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const GatherDescriptor &param, const char *name)
Definition: LayerWithParameters.hpp:30
armnn::Layer::m_ShapeInferenceMethod
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:441