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

#include <BatchNormalizationLayer.hpp>

Inheritance diagram for BatchNormalizationLayer:

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

BatchNormalizationLayer *	Clone (Graph &graph) const override

void	ValidateTensorShapesFromInputs () override

void	Accept (ILayerVisitor &visitor) const override

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

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

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_Mean
	A unique pointer to store Mean values. More...

std::unique_ptr< ScopedCpuTensorHandle >	m_Variance
	A unique pointer to store Variance values. More...

std::unique_ptr< ScopedCpuTensorHandle >	m_Beta
	A unique pointer to store Beta values. More...

std::unique_ptr< ScopedCpuTensorHandle >	m_Gamma
	A unique pointer to store Gamma values. More...

Protected Member Functions
	BatchNormalizationLayer (const BatchNormalizationDescriptor &param, const char *name)

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

ConstantTensors	GetConstantTensorsByRef () override

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

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

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
std::vector< OutputHandler >	m_OutputHandlers

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.

References armnn::BatchNormalization.

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

◆ ~BatchNormalizationLayer()

~BatchNormalizationLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Accept()

void Accept ( ILayerVisitor & visitor ) const

overridevirtual

Implements IConnectableLayer.

Definition at line 71 of file BatchNormalizationLayer.cpp.

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

 {
     ConstTensor meanTensor(m_Mean->GetTensorInfo(), m_Mean->Map(true));
     ConstTensor varianceTensor(m_Variance->GetTensorInfo(), m_Variance->Map(true));
     ConstTensor betaTensor(m_Beta->GetTensorInfo(), m_Beta->Map(true));
     ConstTensor gammaTensor(m_Gamma->GetTensorInfo(), m_Gamma->Map(true));
     visitor.VisitBatchNormalizationLayer(
             this, GetParameters(), meanTensor, varianceTensor, betaTensor, gammaTensor, GetName());
 }

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

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

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

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

References IWorkloadFactory::CreateBatchNormalization(), BatchNormalizationLayer::m_Beta, BatchNormalizationQueueDescriptor::m_Beta, BatchNormalizationLayer::m_Gamma, BatchNormalizationQueueDescriptor::m_Gamma, BatchNormalizationLayer::m_Mean, BatchNormalizationQueueDescriptor::m_Mean, BatchNormalizationLayer::m_Variance, BatchNormalizationQueueDescriptor::m_Variance, and LayerWithParameters< BatchNormalizationDescriptor >::PrepInfoAndDesc().

 {
     // on this level constant data should not be released..
     BOOST_ASSERT_MSG(m_Mean != nullptr, "BatchNormalizationLayer: Mean data should not be null.");
     BOOST_ASSERT_MSG(m_Variance != nullptr, "BatchNormalizationLayer: Variance data should not be null.");
     BOOST_ASSERT_MSG(m_Beta != nullptr, "BatchNormalizationLayer: Beta data should not be null.");
     BOOST_ASSERT_MSG(m_Gamma != nullptr, "BatchNormalizationLayer: Gamma data should not be null.");
 
     BatchNormalizationQueueDescriptor 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.CreateBatchNormalization(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 66 of file BatchNormalizationLayer.cpp.

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

 {
     return {m_Mean, m_Variance, m_Beta, m_Gamma};
 }

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

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

Implements Layer.

Definition at line 51 of file BatchNormalizationLayer.cpp.

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

 {
     VerifyLayerConnections(1, CHECK_LOCATION());
 
     auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape() });
 
     BOOST_ASSERT(inferredShapes.size() == 1);
 
     ConditionalThrowIfNotEqual<LayerValidationException>(
         "BatchNormalizationLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
         GetOutputSlot(0).GetTensorInfo().GetShape(),
         inferredShapes[0]);
 
 }