This layer represents a depthwise convolution 2d operation. More...

#include <DepthwiseConvolution2dLayer.hpp>

Inheritance diagram for DepthwiseConvolution2dLayer:

Public Member Functions
virtual std::unique_ptr< IWorkload >	CreateWorkload (const IWorkloadFactory &factory) const override

DepthwiseConvolution2dLayer *	Clone (Graph &graph) const override

void	ValidateTensorShapesFromInputs () override

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

void	Accept (ILayerVisitor &visitor) const override

void	SerializeLayerParameters (ParameterStringifyFunction &fn) const override

Public Member Functions inherited from LayerWithParameters< DepthwiseConvolution2dDescriptor >
const DepthwiseConvolution2dDescriptor &	GetParameters () const

void	SerializeLayerParameters (ParameterStringifyFunction &fn) const override

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)

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

DataType	GetDataType () const

const BackendId &	GetBackendId () const

void	SetBackendId (const BackendId &id)

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

unsigned int	GetNumInputSlots () const override

unsigned int	GetNumOutputSlots () const override

const InputSlot &	GetInputSlot (unsigned int index) const override

InputSlot &	GetInputSlot (unsigned int index) override

const OutputSlot &	GetOutputSlot (unsigned int index=0) const override

OutputSlot &	GetOutputSlot (unsigned int index=0) override

void	SetGuid (LayerGuid guid)

LayerGuid	GetGuid () const final

void	AddRelatedLayerName (const std::string layerName)

const std::list< std::string > &	GetRelatedLayerNames ()

virtual void	Reparent (Graph &dest, std::list< Layer *>::const_iterator iterator)=0

Public Attributes
std::unique_ptr< ScopedCpuTensorHandle >	m_Weight
	A unique pointer to store Weight values. More...

std::unique_ptr< ScopedCpuTensorHandle >	m_Bias
	A unique pointer to store Bias values. More...

Protected Member Functions
	DepthwiseConvolution2dLayer (const DepthwiseConvolution2dDescriptor &param, const char *name)

	~DepthwiseConvolution2dLayer ()=default
	Default destructor. More...

ConstantTensors	GetConstantTensorsByRef () override

Protected Member Functions inherited from LayerWithParameters< DepthwiseConvolution2dDescriptor >
	LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DepthwiseConvolution2dDescriptor &param, const char *name)

	~LayerWithParameters ()=default

WorkloadInfo	PrepInfoAndDesc (QueueDescriptor &descriptor) const
	Helper function to reduce duplication in *LayerCreateWorkload. More...

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

template<typename QueueDescriptor >
WorkloadInfo	PrepInfoAndDesc (QueueDescriptor &descriptor) const
	Helper function to reduce duplication in *LayerCreateWorkload. More...

template<typename LayerType , typename ... Params>
LayerType *	CloneBase (Graph &graph, Params &&... params) const

Protected Member Functions inherited from IConnectableLayer
	~IConnectableLayer ()
	Objects are not deletable via the handle. More...

Additional Inherited Members
Public Types inherited from LayerWithParameters< DepthwiseConvolution2dDescriptor >
using	DescriptorType = DepthwiseConvolution2dDescriptor

Protected Types inherited from Layer
using	ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>

Protected Attributes inherited from LayerWithParameters< DepthwiseConvolution2dDescriptor >
DepthwiseConvolution2dDescriptor	m_Param
	The parameters for the layer (not including tensor-valued weights etc.). More...

Protected Attributes inherited from Layer
std::vector< OutputHandler >	m_OutputHandlers

Detailed Description

This layer represents a depthwise convolution 2d operation.

Definition at line 15 of file DepthwiseConvolution2dLayer.hpp.

Constructor & Destructor Documentation

◆ DepthwiseConvolution2dLayer()

DepthwiseConvolution2dLayer	(	const DepthwiseConvolution2dDescriptor &	param,
		const char *	name
	)

protected

Constructor to create a DepthwiseConvolution2dLayer.

Parameters

[in]	param	DepthwiseConvolution2dDescriptor to configure the depthwise convolution2d.
[in]	name	Optional name for the layer.

Definition at line 23 of file DepthwiseConvolution2dLayer.cpp.

References armnn::DepthwiseConvolution2d.

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

◆ ~DepthwiseConvolution2dLayer()

~DepthwiseConvolution2dLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Accept()

void Accept ( ILayerVisitor & visitor ) const

overridevirtual

Implements IConnectableLayer.

