From ae050524109f1ce827962665436ef7430f2ac479 Mon Sep 17 00:00:00 2001 From: David Monahan Date: Wed, 22 Mar 2023 16:48:58 +0000 Subject: IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub. * Updating Doxygen documentation for 23.02 release. Signed-off-by: David Monahan Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82 --- 23.02/classarmnn_1_1_log_softmax_layer.xhtml | 141 ++++++++++++++++----------- 1 file changed, 85 insertions(+), 56 deletions(-) (limited to '23.02/classarmnn_1_1_log_softmax_layer.xhtml') diff --git a/23.02/classarmnn_1_1_log_softmax_layer.xhtml b/23.02/classarmnn_1_1_log_softmax_layer.xhtml index 4e7d11f234..8cf07ef33a 100644 --- a/23.02/classarmnn_1_1_log_softmax_layer.xhtml +++ b/23.02/classarmnn_1_1_log_softmax_layer.xhtml @@ -8,7 +8,7 @@ - + ArmNN: LogSoftmaxLayer Class Reference @@ -19,9 +19,6 @@ - @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); - + + @@ -51,18 +49,21 @@ - + +/* @license-end */
@@ -76,7 +77,9 @@ $(function() {
@@ -115,23 +118,23 @@ Inheritance diagram for LogSoftmaxLayer:
LayerWithParameters< LogSoftmaxDescriptor > Layer -IConnectableLayer - - +IConnectableLayer + + - + - + - + - + @@ -174,14 +177,14 @@ Public Member Functions - + - + @@ -225,8 +228,8 @@ Public Member Functions - - + + @@ -241,14 +244,17 @@ Public Member Functions + + +

Public Member Functions

virtual std::unique_ptr< IWorkload > CreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the LogSoftmax type. More...
 Makes a workload for the LogSoftmax type. More...
 
LogSoftmaxLayer * Clone (Graph &graph) const override
 Creates a dynamically-allocated copy of this layer. More...
 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 LogSoftmaxLayer. More...
 Check if the input tensor shape(s) will lead to a valid configuration of LogSoftmaxLayer. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< LogSoftmaxDescriptor >
const LogSoftmaxDescriptor & GetParameters () const override
LayerPriority GetPriority () const
 
LayerType GetType () const override
 Returns the armnn::LayerType of this layer. More...
 Returns the armnn::LayerType of this layer. More...
 
DataType GetDataType () const
 
const BackendId & GetBackendId () const
 
void SetBackendId (const BackendId &id) override
 Set the backend of the IConnectableLayer. More...
 Set the backend of the IConnectableLayer. More...
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
 
const std::list< std::string > & GetRelatedLayerNames ()
 
virtual void Reparent (Graph &dest, std::list< Layer *>::const_iterator iterator)=0
 
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...
 
 
void SetAdditionalInfoForObject (const AdditionalInfoObjectPtr &additionalInfo)
 
virtual const BaseDescriptor & GetParameters () const override
 If the layer has a descriptor return it. More...
 
- + - + @@ -267,10 +273,10 @@ Protected Member Functions - + - + @@ -351,7 +357,7 @@ Additional Inherited Members

Protected Member Functions

 LogSoftmaxLayer (const LogSoftmaxDescriptor &param, const char *name)
 Constructor to create a LogSoftmaxLayer. More...
 Constructor to create a LogSoftmaxLayer. More...
 
 ~LogSoftmaxLayer ()=default
 Default destructor. More...
 Default destructor. More...
 
- Protected Member Functions inherited from LayerWithParameters< LogSoftmaxDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const LogSoftmaxDescriptor &param, const char *name)
virtual ~Layer ()=default
 
template<typename QueueDescriptor >
void CollectQueueDescriptorInputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
void CollectQueueDescriptorInputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
 
template<typename QueueDescriptor >
void CollectQueueDescriptorOutputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
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)
 
-

Constructor to create a LogSoftmaxLayer.

+

Constructor to create a LogSoftmaxLayer.

Parameters
@@ -361,8 +367,7 @@ Additional Inherited Members

Definition at line 18 of file LogSoftmaxLayer.cpp.

-
19  : LayerWithParameters(1, 1, LayerType::LogSoftmax, param, name) {}
armnn::LayerWithParameters< LogSoftmaxDescriptor >::LayerWithParameters
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const LogSoftmaxDescriptor &param, const char *name)
Definition: LayerWithParameters.hpp:30
- +
19  : LayerWithParameters(1, 1, LayerType::LogSoftmax, param, name) {}
@@ -429,11 +434,12 @@ Additional Inherited Members

Implements Layer.

Definition at line 29 of file LogSoftmaxLayer.cpp.

- -

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

