A layer user-provided data can be bound to (e.g. inputs, outputs). More...

#include <OutputLayer.hpp>

Inheritance diagram for OutputLayer:

Collaboration diagram for OutputLayer:

Public Member Functions
virtual std::unique_ptr< IWorkload >	CreateWorkload (const IWorkloadFactory &factory) const override
	Returns nullptr for Output type.
virtual void	CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool isMemoryManaged=true) override
	Set the outputs to be appropriate sub tensors of the input if sub tensors are supported otherwise creates tensor handlers by default.
OutputLayer *	Clone (Graph &graph) const override
	Creates a dynamically-allocated copy of this layer.
void	ValidateTensorShapesFromInputs () override
	Check if the input tensor shape(s) will lead to a valid configuration of OutputLayer.
void	ExecuteStrategy (IStrategy &strategy) const override
	Apply a visitor to this layer.
Public Member Functions inherited from BindableLayer
	BindableLayer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name, LayerBindingId id)
LayerBindingId	GetBindingId () const
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.
DataType	GetDataType () const
const BackendId &	GetBackendId () const
void	SetBackendId (const BackendId &id) override
	Set the backend of the IConnectableLayer.
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)
virtual void	SerializeLayerParameters (ParameterStringifyFunction &fn) const
	Helper to serialize the layer parameters to string.
virtual void	ReleaseConstantData ()
template<typename Op>
void	OperateOnConstantTensors (Op op)
const char *	GetName () const override
	Returns the name of the layer.
unsigned int	GetNumInputSlots () const override
	Returns the number of connectable input slots.
unsigned int	GetNumOutputSlots () const override
	Returns the number of connectable output slots.
const InputSlot &	GetInputSlot (unsigned int index) const override
	Get a const input slot handle by slot index.
InputSlot &	GetInputSlot (unsigned int index) override
	Get the input slot handle by slot index.
const OutputSlot &	GetOutputSlot (unsigned int index=0) const override
	Get the const output slot handle by slot index.
OutputSlot &	GetOutputSlot (unsigned int index=0) override
	Get the output slot handle by slot index.
void	SetGuid (LayerGuid guid)
LayerGuid	GetGuid () const final
	Returns the unique id of the layer.
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.
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.

Protected Member Functions
	OutputLayer (LayerBindingId id, const char *name)
	Constructor to create an OutputLayer.
	~OutputLayer ()=default
	Default destructor.
Protected Member Functions inherited from BindableLayer
	~BindableLayer ()=default
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 *LayerCreateWorkload.
template<typename LayerType, typename ... Params>
LayerType *	CloneBase (Graph &graph, Params &&... params) const
virtual ConstantTensors	GetConstantTensorsByRef () override final
virtual ImmutableConstantTensors	GetConstantTensorsByRef () const override
void	SetAdditionalInfo (QueueDescriptor &descriptor) const
Protected Member Functions inherited from IConnectableLayer
	~IConnectableLayer ()
	Objects are not deletable via the handle.

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 user-provided data can be bound to (e.g. inputs, outputs).

Examples: SimpleSample.cpp.

Definition at line 13 of file OutputLayer.hpp.

Constructor & Destructor Documentation

◆ OutputLayer()

OutputLayer	(	LayerBindingId	id,
		const char *	name )

protected

Constructor to create an OutputLayer.

Parameters

id	The layer binding id number.
name	Optional name for the layer.

Definition at line 16 of file OutputLayer.cpp.

    : BindableLayer(1, 0, LayerType::Output, name, id)
{
}

References BindableLayer::BindableLayer(), and armnn::Output.

Referenced by Clone().

◆ ~OutputLayer()

~OutputLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Clone()

OutputLayer * 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 27 of file OutputLayer.cpp.

{
    return CloneBase<OutputLayer>(graph, GetBindingId(), GetName());
}

References Layer::CloneBase(), BindableLayer::GetBindingId(), Layer::GetName(), and OutputLayer().

◆ CreateTensorHandles()

virtual void CreateTensorHandles	(	const TensorHandleFactoryRegistry &	registry,
		const IWorkloadFactory &	factory,
		const bool	isMemoryManaged = true )

inlineoverridevirtual

Set the outputs to be appropriate sub tensors of the input if sub tensors are supported otherwise creates tensor handlers by default.

Ignores parameters for Output type.

Parameters

[in]	registry	Contains all the registered tensor handle factories available for use.
[in]	factory	The workload factory which will create the workload.
[in]	IsMemoryManaged	Determine whether or not to assign a memory manager during creation

Reimplemented from Layer.

Definition at line 27 of file OutputLayer.hpp.

    {
        IgnoreUnused(registry, factory, isMemoryManaged);
    }

References armnn::IgnoreUnused().

◆ CreateWorkload()

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

overridevirtual

Returns nullptr for Output 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 OutputLayer.cpp.

{
    IgnoreUnused(factory);
    return nullptr;
}

References armnn::IgnoreUnused().

◆ ExecuteStrategy()

void ExecuteStrategy ( IStrategy & strategy ) const

overridevirtual

Apply a visitor to this layer.

Reimplemented from BindableLayer.

Definition at line 40 of file OutputLayer.cpp.

{
    strategy.ExecuteStrategy(this, GetParameters(), {}, GetName(), GetBindingId());
}

References IStrategy::ExecuteStrategy(), BindableLayer::GetBindingId(), Layer::GetName(), and Layer::GetParameters().

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

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

Parameters

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

Implements Layer.

Definition at line 32 of file OutputLayer.cpp.

{
 
    // Just validates that the input is connected.
    ConditionalThrow<LayerValidationException>(GetInputSlot(0).GetConnection() != nullptr,
                                               "OutputLayer: Input slot must be connected.");
}

References armnn::ConditionalThrow(), and Layer::GetInputSlot().

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

src/armnn/layers/OutputLayer.hpp
src/armnn/layers/OutputLayer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutputLayer()

◆ ~OutputLayer()

Member Function Documentation

◆ Clone()

◆ CreateTensorHandles()

◆ CreateWorkload()

◆ ExecuteStrategy()

◆ ValidateTensorShapesFromInputs()