From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- 21.02/structarmnn_1_1_lstm_descriptor.xhtml | 384 ++++++++++++++++++++++++++++ 1 file changed, 384 insertions(+) create mode 100644 21.02/structarmnn_1_1_lstm_descriptor.xhtml (limited to '21.02/structarmnn_1_1_lstm_descriptor.xhtml') diff --git a/21.02/structarmnn_1_1_lstm_descriptor.xhtml b/21.02/structarmnn_1_1_lstm_descriptor.xhtml new file mode 100644 index 0000000000..a5ae7bd77c --- /dev/null +++ b/21.02/structarmnn_1_1_lstm_descriptor.xhtml @@ -0,0 +1,384 @@ + + + + + + + + + + + + + +ArmNN: LstmDescriptor Struct Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
LstmDescriptor Struct Reference
+
+
+ +

An LstmDescriptor for the LstmLayer. + More...

+ +

#include <Descriptors.hpp>

+
+Inheritance diagram for LstmDescriptor:
+
+
+ + +BaseDescriptor + +
+ + + + + + +

+Public Member Functions

 LstmDescriptor ()
 
bool operator== (const LstmDescriptor &rhs) const
 
+ + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

uint32_t m_ActivationFunc
 The activation function to use. More...
 
float m_ClippingThresCell
 Clipping threshold value for the cell state. More...
 
float m_ClippingThresProj
 Clipping threshold value for the projection. More...
 
bool m_CifgEnabled
 Enable/disable cifg (coupled input & forget gate). More...
 
bool m_PeepholeEnabled
 Enable/disable peephole. More...
 
bool m_ProjectionEnabled
 Enable/disable the projection layer. More...
 
bool m_LayerNormEnabled
 Enable/disable layer normalization. More...
 
+

Detailed Description

+

An LstmDescriptor for the LstmLayer.

+ +

Definition at line 911 of file Descriptors.hpp.

+

Constructor & Destructor Documentation

+ +

◆ LstmDescriptor()

+ +
+
+ + + + + +
+ + + + + + + +
LstmDescriptor ()
+ 		+inline
+
+ +

Definition at line 913 of file Descriptors.hpp.

+
914  : m_ActivationFunc(1) // 0: None, 1: Relu, 3: Relu6, 4: Tanh, 6: Sigmoid
915  , m_ClippingThresCell(0.0)
916  , m_ClippingThresProj(0.0)
917  , m_CifgEnabled(true)
918  , m_PeepholeEnabled(false)
919  , m_ProjectionEnabled(false)
920  , m_LayerNormEnabled(false)
921  {}
armnn::LstmDescriptor::m_ProjectionEnabled
bool m_ProjectionEnabled
Enable/disable the projection layer.
Definition: Descriptors.hpp:945
+
armnn::LstmDescriptor::m_ClippingThresProj
float m_ClippingThresProj
Clipping threshold value for the projection.
Definition: Descriptors.hpp:939
+
armnn::LstmDescriptor::m_PeepholeEnabled
bool m_PeepholeEnabled
Enable/disable peephole.
Definition: Descriptors.hpp:943
+
armnn::LstmDescriptor::m_ActivationFunc
uint32_t m_ActivationFunc
The activation function to use.
Definition: Descriptors.hpp:935
+
armnn::LstmDescriptor::m_ClippingThresCell
float m_ClippingThresCell
Clipping threshold value for the cell state.
Definition: Descriptors.hpp:937
+
armnn::LstmDescriptor::m_CifgEnabled
bool m_CifgEnabled
Enable/disable cifg (coupled input & forget gate).
Definition: Descriptors.hpp:941
+
armnn::LstmDescriptor::m_LayerNormEnabled
bool m_LayerNormEnabled
Enable/disable layer normalization.
Definition: Descriptors.hpp:947
+
+
+
+

Member Function Documentation

+ +

◆ operator==()

+ +
+
+ + + + + +
+ + + + + + + + +
bool operator== (const LstmDescriptor & rhs) const
+ 		+inline
+
+ +

Definition at line 923 of file Descriptors.hpp.

+ +

References LstmDescriptor::m_ActivationFunc, LstmDescriptor::m_CifgEnabled, LstmDescriptor::m_ClippingThresCell, LstmDescriptor::m_ClippingThresProj, LstmDescriptor::m_LayerNormEnabled, and LstmDescriptor::m_PeepholeEnabled.

+
924  {
925  return m_ActivationFunc == rhs.m_ActivationFunc &&
926  m_ClippingThresCell == rhs.m_ClippingThresCell &&
927  m_ClippingThresProj == rhs.m_ClippingThresProj &&
928  m_CifgEnabled == rhs.m_CifgEnabled &&
929  m_PeepholeEnabled == rhs.m_PeepholeEnabled &&
930  m_LayerNormEnabled == rhs.m_LayerNormEnabled;
931  }
armnn::LstmDescriptor::m_ClippingThresProj
float m_ClippingThresProj
Clipping threshold value for the projection.
Definition: Descriptors.hpp:939
+
armnn::LstmDescriptor::m_PeepholeEnabled
bool m_PeepholeEnabled
Enable/disable peephole.
Definition: Descriptors.hpp:943
+
armnn::LstmDescriptor::m_ActivationFunc
uint32_t m_ActivationFunc
The activation function to use.
Definition: Descriptors.hpp:935
+
armnn::LstmDescriptor::m_ClippingThresCell
float m_ClippingThresCell
Clipping threshold value for the cell state.
Definition: Descriptors.hpp:937
+
armnn::LstmDescriptor::m_CifgEnabled
bool m_CifgEnabled
Enable/disable cifg (coupled input & forget gate).
Definition: Descriptors.hpp:941
+
armnn::LstmDescriptor::m_LayerNormEnabled
bool m_LayerNormEnabled
Enable/disable layer normalization.
Definition: Descriptors.hpp:947
+
+
+
+

