ArmNN
 24.08
SplitterLayer Class Reference

This layer represents a split operation. More...

#include <SplitterLayer.hpp>

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

Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (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...
 
SplitterLayerClone (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< 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 ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< ViewsDescriptor >
const ViewsDescriptorGetParameters () const override
 If the layer has a descriptor return it. More...
 
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 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...
 
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 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...
 

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 *Layer::CreateWorkload. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
Layer::ImmutableConstantTensors GetConnectedConstantAsInputTensors () const
 
- 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
 
virtual ImmutableConstantTensors GetConstantTensorsByRef () const override
 
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 LayerWithParameters< ViewsDescriptor >
using DescriptorType = ViewsDescriptor
 
- 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 LayerWithParameters< ViewsDescriptor >
ViewsDescriptor m_Param
 The parameters for the layer (not including tensor-valued weights etc.). More...
 
- Protected Attributes inherited from Layer
AdditionalInfoObjectPtr m_AdditionalInfoObject
 
std::vector< OutputHandlerm_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]paramViewsDescriptor to configure the splitter operation.
[in]nameOptional name for the layer.

Definition at line 17 of file SplitterLayer.cpp.

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

◆ ~SplitterLayer()

~SplitterLayer ( )
protecteddefault

Default destructor.

Member Function Documentation

◆ Clone()

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

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

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

◆ 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]registryContains all the registered tensor handle factories available for use.
[in]factoryThe workload factory which will create the workload.
[in]IsMemoryManagedDetermine whether or not to assign a memory manager during creation

Reimplemented from Layer.

Definition at line 158 of file SplitterLayer.cpp.

161 {
162  OutputSlot& slot = GetOutputSlot(0);
163  ITensorHandleFactory::FactoryId factoryId = slot.GetTensorHandleFactoryId();
164 
165  if (factoryId == ITensorHandleFactory::LegacyFactoryId)
166  {
167  CreateTensors(registry, workloadFactory, isMemoryManaged);
168  }
169  else
170  {
171  ITensorHandleFactory* handleFactory = registry.GetFactory(factoryId);
172  if (!handleFactory)
173  {
174  throw armnn::NullPointerException("handleFactory is returning a nullptr.");
175  }
176  CreateTensors(registry, *handleFactory, isMemoryManaged);
177  }
178 }

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

◆ CreateWorkload()

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

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

23 {
24  SplitterQueueDescriptor descriptor;
25 
26  // Copies the window origins to the descriptor.
27  for (unsigned int i = 0; i < m_Param.GetNumViews(); ++i)
28  {
29  descriptor.m_ViewOrigins.emplace_back(
30  std::vector<unsigned int>(m_Param.GetViewOrigin(i), m_Param.GetViewOrigin(i) + m_Param.GetNumDimensions()));
31  }
32 
33  SetAdditionalInfo(descriptor);
34 
35  return factory.CreateWorkload(LayerType::Splitter, descriptor, PrepInfoAndDesc(descriptor));
36 }

References IWorkloadFactory::CreateWorkload(), ViewsDescriptor::GetNumDimensions(), ViewsDescriptor::GetNumViews(), ViewsDescriptor::GetViewOrigin(), LayerWithParameters< ViewsDescriptor >::m_Param, SplitterQueueDescriptor::m_ViewOrigins, LayerWithParameters< ViewsDescriptor >::PrepInfoAndDesc(), Layer::SetAdditionalInfo(), and armnn::Splitter.

◆ ExecuteStrategy()

void ExecuteStrategy ( IStrategy strategy) const
overridevirtual

Apply a visitor to this layer.

Reimplemented from Layer.

Definition at line 239 of file SplitterLayer.cpp.

240 {
241  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
242 }

References IStrategy::ExecuteStrategy(), Layer::GetName(), and LayerWithParameters< ViewsDescriptor >::GetParameters().

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

186 {
187  if (inputShapes.size() != m_Param.GetNumViews())
188  {
189  throw armnn::Exception("inputShapes' and m_NumViews' sizes do not match (\""
190  + std::to_string(inputShapes.size()) +
191  "\" vs \""
192  + std::to_string(m_Param.GetNumViews()) + "\")");
193  }
194 
195  std::vector<TensorShape> outShapes;
196  //Output shapes must match View shapes.
197  for (unsigned int viewIdx = 0; viewIdx < m_Param.GetNumViews(); viewIdx++)
198  {
199  const uint32_t* sizes = m_Param.GetViewSizes(viewIdx);
200  outShapes.push_back(TensorShape(m_Param.GetNumDimensions(), sizes));
201  }
202  return outShapes;
203 }

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

