This layer represents a batch normalization operation. More...

#include <BatchNormalizationLayer.hpp>

Inheritance diagram for BatchNormalizationLayer:

Collaboration diagram for BatchNormalizationLayer:

Public Member Functions
virtual std::unique_ptr< IWorkload >	CreateWorkload (const IWorkloadFactory &factory) const override
	Makes a workload for the BatchNormalization type. More...

BatchNormalizationLayer *	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 BatchNormalizationLayer. More...

void	ExecuteStrategy (IStrategy &strategy) const override
	Apply a visitor to this layer. More...

Public Member Functions inherited from LayerWithParameters< BatchNormalizationDescriptor >
const BatchNormalizationDescriptor &	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

std::vector< TensorShape >	InferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
	Infer the shape of the output(s) based on the provided input shape(s) More...

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...

Public Attributes
std::shared_ptr< ConstTensorHandle >	m_Mean
	A unique pointer to store Mean values. More...

std::shared_ptr< ConstTensorHandle >	m_Variance
	A unique pointer to store Variance values. More...

std::shared_ptr< ConstTensorHandle >	m_Beta
	A unique pointer to store Beta values. More...

std::shared_ptr< ConstTensorHandle >	m_Gamma
	A unique pointer to store Gamma values. More...

Protected Member Functions
	BatchNormalizationLayer (const BatchNormalizationDescriptor &param, const char *name)
	Constructor to create a BatchNormalizationLayer. More...

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

ImmutableConstantTensors	GetConstantTensorsByRef () const override
	Retrieve the handles to the constant values stored by the layer. More...

Protected Member Functions inherited from LayerWithParameters< BatchNormalizationDescriptor >
	LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const BatchNormalizationDescriptor &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

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< BatchNormalizationDescriptor >
using	DescriptorType = BatchNormalizationDescriptor

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< BatchNormalizationDescriptor >
BatchNormalizationDescriptor	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 batch normalization operation.

Definition at line 15 of file BatchNormalizationLayer.hpp.

Constructor & Destructor Documentation

◆ BatchNormalizationLayer()

BatchNormalizationLayer	(	const BatchNormalizationDescriptor &	param,
		const char *	name
	)

protected

Constructor to create a BatchNormalizationLayer.

Parameters

[in]	param	BatchNormalizationDescriptor to configure the batch normalization operation.
[in]	name	Optional name for the layer.

Definition at line 16 of file BatchNormalizationLayer.cpp.

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

References armnn::BatchNormalization.

◆ ~BatchNormalizationLayer()

~BatchNormalizationLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Clone()

BatchNormalizationLayer * 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 55 of file BatchNormalizationLayer.cpp.

 {
     auto layer = CloneBase<BatchNormalizationLayer>(graph, m_Param, GetName());
  
     layer->m_Mean = m_Mean ? m_Mean : nullptr;
     layer->m_Variance = m_Variance ? m_Variance : nullptr;
     layer->m_Beta = m_Beta ? m_Beta : nullptr;
     layer->m_Gamma = m_Gamma ? m_Gamma : nullptr;
  
     return std::move(layer);
 }

References Layer::GetName(), BatchNormalizationLayer::m_Beta, BatchNormalizationLayer::m_Gamma, BatchNormalizationLayer::m_Mean, LayerWithParameters< BatchNormalizationDescriptor >::m_Param, and BatchNormalizationLayer::m_Variance.

◆ CreateWorkload()

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

overridevirtual

