ArmNN  NotReleased
MeanLayer Class Reference

This layer represents a mean operation. More...

#include <MeanLayer.hpp>

Inheritance diagram for MeanLayer:
LayerWithParameters< MeanDescriptor > Layer IConnectableLayer

Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 
MeanLayerClone (Graph &graph) const override
 
void ValidateTensorShapesFromInputs () override
 
void Accept (ILayerVisitor &visitor) const override
 
- Public Member Functions inherited from LayerWithParameters< MeanDescriptor >
const MeanDescriptorGetParameters () const
 
void SerializeLayerParameters (ParameterStringifyFunction &fn) const override
 
- 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)
 
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 BackendIdGetBackendId () const
 
void SetBackendId (const BackendId &id)
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
void VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const
 
std::vector< TensorShapeInferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 
virtual void ReleaseConstantData ()
 
template<typename Op >
void OperateOnConstantTensors (Op op)
 
const char * GetName () const override
 
unsigned int GetNumInputSlots () const override
 
unsigned int GetNumOutputSlots () const override
 
const InputSlotGetInputSlot (unsigned int index) const override
 
InputSlotGetInputSlot (unsigned int index) override
 
const OutputSlotGetOutputSlot (unsigned int index=0) const override
 
OutputSlotGetOutputSlot (unsigned int index=0) override
 
void SetGuid (LayerGuid guid)
 
LayerGuid GetGuid () const final
 
void AddRelatedLayerName (const std::string layerName)
 
const std::list< std::string > & GetRelatedLayerNames ()
 
virtual void Reparent (Graph &dest, std::list< Layer *>::const_iterator iterator)=0
 

Protected Member Functions

 MeanLayer (const MeanDescriptor &param, const char *name)
 
 ~MeanLayer ()=default
 Default destructor. More...
 
- Protected Member Functions inherited from LayerWithParameters< MeanDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const MeanDescriptor &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
 
template<typename QueueDescriptor >
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *LayerCreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerTypeCloneBase (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< MeanDescriptor >
using DescriptorType = MeanDescriptor
 
- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from LayerWithParameters< MeanDescriptor >
MeanDescriptor m_Param
 The parameters for the layer (not including tensor-valued weights etc.). More...
 
- Protected Attributes inherited from Layer
std::vector< OutputHandlerm_OutputHandlers
 

Detailed Description

This layer represents a mean operation.

Definition at line 14 of file MeanLayer.hpp.

Constructor & Destructor Documentation

◆ MeanLayer()

MeanLayer ( const MeanDescriptor param,
const char *  name 
)
protected

Constructor to create a MeanLayer.

Parameters
[in]paramMeanDescriptor to configure the mean operation.
[in]nameOptional name for the layer.

Definition at line 18 of file MeanLayer.cpp.

19  : LayerWithParameters(1, 1, LayerType::Mean, param, name)
20 {}
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const MeanDescriptor &param, const char *name)

◆ ~MeanLayer()

~MeanLayer ( )
protecteddefault

Default destructor.

Member Function Documentation

◆ Accept()

void Accept ( ILayerVisitor visitor) const
overridevirtual

Implements IConnectableLayer.

Definition at line 102 of file MeanLayer.cpp.

References Layer::GetName(), LayerWithParameters< MeanDescriptor >::GetParameters(), and ILayerVisitor::VisitMeanLayer().

103 {
104  visitor.VisitMeanLayer(this, GetParameters(), GetName());
105 }
const char * GetName() const override
Definition: Layer.hpp:305

◆ Clone()

MeanLayer * 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 31 of file MeanLayer.cpp.

References Layer::GetName(), MeanDescriptor::m_Axis, LayerWithParameters< Parameters >::m_Param, and LayerWithParameters< MeanDescriptor >::m_Param.

32 {
33  auto layer = CloneBase<MeanLayer>(graph, m_Param, GetName());
34 
35  layer->m_Param.m_Axis = m_Param.m_Axis;
36  layer->m_Param.m_KeepDims = m_Param.m_KeepDims;
37 
38  return std::move(layer);
39 }
const char * GetName() const override
Definition: Layer.hpp:305
MeanDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).

