ArmNN
 24.08
ConstantLayer Class Reference

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

#include <ConstantLayer.hpp>

Inheritance diagram for ConstantLayer:
[legend]
Collaboration diagram for ConstantLayer:
[legend]

Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the Constant type. More...
 
ConstantLayerClone (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< TensorShapeInferOutputShapes (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 OutputHandlerGetOutputHandler (unsigned int i=0) const
 
OutputHandlerGetOutputHandler (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 BackendIdGetBackendId () 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 InputSlotGetInputSlot (unsigned int index) const override
 Get a const input slot handle by slot index. More...
 
InputSlotGetInputSlot (unsigned int index) override
 Get the input slot handle by slot index. More...
 
const OutputSlotGetOutputSlot (unsigned int index=0) const override
 Get the const output slot handle by slot index. More...
 
OutputSlotGetOutputSlot (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< BackendIdGetBackendHint () 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 BaseDescriptorGetParameters () const override
 If the layer has a descriptor return it. More...
 

Public Attributes

std::shared_ptr< ConstTensorHandlem_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>
LayerTypeCloneBase (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< OutputHandlerm_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]nameOptional name for the layer.

Definition at line 16 of file ConstantLayer.cpp.

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

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]graphThe graph into which this layer is being cloned.

Implements Layer.

Definition at line 30 of file ConstantLayer.cpp.

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

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]graphThe graph where this layer can be found.
[in]factoryThe 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.

22 {
23  ConstantQueueDescriptor descriptor;
24  descriptor.m_LayerOutput = m_LayerOutput.get();
25  SetAdditionalInfo(descriptor);
26 
27  return factory.CreateWorkload(LayerType::Constant, descriptor, PrepInfoAndDesc(descriptor));
28 }

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.

66 {
67  ManagedConstTensorHandle managedLayerOutput(m_LayerOutput);
68  ConstTensor layerOutputTensor(managedLayerOutput.GetTensorInfo(), managedLayerOutput.Map());
69  strategy.ExecuteStrategy(this, BaseDescriptor(), { layerOutputTensor }, GetName());
70 }

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]inputShapesThe input shapes layer has.
Returns
a vector to the inferred output shape.

Reimplemented from Layer.

Definition at line 40 of file ConstantLayer.cpp.

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

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

73 {
74  fn("DataType",GetDataTypeName(m_LayerOutput->GetTensorInfo().GetDataType()));
76 }

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]shapeInferenceMethodIndicates if output shape shall be overwritten or just validated.

Implements Layer.

Definition at line 45 of file ConstantLayer.cpp.

46 {
47 
48  // Get the output shape from the value of the constant layer.
49  TensorShape const& outShape = m_LayerOutput->GetTensorInfo().GetShape();
50 
51  ConditionalThrow<LayerValidationException>(
52  outShape.GetDimensionality() != Dimensionality::NotSpecified,
53  "Constant layer m_LayerOutput output shape can not be Dimensionality::NotSpecified");
54 
55  ConditionalThrow<LayerValidationException>(
56  outShape.AreAllDimensionsSpecified(),
57  "Constant layer m_LayerOutput output shape can not have an unspecified dimension");
58 
59  ConditionalThrowIfNotEqual<LayerValidationException>(
60  "ConstantLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
61  GetOutputSlot(0).GetTensorInfo().GetShape(),
62  outShape);
63 }

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

Member Data Documentation

◆ m_LayerOutput


The documentation for this class was generated from the following files:
armnn::GetDataTypeName
constexpr const char * GetDataTypeName(DataType dataType)
Definition: TypesUtils.hpp:233
armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:339
armnn::Layer::Layer
Layer(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
Definition: Layer.cpp:260
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:332
armnn::Layer::SerializeLayerParameters
virtual void SerializeLayerParameters(ParameterStringifyFunction &fn) const
Helper to serialize the layer parameters to string.
Definition: Layer.cpp:540
armnn::Layer::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: Layer.hpp:409
armnn::GetTensorInfo
const TensorInfo & GetTensorInfo(const ITensorHandle *tensorHandle)
float32 helpers
Definition: RefWorkloadUtils.hpp:33
armnn::Layer::SetAdditionalInfo
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:303
armnn::Dimensionality::NotSpecified
@ NotSpecified
armnn::ConstantLayer::m_LayerOutput
std::shared_ptr< ConstTensorHandle > m_LayerOutput
Definition: ConstantLayer.hpp:46
armnn::LayerType::Constant
@ Constant