Makes a workload for the BatchNormalization 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 21 of file BatchNormalizationLayer.cpp.

 {
     // on this level constant data should not be released..
     if (!m_Mean)
     {
         throw armnn::NullPointerException("BatchNormalizationLayer: Mean data should not be null.");
     }
  
     if (!m_Variance)
     {
         throw armnn::NullPointerException("BatchNormalizationLayer: Variance data should not be null.");
     }
  
     if (!m_Beta)
     {
         throw armnn::NullPointerException("BatchNormalizationLayer: Beta data should not be null.");
     }
  
     if (!m_Gamma)
     {
         throw armnn::NullPointerException("BatchNormalizationLayer: Gamma data should not be null.");
     }
  
     BatchNormalizationQueueDescriptor descriptor;
     SetAdditionalInfo(descriptor);
  
     descriptor.m_Mean = m_Mean.get();
     descriptor.m_Variance = m_Variance.get();
     descriptor.m_Beta = m_Beta.get();
     descriptor.m_Gamma = m_Gamma.get();
  
     return factory.CreateWorkload(LayerType::BatchNormalization, descriptor, PrepInfoAndDesc(descriptor));
 }

References armnn::BatchNormalization, IWorkloadFactory::CreateWorkload(), BatchNormalizationLayer::m_Beta, BatchNormalizationQueueDescriptor::m_Beta, BatchNormalizationLayer::m_Gamma, BatchNormalizationQueueDescriptor::m_Gamma, BatchNormalizationLayer::m_Mean, BatchNormalizationQueueDescriptor::m_Mean, BatchNormalizationLayer::m_Variance, BatchNormalizationQueueDescriptor::m_Variance, LayerWithParameters< BatchNormalizationDescriptor >::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

◆ ExecuteStrategy()

void ExecuteStrategy ( IStrategy & strategy ) const

overridevirtual

Apply a visitor to this layer.

Reimplemented from Layer.

Definition at line 94 of file BatchNormalizationLayer.cpp.

 {
     ManagedConstTensorHandle managedMean(m_Mean);
     ManagedConstTensorHandle managedVariance(m_Variance);
     ManagedConstTensorHandle managedBeta(m_Beta);
     ManagedConstTensorHandle managedGamma(m_Gamma);
  
     std::vector<armnn::ConstTensor> constTensors { { managedMean.GetTensorInfo(), managedMean.Map() },
                                                    { managedVariance.GetTensorInfo(), managedVariance.Map() },
                                                    { managedBeta.GetTensorInfo(), managedBeta.Map() },
                                                    { managedGamma.GetTensorInfo(), managedGamma.Map() } };
  
     strategy.ExecuteStrategy(this, GetParameters(), constTensors, GetName());
 }

References IStrategy::ExecuteStrategy(), Layer::GetName(), LayerWithParameters< BatchNormalizationDescriptor >::GetParameters(), ManagedConstTensorHandle::GetTensorInfo(), BatchNormalizationLayer::m_Beta, BatchNormalizationLayer::m_Gamma, BatchNormalizationLayer::m_Mean, BatchNormalizationLayer::m_Variance, and ManagedConstTensorHandle::Map().

◆ GetConstantTensorsByRef()

Layer::ImmutableConstantTensors GetConstantTensorsByRef ( ) const

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 88 of file BatchNormalizationLayer.cpp.

 {
     // For API stability DO NOT ALTER order and add new members to the end of vector
     return {m_Mean, m_Variance, m_Beta, m_Gamma};
 }

References BatchNormalizationLayer::m_Beta, BatchNormalizationLayer::m_Gamma, BatchNormalizationLayer::m_Mean, and BatchNormalizationLayer::m_Variance.

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

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

Parameters

[in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.

Implements Layer.

Definition at line 67 of file BatchNormalizationLayer.cpp.

 {
     VerifyLayerConnections(1, CHECK_LOCATION());
  
     const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
  
     VerifyShapeInferenceType(outputShape, m_ShapeInferenceMethod);
  
     auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetTensorInfo().GetShape() });
  
     if (inferredShapes.size() != 1)
     {
         throw armnn::LayerValidationException("inferredShapes has "
                                               + std::to_string(inferredShapes.size()) +
                                               " elements - should only have 1.");
     }
  
     ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "BatchNormalizationLayer");
  
 }