Definition at line 147 of file DepthwiseConvolution2dLayer.cpp.

References Layer::GetName(), LayerWithParameters< DepthwiseConvolution2dDescriptor >::GetParameters(), DepthwiseConvolution2dLayer::m_Bias, DepthwiseConvolution2dLayer::m_Weight, and ILayerVisitor::VisitDepthwiseConvolution2dLayer().

 {
     ConstTensor weightsTensor(m_Weight->GetTensorInfo(), m_Weight->Map(true));
     Optional<ConstTensor> optionalBiasTensor = EmptyOptional();
 
     if (GetParameters().m_BiasEnabled)
     {
         ConstTensor biasTensor(m_Bias->GetTensorInfo(), m_Bias->Map(true));
         optionalBiasTensor = Optional<ConstTensor>(biasTensor);
     }
 
     visitor.VisitDepthwiseConvolution2dLayer(this, GetParameters(), weightsTensor, optionalBiasTensor, GetName());
 }

◆ Clone()

DepthwiseConvolution2dLayer * 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 68 of file DepthwiseConvolution2dLayer.cpp.

References Layer::GetName(), DepthwiseConvolution2dLayer::m_Bias, LayerWithParameters< DepthwiseConvolution2dDescriptor >::m_Param, and DepthwiseConvolution2dLayer::m_Weight.

 {
     auto layer      = CloneBase<DepthwiseConvolution2dLayer>(graph, m_Param, GetName());
     layer->m_Weight = m_Weight ? std::make_unique<ScopedCpuTensorHandle>(*m_Weight) : nullptr;
 
     if (layer->m_Param.m_BiasEnabled)
     {
         layer->m_Bias = m_Bias ? std::make_unique<ScopedCpuTensorHandle>(*m_Bias) : nullptr;
     }
 
     return std::move(layer);
 }

◆ CreateWorkload()

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

overridevirtual

Makes a workload for the DepthwiseConvolution2d 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 51 of file DepthwiseConvolution2dLayer.cpp.

References IWorkloadFactory::CreateDepthwiseConvolution2d(), DepthwiseConvolution2dLayer::m_Bias, DepthwiseConvolution2dQueueDescriptor::m_Bias, DepthwiseConvolution2dDescriptor::m_BiasEnabled, LayerWithParameters< DepthwiseConvolution2dDescriptor >::m_Param, DepthwiseConvolution2dLayer::m_Weight, DepthwiseConvolution2dQueueDescriptor::m_Weight, and LayerWithParameters< DepthwiseConvolution2dDescriptor >::PrepInfoAndDesc().

 {
     // on this level constant data should not be released..
     BOOST_ASSERT_MSG(m_Weight != nullptr, "DepthwiseConvolution2dLayer: Weights data should not be null.");
 
     DepthwiseConvolution2dQueueDescriptor descriptor;
 
     descriptor.m_Weight = m_Weight.get();
 
     if (m_Param.m_BiasEnabled)
     {
         BOOST_ASSERT_MSG(m_Bias != nullptr, "DepthwiseConvolution2dLayer: Bias data should not be null.");
         descriptor.m_Bias = m_Bias.get();
     }
     return factory.CreateDepthwiseConvolution2d(descriptor, PrepInfoAndDesc(descriptor));
 }

◆ GetConstantTensorsByRef()

Layer::ConstantTensors GetConstantTensorsByRef ( )

overrideprotectedvirtual

Retrieve the handles to the constant values stored by the layer.

Returns: A vector of the constant tensors stored by this layer.

Reimplemented from Layer.

Definition at line 142 of file DepthwiseConvolution2dLayer.cpp.

References DepthwiseConvolution2dLayer::m_Bias, and DepthwiseConvolution2dLayer::m_Weight.

 {
     return {m_Weight, m_Bias};
 }

◆ 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 82 of file DepthwiseConvolution2dLayer.cpp.

