This layer represents a split operation. More...

#include <SplitterLayer.hpp>

Inheritance diagram for SplitterLayer:

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

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

SplitterLayer *	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 SplitterLayer. 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	Accept (ILayerVisitor &visitor) const override
	Apply a visitor to this layer. More...

Public Member Functions inherited from LayerWithParameters< ViewsDescriptor >
const ViewsDescriptor &	GetParameters () const

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

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)

void	VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const

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)

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

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

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

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

template<typename LayerType , typename ... Params>
LayerType *	CloneBase (Graph &graph, Params &&... params) const

virtual ConstantTensors	GetConstantTensorsByRef ()

Protected Member Functions inherited from IConnectableLayer
	~IConnectableLayer ()
	Objects are not deletable via the handle. More...

Additional Inherited Members
Public Types inherited from LayerWithParameters< ViewsDescriptor >
using	DescriptorType = ViewsDescriptor

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

Protected Attributes inherited from LayerWithParameters< ViewsDescriptor >
ViewsDescriptor	m_Param
	The parameters for the layer (not including tensor-valued weights etc.). More...

Protected Attributes inherited from Layer
std::vector< OutputHandler >	m_OutputHandlers

ShapeInferenceMethod	m_ShapeInferenceMethod

Detailed Description

This layer represents a split operation.

Definition at line 13 of file SplitterLayer.hpp.

Constructor & Destructor Documentation

◆ SplitterLayer()

SplitterLayer	(	const ViewsDescriptor &	param,
		const char *	name
	)

protected

Constructor to create a SplitterLayer.

Parameters

[in]	param	ViewsDescriptor to configure the splitter operation.
[in]	name	Optional name for the layer.

Definition at line 16 of file SplitterLayer.cpp.

     : LayerWithParameters(1, param.GetNumViews(), LayerType::Splitter, param, name)
 {
 }

◆ ~SplitterLayer()

~SplitterLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Accept()

void Accept ( ILayerVisitor & visitor ) const

overridevirtual

Apply a visitor to this layer.

Implements IConnectableLayer.

Definition at line 242 of file SplitterLayer.cpp.

References Layer::GetName(), LayerWithParameters< ViewsDescriptor >::GetParameters(), and ILayerVisitor::VisitSplitterLayer().

 {
     visitor.VisitSplitterLayer(this, GetParameters(), GetName());
 }

◆ Clone()

SplitterLayer * 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 195 of file SplitterLayer.cpp.

References Layer::GetName(), and LayerWithParameters< ViewsDescriptor >::m_Param.

 {
     return CloneBase<SplitterLayer>(graph, m_Param, GetName());
 }

◆ CreateTensorHandles()

void CreateTensorHandles	(	const TensorHandleFactoryRegistry &	registry,
		const IWorkloadFactory &	factory,
		const bool	IsMemoryManaged = `true`
	)

overridevirtual

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

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 176 of file SplitterLayer.cpp.

References ARMNN_ASSERT, TensorHandleFactoryRegistry::GetFactory(), Layer::GetOutputSlot(), OutputSlot::GetTensorHandleFactoryId(), and ITensorHandleFactory::LegacyFactoryId.

 {
     OutputSlot& slot = GetOutputSlot(0);
     ITensorHandleFactory::FactoryId factoryId = slot.GetTensorHandleFactoryId();
 
     if (factoryId == ITensorHandleFactory::LegacyFactoryId)
     {
         CreateTensors(registry, workloadFactory, isMemoryManaged);
     }
     else
     {
         ITensorHandleFactory* handleFactory = registry.GetFactory(factoryId);
         ARMNN_ASSERT(handleFactory);
         CreateTensors(registry, *handleFactory, isMemoryManaged);
     }
 }

◆ CreateWorkload()

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

overridevirtual

Makes a workload for the Splitter 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 SplitterLayer.cpp.

