ArmNN
 24.05
GatherLayer.cpp
Go to the documentation of this file.
1 //
2 // Copyright © 2017,2019-2024 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #include "GatherLayer.hpp"
7 #include "LayerCloneBase.hpp"
8 
9 #include <armnn/TypesUtils.hpp>
12 
13 namespace armnn
14 {
15 
16 GatherLayer::GatherLayer(const GatherDescriptor& param, const char* name)
17  : LayerWithParameters(2, 1, LayerType::Gather, param, name)
18 {
19 }
20 
21 std::unique_ptr<IWorkload> GatherLayer::CreateWorkload(const armnn::IWorkloadFactory& factory) const
22 {
23  GatherQueueDescriptor descriptor;
24  SetAdditionalInfo(descriptor);
25 
26  return factory.CreateWorkload(LayerType::Gather, descriptor, PrepInfoAndDesc(descriptor));
27 }
28 
30 {
31  return CloneBase<GatherLayer>(graph, m_Param, GetName());
32 }
33 
34 std::vector<TensorShape> GatherLayer::InferOutputShapes(const std::vector<TensorShape>& inputShapes) const
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 }
78 
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 }
106 
108 {
109  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
110 }
111 
112 } // namespace armnn
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:100
WorkloadData.hpp
armnn::GatherDescriptor
A GatherDescriptor for the GatherLayer.
Definition: Descriptors.hpp:965
armnn::GatherLayer::GatherLayer
GatherLayer(const GatherDescriptor &param, const char *name)
Constructor to create a GatherLayer.
Definition: GatherLayer.cpp:16
TypesUtils.hpp
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::GatherLayer
This layer represents a Gather operator.
Definition: GatherLayer.hpp:14
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::IStrategy
Definition: IStrategy.hpp:16
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
WorkloadFactory.hpp
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:332
armnn::GatherLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s).
Definition: GatherLayer.cpp:79
armnn::GatherQueueDescriptor
Definition: WorkloadData.hpp:507
armnn::InputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Gets the TensorInfo for this InputSlot.
Definition: Layer.cpp:614
armnn::GatherLayer::Clone
GatherLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: GatherLayer.cpp:29
armnn::TensorShape
Definition: Tensor.hpp:20
GatherLayer.hpp
armnn::LayerWithParameters< GatherDescriptor >::m_Param
GatherDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
armnn::TensorShape::GetNumDimensions
unsigned int GetNumDimensions() const
Function that returns the tensor rank.
Definition: Tensor.cpp:174
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::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:526
armnn::GatherLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Gather type.
Definition: GatherLayer.cpp:21
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::GatherLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: GatherLayer.cpp:107
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:193
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
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::TensorShape::GetDimensionality
Dimensionality GetDimensionality() const
Function that returns the tensor type.
Definition: Tensor.hpp:92
armnn::Layer::m_ShapeInferenceMethod
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:441
armnn::LayerType
LayerType
When adding a new layer, adapt also the LastLayer enum value in the enum class LayerType below.
Definition: Types.hpp:491
armnn::Graph
Definition: Graph.hpp:30
armnn::IWorkloadFactory::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(LayerType type, const QueueDescriptor &descriptor, const WorkloadInfo &info) const =0
Backends should implement their own CreateWorkload function with a switch statement.
armnn::IStrategy::ExecuteStrategy
virtual void ExecuteStrategy(const IConnectableLayer *layer, const armnn::BaseDescriptor &descriptor, const std::vector< armnn::ConstTensor > &constants, const char *name, const armnn::LayerBindingId id=0)=0
LayerCloneBase.hpp
armnn::Gather
void Gather(const TensorInfo &paramsInfo, const TensorInfo &indicesInfo, const TensorInfo &outputInfo, Decoder< float > &params, const int32_t *indices, Encoder< float > &output, const int32_t axis_int)
Definition: Gather.cpp:15