A layer that the constant data can be bound to. More...

#include <ConstantLayer.hpp>

Inheritance diagram for ConstantLayer:

Collaboration diagram for ConstantLayer:

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

ConstantLayer *	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 ConstantLayer. 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	ReleaseConstantData () override
	Free up the constant source data stored by the layer. More...

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

void	SerializeLayerParameters (ParameterStringifyFunction &fn) const override
	Helper to serialize the layer parameters to string. 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

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_LayerOutput

Protected Member Functions
	ConstantLayer (const char *name)
	Constructor to create a ConstantLayer. More...

	~ConstantLayer ()=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 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 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 Layer
AdditionalInfoObjectPtr	m_AdditionalInfoObject

std::vector< OutputHandler >	m_OutputHandlers

ShapeInferenceMethod	m_ShapeInferenceMethod

Detailed Description

A layer that the constant data can be bound to.

Definition at line 15 of file ConstantLayer.hpp.

Constructor & Destructor Documentation

◆ ConstantLayer()

ConstantLayer ( const char * name )

protected

Constructor to create a ConstantLayer.

Parameters

[in] name Optional name for the layer.

Definition at line 16 of file ConstantLayer.cpp.

     : Layer(0, 1, LayerType::Constant, name)
 {
 }

References armnn::Constant.

◆ ~ConstantLayer()

~ConstantLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Clone()

ConstantLayer * 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 30 of file ConstantLayer.cpp.

 {
     // Cloned layers share the same layer output object.
     auto layer = CloneBase<ConstantLayer>(graph, GetName());
  
     layer->m_LayerOutput = m_LayerOutput ? m_LayerOutput : nullptr;
  
     return std::move(layer);
 }

References Layer::GetName(), and ConstantLayer::m_LayerOutput.

◆ CreateWorkload()

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

overridevirtual

Makes a workload for the Constant 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 ConstantLayer.cpp.

 {
     ConstantQueueDescriptor descriptor;
     descriptor.m_LayerOutput = m_LayerOutput.get();
     SetAdditionalInfo(descriptor);
  
     return factory.CreateWorkload(LayerType::Constant, descriptor, PrepInfoAndDesc(descriptor));
 }

References armnn::Constant, IWorkloadFactory::CreateWorkload(), ConstantLayer::m_LayerOutput, ConstantQueueDescriptor::m_LayerOutput, Layer::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

◆ ExecuteStrategy()

void ExecuteStrategy ( IStrategy & strategy ) const

overridevirtual

Apply a visitor to this layer.

Reimplemented from Layer.

Definition at line 65 of file ConstantLayer.cpp.

 {
     ManagedConstTensorHandle managedLayerOutput(m_LayerOutput);
     ConstTensor layerOutputTensor(managedLayerOutput.GetTensorInfo(), managedLayerOutput.Map());
     strategy.ExecuteStrategy(this, BaseDescriptor(), { layerOutputTensor }, GetName());
 }

References IStrategy::ExecuteStrategy(), Layer::GetName(), ManagedConstTensorHandle::GetTensorInfo(), ConstantLayer::m_LayerOutput, and ManagedConstTensorHandle::Map().

◆ GetConstantTensorsByRef()

ImmutableConstantTensors GetConstantTensorsByRef ( ) const

inlineoverrideprotectedvirtual

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

Reimplemented from Layer.

Definition at line 58 of file ConstantLayer.hpp.

58 { return {m_LayerOutput}; }

References ConstantLayer::m_LayerOutput.

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

 {
     return std::vector<TensorShape>({  inputShapes[0] });
 }

◆ ReleaseConstantData()

void ReleaseConstantData ( )

inlineoverridevirtual

Free up the constant source data stored by the layer.

Reimplemented from Layer.

Definition at line 40 of file ConstantLayer.hpp.

40 {}

◆ 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 72 of file ConstantLayer.cpp.

 {
     fn("DataType",GetDataTypeName(m_LayerOutput->GetTensorInfo().GetDataType()));
     Layer::SerializeLayerParameters(fn);
 }

References armnn::GetDataTypeName(), ConstantLayer::m_LayerOutput, and Layer::SerializeLayerParameters().

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

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

Parameters

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

Implements Layer.

Definition at line 45 of file ConstantLayer.cpp.

 {
  
     // Get the output shape from the value of the constant layer.
     TensorShape const& outShape = m_LayerOutput->GetTensorInfo().GetShape();
  
     ConditionalThrow<LayerValidationException>(
             outShape.GetDimensionality() != Dimensionality::NotSpecified,
             "Constant layer m_LayerOutput output shape can not be Dimensionality::NotSpecified");
  
     ConditionalThrow<LayerValidationException>(
             outShape.AreAllDimensionsSpecified(),
             "Constant layer m_LayerOutput output shape can not have an unspecified dimension");
  
     ConditionalThrowIfNotEqual<LayerValidationException>(
                "ConstantLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
                GetOutputSlot(0).GetTensorInfo().GetShape(),
                outShape);
 }

References TensorShape::AreAllDimensionsSpecified(), TensorShape::GetDimensionality(), Layer::GetOutputSlot(), armnn::GetTensorInfo(), ConstantLayer::m_LayerOutput, and armnn::NotSpecified.

Member Data Documentation

◆ m_LayerOutput

std::shared_ptr<ConstTensorHandle> m_LayerOutput

Definition at line 46 of file ConstantLayer.hpp.

Referenced by NetworkImpl::AddConstantLayer(), armnn::AttemptBackendAssignment(), armnn::BuildAddMulAddTensorInfoLists(), ConstantLayer::Clone(), ConstantLayer::CreateWorkload(), ConstantLayer::ExecuteStrategy(), ConstantLayer::GetConstantTensorsByRef(), FuseBatchNorm< ConvLayer, ArmnnType, T >::Run(), AddBroadcastReshapeLayerImpl::Run(), ConstantLayer::SerializeLayerParameters(), and ConstantLayer::ValidateTensorShapesFromInputs().

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

src/armnn/layers/ConstantLayer.hpp
src/armnn/layers/ConstantLayer.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConstantLayer()

◆ ~ConstantLayer()

Member Function Documentation

◆ Clone()

◆ CreateWorkload()

◆ ExecuteStrategy()

◆ GetConstantTensorsByRef()

◆ InferOutputShapes()

◆ ReleaseConstantData()

◆ SerializeLayerParameters()

◆ ValidateTensorShapesFromInputs()

Member Data Documentation

◆ m_LayerOutput