Member Data Documentation

+ +

◆ m_ActivationFunc

+ +
+
+ + + + +
uint32_t m_ActivationFunc
+
+ +

The activation function to use.

+

0: None, 1: Relu, 3: Relu6, 4: Tanh, 6: Sigmoid.

+ +

Definition at line 935 of file Descriptors.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), armnn::BOOST_AUTO_TEST_CASE(), TestLstmLayerVisitor::CheckDescriptor(), RefLstmWorkload::Execute(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), IDeserializer::DeserializerImpl::GetLstmDescriptor(), LstmDescriptor::operator==(), and StringifyLayerParameters< LstmDescriptor >::Serialize().

+ +
+
+ +

◆ m_CifgEnabled

+ +
+
+ + + + +
bool m_CifgEnabled
+
+ +

Enable/disable cifg (coupled input & forget gate).

+ +

Definition at line 941 of file Descriptors.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), armnn::BOOST_AUTO_TEST_CASE(), TestLstmLayerVisitor::CheckDescriptor(), LstmLayer::CreateWorkload(), RefLstmWorkload::Execute(), LstmLayer::ExecuteStrategy(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), IDeserializer::DeserializerImpl::GetLstmDescriptor(), LstmLayer::InferOutputShapes(), RefLayerSupport::IsLstmSupported(), LstmDescriptor::operator==(), StringifyLayerParameters< LstmDescriptor >::Serialize(), and LstmLayer::ValidateTensorShapesFromInputs().

+ +
+
+ +

◆ m_ClippingThresCell

+ +
+
+ + + + +
float m_ClippingThresCell
+
+ +

Clipping threshold value for the cell state.

+ +

Definition at line 937 of file Descriptors.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), armnn::BOOST_AUTO_TEST_CASE(), TestLstmLayerVisitor::CheckDescriptor(), RefLstmWorkload::Execute(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), IDeserializer::DeserializerImpl::GetLstmDescriptor(), LstmDescriptor::operator==(), and StringifyLayerParameters< LstmDescriptor >::Serialize().

+ +
+
+ +

◆ m_ClippingThresProj

+ +
+
+ + + + +
float m_ClippingThresProj
+
+ +

Clipping threshold value for the projection.

+ +

Definition at line 939 of file Descriptors.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), armnn::BOOST_AUTO_TEST_CASE(), TestLstmLayerVisitor::CheckDescriptor(), RefLstmWorkload::Execute(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), IDeserializer::DeserializerImpl::GetLstmDescriptor(), LstmDescriptor::operator==(), and StringifyLayerParameters< LstmDescriptor >::Serialize().

+ +
+
+ +

◆ m_LayerNormEnabled

+ +
+
+ + + + +
bool m_LayerNormEnabled
+
+ +

Enable/disable layer normalization.

+ +

Definition at line 947 of file Descriptors.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), LstmLayer::CreateWorkload(), RefLstmWorkload::Execute(), LstmLayer::ExecuteStrategy(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), IDeserializer::DeserializerImpl::GetLstmDescriptor(), RefLayerSupport::IsLstmSupported(), LstmDescriptor::operator==(), and StringifyLayerParameters< LstmDescriptor >::Serialize().

+ +
+
+ +

◆ m_PeepholeEnabled

+ +
+
+ + + + +
bool m_PeepholeEnabled
+
+ +

Enable/disable peephole.

+ +

Definition at line 943 of file Descriptors.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), armnn::BOOST_AUTO_TEST_CASE(), TestLstmLayerVisitor::CheckDescriptor(), LstmLayer::CreateWorkload(), RefLstmWorkload::Execute(), LstmLayer::ExecuteStrategy(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), IDeserializer::DeserializerImpl::GetLstmDescriptor(), RefLayerSupport::IsLstmSupported(), LstmDescriptor::operator==(), StringifyLayerParameters< LstmDescriptor >::Serialize(), and LstmLayer::ValidateTensorShapesFromInputs().

+ +
+
+ +

◆ m_ProjectionEnabled

+ +
+
+ + + + +
bool m_ProjectionEnabled
+
+ +

Enable/disable the projection layer.

+ +

Definition at line 945 of file Descriptors.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), armnn::BOOST_AUTO_TEST_CASE(), TestLstmLayerVisitor::CheckDescriptor(), LstmLayer::CreateWorkload(), RefLstmWorkload::Execute(), LstmLayer::ExecuteStrategy(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), IDeserializer::DeserializerImpl::GetLstmDescriptor(), RefLayerSupport::IsLstmSupported(), StringifyLayerParameters< LstmDescriptor >::Serialize(), and LstmLayer::ValidateTensorShapesFromInputs().

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + -- cgit v1.2.1