ArmNN
 24.08
Pooling3dLayer.cpp
Go to the documentation of this file.
1 //
2 // Copyright © 2021-2024 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #include "Pooling3dLayer.hpp"
7 
8 #include "LayerCloneBase.hpp"
9 
10 #include <armnn/TypesUtils.hpp>
11 
13 
16 
17 using namespace armnnUtils;
18 
19 namespace armnn
20 {
21 
22 Pooling3dLayer::Pooling3dLayer(const Pooling3dDescriptor& param, const char* name)
23  : LayerWithParameters(1, 1, LayerType::Pooling3d, param, name)
24 {
25 }
26 
27 std::unique_ptr<IWorkload> Pooling3dLayer::CreateWorkload(const IWorkloadFactory& factory) const
28 {
29  Pooling3dQueueDescriptor descriptor;
30  SetAdditionalInfo(descriptor);
31 
32  return factory.CreateWorkload(LayerType::Pooling3d, descriptor, PrepInfoAndDesc(descriptor));
33 }
34 
36 {
37  return CloneBase<Pooling3dLayer>(graph, m_Param, GetName());
38 }
39 
40 std::vector<TensorShape> Pooling3dLayer::InferOutputShapes(const std::vector<TensorShape>& inputShapes) const
41 {
42  if (inputShapes.size() != 1)
43  {
44  throw armnn::Exception("inputShapes' size is \"" + std::to_string(inputShapes.size()) +
45  "\" - should be \"1\".");
46  }
47 
48  const TensorShape& inputShape = inputShapes[0];
49  const DataLayoutIndexed dimensionIndices = m_Param.m_DataLayout;
50 
51  // If we support multiple batch dimensions in the future, then this assert will need to change.
52  if (inputShape.GetNumDimensions() != 5)
53  {
54  throw armnn::Exception("Pooling3dLayer will always have 5D input.");
55  }
56 
57  unsigned int inWidth = inputShape[dimensionIndices.GetWidthIndex()];
58  unsigned int inHeight = inputShape[dimensionIndices.GetHeightIndex()];
59  unsigned int inDepth = inputShape[dimensionIndices.GetDepthIndex()];
60  unsigned int inChannels = inputShape[dimensionIndices.GetChannelsIndex()];
61  unsigned int inBatchSize = inputShape[0];
62 
63  bool isGlobalPooling = (m_Param.m_StrideX==0 && m_Param.m_StrideY==0 && m_Param.m_StrideZ==0);
64  unsigned int outWidth = 1;
65  unsigned int outHeight = 1;
66  unsigned int outDepth = 1;
67  if (!isGlobalPooling)
68  {
70  {
71  throw armnn::Exception("Stride can only be zero when performing global pooling");
72  }
73 
74  auto CalcSize = [](auto inSize, auto lowPad, auto highPad, auto poolSize, auto stride, auto outputShapeRounding)
75  {
76  unsigned int readSize = inSize + lowPad + highPad - poolSize;
77  float div = static_cast<float>(readSize) / static_cast<float>(stride);
78 
79  unsigned int size = 0;
80  switch (outputShapeRounding)
81  {
83  size = static_cast<unsigned int>(ceil(div)) + 1;
84  break;
85  case OutputShapeRounding ::Floor:
86  size = static_cast<unsigned int>(floor(div)) + 1;
87  break;
88  default:
89  throw armnn::Exception("Unsupported Output Shape Rounding");
90  }
91 
92  // Makes sure that border operations will start from inside the input and not the padded area.
93  // This is what CL does...
94  if ((size - 1)*stride >= inSize + lowPad)
95  {
96  --size;
97  }
98 
99  return size;
100  };
101 
102  outWidth = CalcSize(inWidth, m_Param.m_PadLeft, m_Param.m_PadRight, m_Param.m_PoolWidth, m_Param.m_StrideX,
104  outHeight = CalcSize(inHeight, m_Param.m_PadTop, m_Param.m_PadBottom, m_Param.m_PoolHeight, m_Param.m_StrideY,
106  outDepth = CalcSize(inDepth, m_Param.m_PadFront, m_Param.m_PadBack, m_Param.m_PoolDepth, m_Param.m_StrideZ,
108  }
109  unsigned int outChannels = inChannels;
110  unsigned int outBatchSize = inBatchSize;
111 
113  TensorShape( { outBatchSize, outDepth, outHeight, outWidth, outChannels } ) :
114  TensorShape( { outBatchSize, outChannels, outDepth, outHeight, outWidth });
115 
116  return std::vector<TensorShape>({ tensorShape });
117 }
118 
120 {
122 
123  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
124 
126 
127  auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetTensorInfo().GetShape() });
128 
129  if (inferredShapes.size() != 1)
130  {
131  throw armnn::LayerValidationException("inferredShapes has "
132  + std::to_string(inferredShapes.size()) +
133  " elements - should only have 1.");
134  }
135 
136  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "Pooling3dLayer");
137 }
138 
140 {
141  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
142 }
143 
144 } // namespace armnn
armnn::Pooling3dDescriptor::m_OutputShapeRounding
OutputShapeRounding m_OutputShapeRounding
The rounding method for the output shape. (Floor, Ceiling).
Definition: Descriptors.hpp:499
armnn::Pooling3dDescriptor::m_PadTop
uint32_t m_PadTop
Padding top value in the height dimension.
Definition: Descriptors.hpp:479
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:100
WorkloadData.hpp
armnn::Pooling3dDescriptor
A Pooling3dDescriptor for the Pooling3dLayer.
Definition: Descriptors.hpp:431
armnn::Pooling3dLayer
This layer represents a pooling 3d operation.
Definition: Pooling3dLayer.hpp:13
armnn::Pooling3dLayer::Clone
Pooling3dLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: Pooling3dLayer.cpp:35
TypesUtils.hpp
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
armnnUtils::DataLayoutIndexed
Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout.
Definition: DataLayoutIndexed.hpp:17
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::Pooling3dLayer::Pooling3dLayer
Pooling3dLayer(const Pooling3dDescriptor &param, const char *name)
Constructor to create a Pooling3dLayer.
Definition: Pooling3dLayer.cpp:22
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::Pooling3dDescriptor::m_StrideZ
uint32_t m_StrideZ
Stride value when proceeding through input for the depth dimension.
Definition: Descriptors.hpp:497
armnn::IStrategy
Definition: IStrategy.hpp:16
armnn::Pooling3dDescriptor::m_DataLayout
DataLayout m_DataLayout
The data layout to be used (NCDHW, NDHWC).
Definition: Descriptors.hpp:503
armnn::Pooling3dDescriptor::m_PadBottom
uint32_t m_PadBottom
Padding bottom value in the height dimension.
Definition: Descriptors.hpp:481
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< Pooling3dDescriptor >::GetParameters
const Pooling3dDescriptor & GetParameters() const override
Definition: LayerWithParameters.hpp:19
armnn::ceil
Definition: Ceil.hpp:13
WorkloadFactory.hpp
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::Pooling3dDescriptor::m_StrideY
uint32_t m_StrideY
Stride value when proceeding through input for the height dimension.
Definition: Descriptors.hpp:495
armnn::Pooling3d
void Pooling3d(Decoder< float > &rInputDecoder, Encoder< float > &rOutputEncoder, const TensorInfo &inputInfo, const TensorInfo &outputInfo, const Pooling3dDescriptor &params)
Computes the Pooling3d operation.
Definition: Pooling3d.cpp:172
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:332
armnnUtils::DataLayoutIndexed::GetHeightIndex
unsigned int GetHeightIndex() const
Definition: DataLayoutIndexed.hpp:24
armnn::DataLayout::NDHWC
@ NDHWC
armnn::InputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Gets the TensorInfo for this InputSlot.
Definition: Layer.cpp:614
armnn::Pooling3dLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: Pooling3dLayer.cpp:139
armnn::TensorShape
Definition: Tensor.hpp:20
armnn::Pooling3dLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Pooling3d type.
Definition: Pooling3dLayer.cpp:27
armnn::Pooling3dDescriptor::m_PoolWidth
uint32_t m_PoolWidth
Pooling width value.
Definition: Descriptors.hpp:487
armnn::LayerWithParameters< Pooling3dDescriptor >::m_Param
Pooling3dDescriptor 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< Pooling3dDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: LayerWithParameters.hpp:44
armnn::Pooling3dQueueDescriptor
Definition: WorkloadData.hpp:203
armnn::LayerValidationException
Definition: Exceptions.hpp:105
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnnUtils
Definition: CompatibleTypes.hpp:10
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::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
armnnUtils::DataLayoutIndexed::GetWidthIndex
unsigned int GetWidthIndex() const
Definition: DataLayoutIndexed.hpp:25
armnn::Pooling3dDescriptor::m_PadFront
uint32_t m_PadFront
Padding front value in the depth dimension.
Definition: Descriptors.hpp:483
armnn::Pooling3dDescriptor::m_PadRight
uint32_t m_PadRight
Padding right value in the width dimension.
Definition: Descriptors.hpp:477
armnn::Pooling3dLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of Pooling3dLayer.
Definition: Pooling3dLayer.cpp:119
armnn::LayerType::Pooling3d
@ Pooling3d
armnn::Pooling3dDescriptor::m_PoolHeight
uint32_t m_PoolHeight
Pooling height value.
Definition: Descriptors.hpp:489
armnn::Pooling3dDescriptor::m_PadBack
uint32_t m_PadBack
Padding back value in the depth dimension.
Definition: Descriptors.hpp:485
armnn::Pooling3dDescriptor::m_StrideX
uint32_t m_StrideX
Stride value when proceeding through input for the width dimension.
Definition: Descriptors.hpp:493
armnn::Pooling3dDescriptor::m_PadLeft
uint32_t m_PadLeft
Padding left value in the width dimension.
Definition: Descriptors.hpp:475
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:193
armnn::Pooling3dLayer::InferOutputShapes
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,...
Definition: Pooling3dLayer.cpp:40
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnnUtils::DataLayoutIndexed::GetChannelsIndex
unsigned int GetChannelsIndex() const
Definition: DataLayoutIndexed.hpp:23
Pooling3dLayer.hpp
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:410
armnn::OutputShapeRounding::Ceiling
@ Ceiling
armnn::Pooling3dDescriptor::m_PoolDepth
uint32_t m_PoolDepth
Pooling depth value.
Definition: Descriptors.hpp:491
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
DataLayoutIndexed.hpp
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
armnnUtils::DataLayoutIndexed::GetDepthIndex
unsigned int GetDepthIndex() const
Definition: DataLayoutIndexed.hpp:26