ArmNN
 24.05
GatherNdLayer.cpp
Go to the documentation of this file.
1 //
2 // Copyright © 2022-2024 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #include "GatherNdLayer.hpp"
7 #include "LayerCloneBase.hpp"
8 
9 #include <armnn/TypesUtils.hpp>
12 
13 namespace armnn
14 {
15 
17  : Layer(2, 1, LayerType::GatherNd, name)
18 {
19 }
20 
21 std::unique_ptr<IWorkload> GatherNdLayer::CreateWorkload(const armnn::IWorkloadFactory& factory) const
22 {
23  GatherNdQueueDescriptor descriptor;
24  SetAdditionalInfo(descriptor);
25 
26  return factory.CreateWorkload(LayerType::GatherNd, descriptor, PrepInfoAndDesc(descriptor));
27 }
28 
30 {
31  return CloneBase<GatherNdLayer>(graph, GetName());
32 }
33 
34 std::vector<TensorShape> GatherNdLayer::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 
53  // last dimension of indices
54  unsigned int index_depth = indices[indicesDim - 1];
55  if (index_depth > paramsDim)
56  {
57  throw armnn::Exception("index_depth must not be greater than paramsDim (\""
58  + std::to_string(index_depth) +
59  "\" vs \""
60  + std::to_string(paramsDim) + "\")");
61  }
62 
63  // all but the last dimension of indices
64  std::vector<unsigned int> outer_shape;
65  outer_shape.reserve(indicesDim - 1);
66  for (unsigned int i = 0; i < indicesDim - 1; ++i)
67  {
68  outer_shape.emplace_back(indices[i]);
69  }
70 
71  // elements after index_depth
72  std::vector<unsigned int> inner_shape;
73  inner_shape.reserve(paramsDim - index_depth);
74  for (unsigned int i = index_depth; i < paramsDim; ++i)
75  {
76  inner_shape.emplace_back(params[i]);
77  }
78 
79  // concatenate outer_shape + inner_shape
80  std::vector<unsigned int> output_shape;
81  output_shape.reserve( outer_shape.size() + inner_shape.size() );
82  output_shape.insert( output_shape.end(), outer_shape.begin(), outer_shape.end() );
83  output_shape.insert( output_shape.end(), inner_shape.begin(), inner_shape.end() );
84 
85  const auto outputDim = static_cast<unsigned int>(output_shape.size());
86  return std::vector<TensorShape>({ TensorShape({outputDim, output_shape.data()})});
87 }
88 
90 {
92 
93  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
94 
96 
97  std::vector<TensorShape> inferredShapes = InferOutputShapes(
100 
101  if (inferredShapes.size() != 1)
102  {
103  throw armnn::LayerValidationException("inferredShapes has "
104  + std::to_string(inferredShapes.size()) +
105  " elements - should only have 1.");
106  }
107 
108  if (inferredShapes[0].GetDimensionality() != Dimensionality::Specified &&
109  inferredShapes[0].GetDimensionality() != Dimensionality::Scalar)
110  {
111  throw armnn::LayerValidationException("inferredShapes' dimensionality is neither specified nor scalar.");
112  }
113 
114  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "GatherNdLayer");
115 }
116 
117 } // namespace armnn
armnn::GatherNdQueueDescriptor
Definition: WorkloadData.hpp:502
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:100
WorkloadData.hpp
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::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::GatherNdLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Gather type.
Definition: GatherNdLayer.cpp:21
armnn::Layer::GetInputSlot
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:337
WorkloadFactory.hpp
armnn::LayerType::GatherNd
@ GatherNd
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:332
armnn::Layer
Definition: Layer.hpp:230
armnn::InputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Gets the TensorInfo for this InputSlot.
Definition: Layer.cpp:614
armnn::TensorShape
Definition: Tensor.hpp:20
GatherNdLayer.hpp
armnn::TensorShape::GetNumDimensions
unsigned int GetNumDimensions() const
Function that returns the tensor rank.
Definition: Tensor.cpp:174
armnn::Layer::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: Layer.hpp:409
armnn::Dimensionality::Scalar
@ Scalar
armnn::LayerValidationException
Definition: Exceptions.hpp:105
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::GatherNdLayer::Clone
GatherNdLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: GatherNdLayer.cpp:29
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:526
armnn::GatherNdLayer::GatherNdLayer
GatherNdLayer(const char *name)
Constructor to create a GatherNdLayer.
Definition: GatherNdLayer.cpp:16
armnn::Layer::SetAdditionalInfo
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:303
armnn::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
armnn::GatherNdLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
Infers the output shapes from given input shapes and layer properties.
Definition: GatherNdLayer.cpp:34
armnn::Dimensionality::Specified
@ Specified
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:193
armnn::GatherNdLayer
This layer represents a GatherNd operator.
Definition: GatherNdLayer.hpp:14
armnn::GatherNdLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of GatherNdLayer.
Definition: GatherNdLayer.cpp:89
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
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.
LayerCloneBase.hpp