Referenced by SplitterLayer::ValidateTensorShapesFromInputs().

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )
overridevirtual

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

Parameters
[in]shapeInferenceMethodIndicates if output shape shall be overwritten or just validated.

Implements Layer.

Definition at line 205 of file SplitterLayer.cpp.

206 {
207  std::for_each(BeginOutputSlots(), EndOutputSlots(), [&](OutputSlot& outputSlot)
208  {
209  VerifyShapeInferenceType(outputSlot.GetTensorInfo().GetShape(), m_ShapeInferenceMethod);
210  });
211 
212  std::vector<TensorShape> views;
213  for (unsigned int viewIdx = 0; viewIdx < m_Param.GetNumViews(); viewIdx++)
214  {
215  const uint32_t* sizes = m_Param.GetViewSizes(viewIdx);
216  views.push_back(TensorShape(m_Param.GetNumDimensions(), sizes));
217  }
218 
219  auto inferredShapes = InferOutputShapes(views);
220 
221  if (inferredShapes.size() != m_Param.GetNumViews())
222  {
223  throw armnn::LayerValidationException("inferredShapes' size and m_NumViews do not match (\""
224  + std::to_string(inferredShapes.size()) +
225  "\" vs \""
226  + std::to_string(m_Param.GetNumViews()) + "\")");
227  }
228 
229  for (unsigned int viewIdx = 0; viewIdx < m_Param.GetNumViews(); viewIdx++)
230  {
231  ValidateAndCopyShape(GetOutputSlot(viewIdx).GetTensorInfo().GetShape(),
232  inferredShapes[viewIdx],
234  "SplitterLayer",
235  viewIdx);
236  }
237 }

References 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().


The documentation for this class was generated from the following files:
armnn::LayerType::Splitter
@ Splitter
armnn::Layer::ValidateAndCopyShape
void ValidateAndCopyShape(const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)
Definition: Layer.cpp:457
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::LayerWithParameters< ViewsDescriptor >::GetParameters
const ViewsDescriptor & GetParameters() const override
Definition: LayerWithParameters.hpp:19
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:332
armnn::ITensorHandleFactory::LegacyFactoryId
static const FactoryId LegacyFactoryId
Definition: ITensorHandleFactory.hpp:50
armnn::ViewsDescriptor::GetViewSizes
const uint32_t * GetViewSizes(uint32_t idx) const
Get the view sizes at the int value idx.
Definition: Descriptors.cpp:347
armnn::LayerWithParameters< ViewsDescriptor >::m_Param
ViewsDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
armnn::LayerWithParameters< ViewsDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: LayerWithParameters.hpp:44
armnn::LayerValidationException
Definition: Exceptions.hpp:105
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:526
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::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
armnn::SplitterLayer::InferOutputShapes
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,...
Definition: SplitterLayer.cpp:185
armnn::Layer::BeginOutputSlots
std::vector< OutputSlot >::iterator BeginOutputSlots()
Definition: Layer.hpp:266
armnn::ViewsDescriptor::GetNumDimensions
uint32_t GetNumDimensions() const
Get the number of dimensions.
Definition: Descriptors.cpp:307
armnn::ViewsDescriptor::GetNumViews
uint32_t GetNumViews() const
Get the number of views.
Definition: Descriptors.cpp:302
armnn::ITensorHandleFactory::FactoryId
std::string FactoryId
Definition: ITensorHandleFactory.hpp:49
armnn::LayerWithParameters< ViewsDescriptor >::LayerWithParameters
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const ViewsDescriptor &param, const char *name)
Definition: LayerWithParameters.hpp:30
armnn::NullPointerException
Definition: Exceptions.hpp:146
armnn::Layer::m_ShapeInferenceMethod
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:441
armnn::Layer::EndOutputSlots
std::vector< OutputSlot >::iterator EndOutputSlots()
Definition: Layer.hpp:267
armnn::ViewsDescriptor::GetViewOrigin
const uint32_t * GetViewOrigin(uint32_t idx) const
Get the view origin at the int value idx.
Definition: Descriptors.cpp:312