◆ CreateWorkload()

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

Makes a workload for the Mean 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 MeanLayer.cpp.

References IWorkloadFactory::CreateMean(), MeanDescriptor::m_Axis, MeanDescriptor::m_KeepDims, LayerWithParameters< MeanDescriptor >::m_Param, QueueDescriptorWithParameters< LayerDescriptor >::m_Parameters, and LayerWithParameters< MeanDescriptor >::PrepInfoAndDesc().

23 {
24  MeanQueueDescriptor descriptor;
25  descriptor.m_Parameters.m_Axis = m_Param.m_Axis;
26  descriptor.m_Parameters.m_KeepDims = m_Param.m_KeepDims;
27 
28  return factory.CreateMean(descriptor, PrepInfoAndDesc(descriptor));
29 }
std::vector< unsigned int > m_Axis
Values for the dimensions to reduce.
bool m_KeepDims
Enable/disable keep dimensions. If true, then the reduced dimensions that are of length 1 are kept...
MeanDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *LayerCreateWorkload.

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )
overridevirtual

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

Implements Layer.

Definition at line 41 of file MeanLayer.cpp.

References CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), TensorInfo::GetNumDimensions(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), MeanDescriptor::m_Axis, MeanDescriptor::m_KeepDims, LayerWithParameters< MeanDescriptor >::m_Param, and Layer::VerifyLayerConnections().

42 {
44 
45  const TensorInfo& input = GetInputSlot(0).GetConnection()->GetTensorInfo();
46 
47  BOOST_ASSERT_MSG(input.GetNumDimensions() > 0 && input.GetNumDimensions() <= 4,
48  "MeanLayer: Mean supports up to 4D input.");
49 
50  unsigned int rank = input.GetNumDimensions();
51  unsigned int outputRank = 0;
52 
53  // Calculate output dimension
54  if (m_Param.m_KeepDims)
55  {
56  outputRank = rank;
57  }
58  else if (m_Param.m_Axis.empty())
59  {
60  outputRank = 1;
61  }
62  else if (m_Param.m_Axis.size() >= input.GetNumDimensions())
63  {
64  throw LayerValidationException("MeanLayer: Dimensions to reduce can not be bigger than input dimensions");
65  }
66  else
67  {
68  outputRank = input.GetNumDimensions() - boost::numeric_cast<unsigned int>(m_Param.m_Axis.size());
69  if (outputRank == 0)
70  {
71  outputRank = 1;
72  }
73  }
74 
75  std::vector<unsigned int> dimSizes(outputRank, 1);
76  if (!m_Param.m_Axis.empty())
77  {
78  // Skip the dimension that has been reduced unless keepDims is true.
79  unsigned int outputIndex = 0;
80  for (unsigned int i = 0; i < input.GetNumDimensions(); ++i)
81  {
82  if (std::find(m_Param.m_Axis.begin(), m_Param.m_Axis.end(), i) == m_Param.m_Axis.end())
83  {
84  dimSizes[outputIndex] = boost::numeric_cast<unsigned int>(input.GetShape()[i]);
85  ++outputIndex;
86  }
87  else if (m_Param.m_KeepDims)
88  {
89  dimSizes[outputIndex] = 1;
90  ++outputIndex;
91  }
92  }
93  }
94  const TensorShape& inferredShape = TensorShape(outputRank, dimSizes.data());
95 
96  ConditionalThrowIfNotEqual<LayerValidationException>(
97  "MeanLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
99  inferredShape);
100 }
virtual const TensorInfo & GetTensorInfo() const =0
unsigned int GetNumDimensions() const
Definition: Tensor.hpp:92
std::vector< unsigned int > m_Axis
Values for the dimensions to reduce.
bool m_KeepDims
Enable/disable keep dimensions. If true, then the reduced dimensions that are of length 1 are kept...
#define CHECK_LOCATION()
Definition: Exceptions.hpp:169
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:199
MeanDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:337
const TensorShape & GetShape() const
Definition: Tensor.hpp:88
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Definition: Layer.hpp:312
const InputSlot & GetInputSlot(unsigned int index) const override
Definition: Layer.hpp:310

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