References ARMNN_NO_DEPRECATE_WARN_BEGIN, ARMNN_NO_DEPRECATE_WARN_END, armnn::ComputeSplitAxis(), armnn::Constant, IWorkloadFactory::CreateSplitter(), ITensorHandleFactory::GetCapabilities(), OutputSlot::GetConnection(), OutputHandler::GetData(), TensorHandleFactoryRegistry::GetFactory(), Layer::GetInputSlots(), ViewsDescriptor::GetNumDimensions(), Layer::GetNumOutputSlots(), ViewsDescriptor::GetNumViews(), Layer::GetOutputSlot(), InputSlot::GetOwningLayer(), TensorInfo::GetShape(), OutputSlot::GetTensorHandleFactoryId(), OutputHandler::GetTensorInfo(), Layer::GetType(), ViewsDescriptor::GetViewOrigin(), ViewsDescriptor::GetViewSizes(), armnn::info, armnn::Input, TensorInfo::IsTypeSpaceMatch(), Layer::m_OutputHandlers, LayerWithParameters< ViewsDescriptor >::m_Param, SplitterQueueDescriptor::m_ViewOrigins, armnn::PaddingRequired, and LayerWithParameters< ViewsDescriptor >::PrepInfoAndDesc().

 {
     SplitterQueueDescriptor descriptor;
 
     // Copies the window origins to the descriptor.
     for (unsigned int i = 0; i < m_Param.GetNumViews(); ++i)
     {
         descriptor.m_ViewOrigins.emplace_back(
             std::vector<unsigned int>(m_Param.GetViewOrigin(i), m_Param.GetViewOrigin(i) + m_Param.GetNumDimensions()));
     }
 
     return factory.CreateSplitter(descriptor, PrepInfoAndDesc(descriptor));
 }

◆ 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 200 of file SplitterLayer.cpp.

References ARMNN_ASSERT, ViewsDescriptor::GetNumDimensions(), ViewsDescriptor::GetNumViews(), ViewsDescriptor::GetViewSizes(), armnn::IgnoreUnused(), and LayerWithParameters< ViewsDescriptor >::m_Param.

Referenced by SplitterLayer::ValidateTensorShapesFromInputs().

 {
     IgnoreUnused(inputShapes);
     ARMNN_ASSERT(inputShapes.size() ==  m_Param.GetNumViews());
     std::vector<TensorShape> outShapes;
     //Output shapes must match View shapes.
     for (unsigned int viewIdx = 0; viewIdx < m_Param.GetNumViews(); viewIdx++)
     {
         const uint32_t* sizes = m_Param.GetViewSizes(viewIdx);
         outShapes.push_back(TensorShape(m_Param.GetNumDimensions(), sizes));
     }
     return outShapes;
 }

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

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

Parameters

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

Implements Layer.

Definition at line 214 of file SplitterLayer.cpp.

References ARMNN_ASSERT, Layer::BeginOutputSlots(), Layer::EndOutputSlots(), ViewsDescriptor::GetNumDimensions(), ViewsDescriptor::GetNumViews(), Layer::GetOutputSlot(), TensorInfo::GetShape(), armnn::GetTensorInfo(), OutputSlot::GetTensorInfo(), ViewsDescriptor::GetViewSizes(), SplitterLayer::InferOutputShapes(), LayerWithParameters< ViewsDescriptor >::m_Param, Layer::m_ShapeInferenceMethod, Layer::ValidateAndCopyShape(), and Layer::VerifyShapeInferenceType().

 {
     std::for_each(BeginOutputSlots(), EndOutputSlots(), [&](OutputSlot& outputSlot)
     {
         VerifyShapeInferenceType(outputSlot.GetTensorInfo().GetShape(), m_ShapeInferenceMethod);
     });
 
     std::vector<TensorShape> views;
     for (unsigned int viewIdx = 0; viewIdx < m_Param.GetNumViews(); viewIdx++)
     {
         const uint32_t* sizes = m_Param.GetViewSizes(viewIdx);
         views.push_back(TensorShape(m_Param.GetNumDimensions(), sizes));
     }
 
     auto inferredShapes = InferOutputShapes(views);
 
     ARMNN_ASSERT(inferredShapes.size() == m_Param.GetNumViews());
 
     for (unsigned int viewIdx = 0; viewIdx < m_Param.GetNumViews(); viewIdx++)
     {
         ValidateAndCopyShape(GetOutputSlot(viewIdx).GetTensorInfo().GetShape(),
                              inferredShapes[viewIdx],
                              m_ShapeInferenceMethod,
                              "SplitterLayer",
                              viewIdx);
     }
 }

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

src/armnn/layers/SplitterLayer.hpp
src/armnn/layers/SplitterLayer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SplitterLayer()

◆ ~SplitterLayer()

Member Function Documentation

◆ Accept()

◆ Clone()

◆ CreateTensorHandles()

◆ CreateWorkload()

◆ InferOutputShapes()

◆ ValidateTensorShapesFromInputs()