-
30 {
31  return CloneBase<LogSoftmaxLayer>(graph, m_Param, GetName());
32 }
armnn::LayerWithParameters< LogSoftmaxDescriptor >::m_Param
LogSoftmaxDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
-
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:319
+
30 {
+
31  return CloneBase<LogSoftmaxLayer>(graph, m_Param, GetName());
+
32 }
+

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

+
@@ -473,12 +479,15 @@ Additional Inherited Members

Implements Layer.

Definition at line 21 of file LogSoftmaxLayer.cpp.

- -

References IWorkloadFactory::CreateWorkload(), armnn::LogSoftmax, LayerWithParameters< LogSoftmaxDescriptor >::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

-
22 {
23  LogSoftmaxQueueDescriptor descriptor;
24  SetAdditionalInfo(descriptor);
25 
26  return factory.CreateWorkload(LayerType::LogSoftmax, descriptor, PrepInfoAndDesc(descriptor));
27 }
armnn::Layer::SetAdditionalInfo
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:274
-
armnn::LayerWithParameters< LogSoftmaxDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: LayerWithParameters.hpp:44
- +
22 {
+
23  LogSoftmaxQueueDescriptor descriptor;
+
24  SetAdditionalInfo(descriptor);
+
25 
+
26  return factory.CreateWorkload(LayerType::LogSoftmax, descriptor, PrepInfoAndDesc(descriptor));
+
27 }
+

References IWorkloadFactory::CreateWorkload(), armnn::LogSoftmax, LayerWithParameters< LogSoftmaxDescriptor >::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

+
@@ -510,11 +519,12 @@ Additional Inherited Members

Reimplemented from Layer.

Definition at line 48 of file LogSoftmaxLayer.cpp.

- -

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

-
49 {
50  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
51 }
armnn::LayerWithParameters< LogSoftmaxDescriptor >::GetParameters
const LogSoftmaxDescriptor & GetParameters() const override
Definition: LayerWithParameters.hpp:19
-
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:319
+
49 {
+
50  strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
+
51 }
+

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

+
@@ -551,22 +561,21 @@ Additional Inherited Members

Implements Layer.

Definition at line 34 of file LogSoftmaxLayer.cpp.

- -

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

-
35 {
36  VerifyLayerConnections(1, CHECK_LOCATION());
37 
38  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
39 
40  VerifyShapeInferenceType(outputShape, m_ShapeInferenceMethod);
41 
42  auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape() });
43  ARMNN_ASSERT(inferredShapes.size() == 1);
44 
45  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "LogSoftmaxLayer");
46 }
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:191
-
armnn::Layer::InferOutputShapes
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)
Definition: Layer.cpp:397
-
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:491
-
armnn::InputSlot::GetConnection
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:206
-
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:422
-
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:378
-
armnn::Layer::GetInputSlot
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:324
-
ARMNN_ASSERT
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
-
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
-
armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:326
-
armnn::IOutputSlot::GetTensorInfo
virtual const TensorInfo & GetTensorInfo() const =0
-
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:92
-
armnn::Layer::m_ShapeInferenceMethod
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:423
+
35 {
+
36  VerifyLayerConnections(1, CHECK_LOCATION());
+
37 
+
38  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
+
39 
+
40  VerifyShapeInferenceType(outputShape, m_ShapeInferenceMethod);
+
41 
+
42  auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape() });
+
43  ARMNN_ASSERT(inferredShapes.size() == 1);
+
44 
+
45  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "LogSoftmaxLayer");
+
46 }
+

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

+
The documentation for this class was generated from the following files:
    @@ -575,13 +584,33 @@ Additional Inherited Members
+
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
+
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:378
+
armnn::InputSlot::GetConnection
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:206
+
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:491
+
armnn::Layer::SetAdditionalInfo
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:274
+
armnn::Layer::m_ShapeInferenceMethod
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:423
+
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:422
+
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:92
+
armnn::IOutputSlot::GetTensorInfo
virtual const TensorInfo & GetTensorInfo() const =0
+
armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:326
+
armnn::LayerWithParameters< LogSoftmaxDescriptor >::LayerWithParameters
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const LogSoftmaxDescriptor &param, const char *name)
Definition: LayerWithParameters.hpp:30
+
armnn::LayerWithParameters< LogSoftmaxDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: LayerWithParameters.hpp:44
+
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:191
+
armnn::Layer::GetInputSlot
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:324
+
ARMNN_ASSERT
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:319
+ +
armnn::LayerWithParameters< LogSoftmaxDescriptor >::GetParameters
const LogSoftmaxDescriptor & GetParameters() const override
Definition: LayerWithParameters.hpp:19
+
armnn::LayerWithParameters< LogSoftmaxDescriptor >::m_Param
LogSoftmaxDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
+
armnn::Layer::InferOutputShapes
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)
Definition: Layer.cpp:397
-- cgit v1.2.1
[in]paramLogSoftmaxDescriptor to configure the log softmax operation.