Referenced by DepthwiseConvolution2dInferOutputShapeTest(), and DepthwiseConvolution2dLayer::ValidateTensorShapesFromInputs().

 {
     BOOST_ASSERT(inputShapes.size() == 2);
     const TensorShape& inputShape  = inputShapes[0];
     const TensorShape& filterShape = inputShapes[1];
 
     BOOST_ASSERT_MSG(inputShape.GetNumDimensions() == 4, "Convolutions will always have 4D input.");
 
     DataLayoutIndexed dataLayoutIndex(m_Param.m_DataLayout);
 
     unsigned int inputBatchSize = inputShape[0];
     unsigned int inputHeight    = inputShape[dataLayoutIndex.GetHeightIndex()];
     unsigned int inputWidth     = inputShape[dataLayoutIndex.GetWidthIndex()];
     unsigned int inputChannels  = inputShape[dataLayoutIndex.GetChannelsIndex()];
 
     // Expected filter shape: [ M, I, H, W ] - This shape does NOT depend on the data layout
     // Namely: [ depth multiplier, input channels, filter height, filter width ]
     // Output channels = input channels * depthMultiplier
     unsigned int depthMultiplier = filterShape[0];
 
     unsigned int filterHeight = filterShape[2];
     unsigned int dilatedFilterHeight = filterHeight + (m_Param.m_DilationY - 1) * (filterHeight - 1);
     unsigned int readHeight   = (inputHeight + m_Param.m_PadTop + m_Param.m_PadBottom) - dilatedFilterHeight;
     unsigned int outputHeight = 1 + (readHeight / m_Param.m_StrideY);
 
     unsigned int filterWidth = filterShape[3];
     unsigned int dilatedFilterWidth = filterWidth + (m_Param.m_DilationX - 1) * (filterWidth - 1);
     unsigned int readWidth   = (inputWidth + m_Param.m_PadLeft + m_Param.m_PadRight) - dilatedFilterWidth;
     unsigned int outputWidth = 1 + (readWidth / m_Param.m_StrideX);
 
     unsigned int outputChannels  = inputChannels * depthMultiplier;
     unsigned int outputBatchSize = inputBatchSize;
 
     TensorShape tensorShape = m_Param.m_DataLayout == armnn::DataLayout::NHWC ?
                               TensorShape{ outputBatchSize, outputHeight, outputWidth, outputChannels } :
                               TensorShape{ outputBatchSize, outputChannels, outputHeight, outputWidth };
 
     return std::vector<TensorShape>{ tensorShape };
 }

◆ SerializeLayerParameters()

void SerializeLayerParameters ( ParameterStringifyFunction & fn ) const

overridevirtual

Helper to serialize the layer parameters to string. (currently used in DotSerializer and company).

Reimplemented from Layer.

Definition at line 29 of file DepthwiseConvolution2dLayer.cpp.

References InputSlot::GetConnection(), Layer::GetInputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), DepthwiseConvolution2dDescriptor::m_DataLayout, LayerWithParameters< DepthwiseConvolution2dDescriptor >::m_Param, DepthwiseConvolution2dLayer::m_Weight, and LayerWithParameters< Parameters >::SerializeLayerParameters().

 {
     const std::vector<TensorShape>& inputShapes =
     {
         GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape(),
         m_Weight->GetTensorInfo().GetShape()
     };
     const TensorShape filterShape = inputShapes[1];
     DataLayoutIndexed dataLayoutIndex(m_Param.m_DataLayout);
     unsigned int inputChannels = filterShape[1];
     unsigned int filterWidth = filterShape[3];
     unsigned int filterHeight = filterShape[2];
     unsigned int depthMultiplier = filterShape[0];
 
     fn("FilterWidth",std::to_string(filterWidth));
     fn("FilterHeight",std::to_string(filterHeight));
     fn("DepthMultiplier",std::to_string(depthMultiplier));
     fn("InputChannels",std::to_string(inputChannels));
 
     LayerWithParameters<DepthwiseConvolution2dDescriptor>::SerializeLayerParameters(fn);
 }

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

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

Implements Layer.

Definition at line 122 of file DepthwiseConvolution2dLayer.cpp.

References CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), DepthwiseConvolution2dLayer::InferOutputShapes(), DepthwiseConvolution2dLayer::m_Weight, and Layer::VerifyLayerConnections().

 {
     VerifyLayerConnections(1, CHECK_LOCATION());
 
     // on this level constant data should not be released..
     BOOST_ASSERT_MSG(m_Weight != nullptr, "DepthwiseConvolution2dLayer: Weights data should not be null.");
 
     auto inferredShapes = InferOutputShapes({
         GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape(),
         m_Weight->GetTensorInfo().GetShape()
      });
 
     BOOST_ASSERT(inferredShapes.size() == 1);
 
     ConditionalThrowIfNotEqual<LayerValidationException>(
         "DepthwiseConvolution2dLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
         GetOutputSlot(0).GetTensorInfo().GetShape(),
         inferredShapes[0]);
 }