From 4840dfb7543d66652dc11c5ff39c8f5c1e2f9370 Mon Sep 17 00:00:00 2001 From: Ryan OShea Date: Tue, 25 Aug 2020 12:35:58 +0100 Subject: Updating Doxygen Documentation for 20.08 release Signed-off-by: Ryan OShea Change-Id: I605409f8720de5353feceb161b39f8a5f0598180 --- 20.08/classarmnn_1_1_merge_layer.xhtml | 579 +++++++++++++++++++++++++++++++++ 1 file changed, 579 insertions(+) create mode 100644 20.08/classarmnn_1_1_merge_layer.xhtml (limited to '20.08/classarmnn_1_1_merge_layer.xhtml') diff --git a/20.08/classarmnn_1_1_merge_layer.xhtml b/20.08/classarmnn_1_1_merge_layer.xhtml new file mode 100644 index 0000000000..c106229715 --- /dev/null +++ b/20.08/classarmnn_1_1_merge_layer.xhtml @@ -0,0 +1,579 @@ + + + + + + + + + + + + + +ArmNN: MergeLayer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  20.08 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
MergeLayer Class Reference
+
+
+ +

This layer dequantizes the input tensor. + More...

+ +

#include <MergeLayer.hpp>

+
+Inheritance diagram for MergeLayer:
+
+
+ + +Layer +IConnectableLayer + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual std::unique_ptr< IWorkload > CreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the Merge type. More...
 
MergeLayer * 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 MergeLayer. More...
 
std::vector< TensorShape > InferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 Infers the output shapes from given input shapes. More...
 
void Accept (ILayerVisitor &visitor) const override
 Apply a visitor to this layer. 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)
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
void VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const
 
virtual void SerializeLayerParameters (ParameterStringifyFunction &fn) const
 Helper to serialize the layer parameters to string. More...
 
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

 MergeLayer (const char *name)
 Constructor to create a MergeLayer. More...
 
 ~MergeLayer ()=default
 Default destructor. 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

- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from Layer
std::vector< OutputHandler > m_OutputHandlers
 
ShapeInferenceMethod m_ShapeInferenceMethod
 
+

Detailed Description

+

This layer dequantizes the input tensor.

+ +

Definition at line 13 of file MergeLayer.hpp.

+

Constructor & Destructor Documentation

+ +

◆ MergeLayer()

+ +
+
+ + + + + +
+ + + + + + + + +
MergeLayer (const char * name)
+ 		+protected
+
+ +

Constructor to create a MergeLayer.

+
Parameters
+ + +
[in]nameOptional name for the layer.
+
+
+ +

Definition at line 15 of file MergeLayer.cpp.

+ +

References armnn::Merge.

+
16  : Layer(2, 1, LayerType::Merge, name)
17 {}
+
armnn::Layer::Layer
Layer(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
Definition: Layer.cpp:219
+
+
+
+ +

◆ ~MergeLayer()

+ +
+
+ + + + + +
+ + + + + + + +
~MergeLayer ()
+ 		+protecteddefault
+
+ +

Default destructor.

+ +
+
+

Member Function Documentation

+ +

◆ Accept()

+ +
+
+ + + + + +
+ + + + + + + + +
void Accept (ILayerVisitor & visitor) const
+ 		+overridevirtual
+
+ +

Apply a visitor to this layer.

+ +

Implements IConnectableLayer.

+ +

Definition at line 61 of file MergeLayer.cpp.

+ +

References Layer::GetName(), and ILayerVisitor::VisitMergeLayer().

+
62 {
63  visitor.VisitMergeLayer(this, GetName());
64 }
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:307
+
+
+
+ +

◆ Clone()

+ +
+
+ + + + + +
+ + + + + + + + +
MergeLayer * 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 25 of file MergeLayer.cpp.

+ +

References Layer::GetName().

+
26 {
27  return CloneBase<MergeLayer>(graph, GetName());
28 }
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:307
+
+
+
+ +

◆ CreateWorkload()

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

Makes a workload for the Merge 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 19 of file MergeLayer.cpp.

+ +

References armnn::IgnoreUnused().

+
20 {
21  IgnoreUnused(factory);
22  return nullptr;
23 }
armnn::IgnoreUnused
void IgnoreUnused(Ts &&...)
Definition: IgnoreUnused.hpp:14
+
+
+
+ +

◆ InferOutputShapes()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< TensorShape > InferOutputShapes (const std::vector< TensorShape > & inputShapes) const
+ 		+overridevirtual
+
+ +

Infers the output shapes from given input shapes.

+
Parameters
+ + +
[in]inputShapesThe input shapes layer has.
+
+
+
Returns
A vector to the inferred output shape.
+ +

Reimplemented from Layer.

+ +

Definition at line 48 of file MergeLayer.cpp.

+ +

References ARMNN_ASSERT.

+ +

Referenced by MergeLayer::ValidateTensorShapesFromInputs().

+
49 {
50  ARMNN_ASSERT(inputShapes.size() == 2);
51 
52  ConditionalThrowIfNotEqual<LayerValidationException>(
53  "MergeLayer: TensorShapes set on inputs do not match",
54  inputShapes[0],
55  inputShapes[1]
56  );
57 
58  return {inputShapes[0]};
59 }
ARMNN_ASSERT
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
+
+
+ +

◆ ValidateTensorShapesFromInputs()

+ +
+
+ + + + + +
+ + + + + + + +
void ValidateTensorShapesFromInputs ()
+ 		+overridevirtual
+
+ +

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

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

Implements Layer.

+ +

Definition at line 30 of file MergeLayer.cpp.

+ +

References ARMNN_ASSERT, CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), MergeLayer::InferOutputShapes(), Layer::m_ShapeInferenceMethod, Layer::ValidateAndCopyShape(), Layer::VerifyLayerConnections(), and Layer::VerifyShapeInferenceType().

+
31 {
32  VerifyLayerConnections(2, CHECK_LOCATION());
33 
34  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
35 
36  VerifyShapeInferenceType(outputShape, m_ShapeInferenceMethod);
37 
38  std::vector<TensorShape> inferredShapes = InferOutputShapes({
39  GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape(),
40  GetInputSlot(1).GetConnection()->GetTensorInfo().GetShape(),
41  });
42 
43  ARMNN_ASSERT(inferredShapes.size() == 1);
44 
45  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "MergeLayer");
46 }
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:187
+
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:432
+
armnn::InputSlot::GetConnection
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:199
+
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:392
+
armnn::MergeLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
Infers the output shapes from given input shapes.
Definition: MergeLayer.cpp:48
+
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:344
+
armnn::Layer::GetInputSlot
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:312
+
ARMNN_ASSERT
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:197
+
armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:314
+
armnn::IOutputSlot::GetTensorInfo
virtual const TensorInfo & GetTensorInfo() const =0
+
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63
+
armnn::Layer::m_ShapeInferenceMethod
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:387
+
+
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1