Pooling3dLayer Class Reference

This layer represents a pooling 3d operation. More...

#include <Pooling3dLayer.hpp>

Inheritance diagram for Pooling3dLayer:

Public Member Functions
virtual std::unique_ptr< IWorkload >	CreateWorkload (const IWorkloadFactory &factory) const override
	Makes a workload for the Pooling3d type. More...
Pooling3dLayer *	Clone (Graph &graph) const override
	Creates a dynamically-allocated copy of this layer. More...
void	ValidateTensorShapesFromInputs () override
	Check if the input tensor shape(s) will lead to a valid configuration of Pooling3dLayer. More...
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. More...
void	ExecuteStrategy (IStrategy &strategy) const override
	Apply a visitor to this layer. More...
Public Member Functions inherited from LayerWithParameters< Pooling3dDescriptor >
const Pooling3dDescriptor &	GetParameters () 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 OutputHandler &	GetOutputHandler (unsigned int i=0) const
OutputHandler &	GetOutputHandler (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 BackendId &	GetBackendId () 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 InputSlot &	GetInputSlot (unsigned int index) const override
	Get a const input slot handle by slot index. More...
InputSlot &	GetInputSlot (unsigned int index) override
	Get the input slot handle by slot index. More...
const OutputSlot &	GetOutputSlot (unsigned int index=0) const override
	Get the const output slot handle by slot index. More...
OutputSlot &	GetOutputSlot (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< BackendId >	GetBackendHint () 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 BaseDescriptor &	GetParameters () const override
	If the layer has a descriptor return it. More...

Protected Member Functions
	Pooling3dLayer (const Pooling3dDescriptor &param, const char *name)
	Constructor to create a Pooling3dLayer. More...
	~Pooling3dLayer ()=default
	Default destructor. More...
Protected Member Functions inherited from LayerWithParameters< Pooling3dDescriptor >
	LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const Pooling3dDescriptor &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>
LayerType *	CloneBase (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< Pooling3dDescriptor >
using	DescriptorType = Pooling3dDescriptor
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< Pooling3dDescriptor >
Pooling3dDescriptor	m_Param
	The parameters for the layer (not including tensor-valued weights etc.). More...
Protected Attributes inherited from Layer
AdditionalInfoObjectPtr	m_AdditionalInfoObject
std::vector< OutputHandler >	m_OutputHandlers
ShapeInferenceMethod	m_ShapeInferenceMethod

Detailed Description

This layer represents a pooling 3d operation.

Definition at line 13 of file Pooling3dLayer.hpp.

Constructor & Destructor Documentation

Pooling3dLayer()

Pooling3dLayer ( const Pooling3dDescriptor &  param, const char *  name  )

protected

Constructor to create a Pooling3dLayer.

Parameters

[in]	param	Pooling3dDescriptor to configure the pooling3d operation.
[in]	name	Optional name for the layer.

Definition at line 22 of file Pooling3dLayer.cpp.

    : LayerWithParameters(1, 1, LayerType::Pooling3d, param, name)
{
}

References armnn::Pooling3d().

~Pooling3dLayer()

~Pooling3dLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

Clone()

Pooling3dLayer * Clone ( Graph &  graph ) const

overridevirtual

Creates a dynamically-allocated copy of this layer.

Parameters

[in]

graph

The graph into which this layer is being cloned.

Implements Layer.

Definition at line 35 of file Pooling3dLayer.cpp.

{
    return CloneBase<Pooling3dLayer>(graph, m_Param, GetName());
}

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

CreateWorkload()

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

overridevirtual

Makes a workload for the Pooling3d type.

Parameters

[in]	graph	The graph where this layer can be found.
[in]	factory	The workload factory which will create the workload.

Returns

A pointer to the created workload, or nullptr if not created.

Implements Layer.

Definition at line 27 of file Pooling3dLayer.cpp.

{
    Pooling3dQueueDescriptor descriptor;
    SetAdditionalInfo(descriptor);
 
    return factory.CreateWorkload(LayerType::Pooling3d, descriptor, PrepInfoAndDesc(descriptor));
}

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

ExecuteStrategy()

void ExecuteStrategy ( IStrategy &  strategy ) const

overridevirtual

Apply a visitor to this layer.

Reimplemented from Layer.

Definition at line 124 of file Pooling3dLayer.cpp.

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

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

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]

inputShapes

The input shapes layer has.

Returns

A vector to the inferred output shape.

Reimplemented from Layer.

Definition at line 40 of file Pooling3dLayer.cpp.

{
    ARMNN_ASSERT(inputShapes.size() == 1);
    const TensorShape& inputShape = inputShapes[0];
    const DataLayoutIndexed dimensionIndices = m_Param.m_DataLayout;
 
    // If we support multiple batch dimensions in the future, then this assert will need to change.
    ARMNN_ASSERT_MSG(inputShape.GetNumDimensions() == 5, "Pooling3dLayer will always have 5D input.");
 
    unsigned int inWidth = inputShape[dimensionIndices.GetWidthIndex()];
    unsigned int inHeight = inputShape[dimensionIndices.GetHeightIndex()];
    unsigned int inDepth = inputShape[dimensionIndices.GetDepthIndex()];
    unsigned int inChannels = inputShape[dimensionIndices.GetChannelsIndex()];
    unsigned int inBatchSize = inputShape[0];
 
    bool isGlobalPooling = (m_Param.m_StrideX==0 && m_Param.m_StrideY==0 && m_Param.m_StrideZ==0);
    unsigned int outWidth = 1;
    unsigned int outHeight = 1;
    unsigned int outDepth = 1;
    if (!isGlobalPooling)
    {
        ARMNN_ASSERT_MSG(m_Param.m_StrideX!=0 && m_Param.m_StrideY!=0 && m_Param.m_StrideZ!=0,
                         "Stride can only be zero when performing global pooling");
 
        auto CalcSize = [](auto inSize, auto lowPad, auto highPad, auto poolSize, auto stride, auto outputShapeRounding)
            {
                unsigned int readSize = inSize + lowPad + highPad - poolSize;
                float div = static_cast<float>(readSize) / static_cast<float>(stride);
 
                unsigned int size = 0;
                switch (outputShapeRounding)
                {
                    case OutputShapeRounding::Ceiling:
                        size = static_cast<unsigned int>(ceil(div)) + 1;
                        break;
                    case OutputShapeRounding ::Floor:
                        size = static_cast<unsigned int>(floor(div)) + 1;
                        break;
                    default:
                        ARMNN_ASSERT_MSG(false, "Unsupported Output Shape Rounding");
                }
 
                // Makes sure that border operations will start from inside the input and not the padded area.
                // This is what CL does...
                if ((size - 1)*stride >= inSize + lowPad)
                {
                    --size;
                }
 
                return size;
            };
 
        outWidth = CalcSize(inWidth, m_Param.m_PadLeft, m_Param.m_PadRight, m_Param.m_PoolWidth, m_Param.m_StrideX,
                            m_Param.m_OutputShapeRounding);
        outHeight = CalcSize(inHeight, m_Param.m_PadTop, m_Param.m_PadBottom, m_Param.m_PoolHeight, m_Param.m_StrideY,
                            m_Param.m_OutputShapeRounding);
        outDepth = CalcSize(inDepth, m_Param.m_PadFront, m_Param.m_PadBack, m_Param.m_PoolDepth, m_Param.m_StrideZ,
                            m_Param.m_OutputShapeRounding);
    }
    unsigned int outChannels = inChannels;
    unsigned int outBatchSize = inBatchSize;
 
    TensorShape tensorShape = m_Param.m_DataLayout == armnn::DataLayout::NDHWC ?
        TensorShape( { outBatchSize, outDepth, outHeight, outWidth, outChannels } ) :
        TensorShape( { outBatchSize, outChannels, outDepth, outHeight, outWidth });
 
    return std::vector<TensorShape>({ tensorShape });
}

References ARMNN_ASSERT, ARMNN_ASSERT_MSG, armnn::Ceiling, DataLayoutIndexed::GetChannelsIndex(), DataLayoutIndexed::GetDepthIndex(), DataLayoutIndexed::GetHeightIndex(), TensorShape::GetNumDimensions(), DataLayoutIndexed::GetWidthIndex(), Pooling3dDescriptor::m_DataLayout, Pooling3dDescriptor::m_OutputShapeRounding, Pooling3dDescriptor::m_PadBack, Pooling3dDescriptor::m_PadBottom, Pooling3dDescriptor::m_PadFront, Pooling3dDescriptor::m_PadLeft, Pooling3dDescriptor::m_PadRight, Pooling3dDescriptor::m_PadTop, LayerWithParameters< Pooling3dDescriptor >::m_Param, Pooling3dDescriptor::m_PoolDepth, Pooling3dDescriptor::m_PoolHeight, Pooling3dDescriptor::m_PoolWidth, Pooling3dDescriptor::m_StrideX, Pooling3dDescriptor::m_StrideY, Pooling3dDescriptor::m_StrideZ, and armnn::NDHWC.

Referenced by Pooling3dLayer::ValidateTensorShapesFromInputs().

ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

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

Parameters

[in]

shapeInferenceMethod

Indicates if output shape shall be overwritten or just validated.

Implements Layer.

Definition at line 109 of file Pooling3dLayer.cpp.

{
    VerifyLayerConnections(1, CHECK_LOCATION());
 
    const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
 
    VerifyShapeInferenceType(outputShape, m_ShapeInferenceMethod);
 
    auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape() });
 
    ARMNN_ASSERT(inferredShapes.size() == 1);
 
    ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "Pooling3dLayer");
}

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

---

The documentation for this class was generated from the following files:

• src/armnn/layers/Pooling3dLayer.hpp
• src/armnn/layers/Pooling3dLayer.cpp