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 --- ...tarmnn_1_1_convolution2d_queue_descriptor.xhtml | 302 +++++++++++++++++++++ 1 file changed, 302 insertions(+) create mode 100644 21.02/structarmnn_1_1_convolution2d_queue_descriptor.xhtml (limited to '21.02/structarmnn_1_1_convolution2d_queue_descriptor.xhtml') diff --git a/21.02/structarmnn_1_1_convolution2d_queue_descriptor.xhtml b/21.02/structarmnn_1_1_convolution2d_queue_descriptor.xhtml new file mode 100644 index 0000000000..c26604afc9 --- /dev/null +++ b/21.02/structarmnn_1_1_convolution2d_queue_descriptor.xhtml @@ -0,0 +1,302 @@ + + + + + + + + + + + + + +ArmNN: Convolution2dQueueDescriptor Struct Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
Convolution2dQueueDescriptor Struct Reference
+
+
+ +

#include <WorkloadData.hpp>

+
+Inheritance diagram for Convolution2dQueueDescriptor:
+
+
+ + +QueueDescriptorWithParameters< Convolution2dDescriptor > +QueueDescriptor + +
+ + + + + + + + + + + + +

+Public Member Functions

 Convolution2dQueueDescriptor ()
 
void Validate (const WorkloadInfo &workloadInfo) const
 
- Public Member Functions inherited from QueueDescriptor
void ValidateInputsOutputs (const std::string &descName, unsigned int numExpectedIn, unsigned int numExpectedOut) const
 
template<typename T >
const T * GetAdditionalInformation () const
 
+ + + + + + + + + + + + + + + +

+Public Attributes

const ConstCpuTensorHandle * m_Weight
 
const ConstCpuTensorHandle * m_Bias
 
- Public Attributes inherited from QueueDescriptorWithParameters< Convolution2dDescriptor >
Convolution2dDescriptor m_Parameters
 
- Public Attributes inherited from QueueDescriptor
std::vector< ITensorHandle * > m_Inputs
 
std::vector< ITensorHandle * > m_Outputs
 
void * m_AdditionalInfoObject
 
+ + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from QueueDescriptorWithParameters< Convolution2dDescriptor >
 ~QueueDescriptorWithParameters ()=default
 
 QueueDescriptorWithParameters ()=default
 
 QueueDescriptorWithParameters (QueueDescriptorWithParameters const &)=default
 
QueueDescriptorWithParameters & operator= (QueueDescriptorWithParameters const &)=default
 
- Protected Member Functions inherited from QueueDescriptor
 ~QueueDescriptor ()=default
 
 QueueDescriptor ()
 
 QueueDescriptor (QueueDescriptor const &)=default
 
QueueDescriptor & operator= (QueueDescriptor const &)=default
 
+

Detailed Description

+
+

Definition at line 192 of file WorkloadData.hpp.

+

Constructor & Destructor Documentation

+ +

◆ Convolution2dQueueDescriptor()

+ +
+
+ + + + + +
+ + + + + + + +
Convolution2dQueueDescriptor ()
+ 		+inline
+
+ +

Definition at line 194 of file WorkloadData.hpp.

+
195  : m_Weight(nullptr)
196  , m_Bias(nullptr)
197  {
198  }
armnn::Convolution2dQueueDescriptor::m_Bias
const ConstCpuTensorHandle * m_Bias
Definition: WorkloadData.hpp:201
+
armnn::Convolution2dQueueDescriptor::m_Weight
const ConstCpuTensorHandle * m_Weight
Definition: WorkloadData.hpp:200
+
+
+
+

Member Function Documentation

+ +

◆ Validate()

+ +
+
+ + + + + + + + +
void Validate (const WorkloadInfo & workloadInfo) const
+
+ +

Definition at line 1231 of file WorkloadData.cpp.

+ +

References armnn::BFloat16, armnn::Float16, armnn::Float32, armnn::GetBiasDataType(), TensorInfo::GetDataType(), WorkloadInfo::m_InputTensorInfos, WorkloadInfo::m_OutputTensorInfos, armnn::QAsymmS8, armnn::QAsymmU8, armnn::QSymmS16, armnn::QSymmS8, and OptionalReferenceSwitch< std::is_reference< T >::value, T >::value().

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
1232 {
1233  const std::string descriptorName{"Convolution2dQueueDescriptor"};
1234 
1235  ValidateNumInputs(workloadInfo, descriptorName, 1);
1236  ValidateNumOutputs(workloadInfo, descriptorName, 1);
1237 
1238  const TensorInfo& inputTensorInfo = workloadInfo.m_InputTensorInfos[0];
1239  const TensorInfo& outputTensorInfo = workloadInfo.m_OutputTensorInfos[0];
1240 
1241  ValidateTensorNumDimensions(inputTensorInfo, descriptorName, 4, "input");
1242  ValidateTensorNumDimensions(outputTensorInfo, descriptorName, 4, "output");
1243 
1244  ValidatePointer(m_Weight, descriptorName, "weight");
1245 
1246  const TensorInfo& weightTensorInfo = m_Weight->GetTensorInfo();
1247  ValidateTensorNumDimensions(weightTensorInfo, descriptorName, 4, "weight");
1248 
1249  ValidateWeightDataType(inputTensorInfo, weightTensorInfo, descriptorName);
1250 
1251  Optional<TensorInfo> optionalBiasTensorInfo;
1252  if (m_Parameters.m_BiasEnabled)
1253  {
1254  ValidatePointer(m_Bias, descriptorName, "bias");
1255 
1256  optionalBiasTensorInfo = MakeOptional<TensorInfo>(m_Bias->GetTensorInfo());
1257  const TensorInfo& biasTensorInfo = optionalBiasTensorInfo.value();
1258 
1259  ValidateTensorDataType(biasTensorInfo, GetBiasDataType(inputTensorInfo.GetDataType()), descriptorName, "bias");
1260  ValidateBiasTensorQuantization(biasTensorInfo, inputTensorInfo, weightTensorInfo, descriptorName);
1261  }
1262 
1263  if (m_Parameters.m_StrideX <= 0 || m_Parameters.m_StrideY <= 0 )
1264  {
1265  throw InvalidArgumentException(
1266  fmt::format("{}: strideX (provided {}) and strideY (provided {}) "
1267  "cannot be either negative or 0.",
1268  descriptorName, m_Parameters.m_StrideX, m_Parameters.m_StrideY));
1269  }
1270 
1271  ValidatePerAxisQuantization(inputTensorInfo,
1272  outputTensorInfo,
1273  weightTensorInfo,
1274  optionalBiasTensorInfo,
1275  descriptorName);
1276 
1277  std::vector<DataType> supportedTypes =
1278  {
1279  DataType::BFloat16,
1280  DataType::Float16,
1281  DataType::Float32,
1282  DataType::QAsymmS8,
1283  DataType::QAsymmU8,
1284  DataType::QSymmS16,
1285  DataType::QSymmS8
1286  };
1287 
1288  ValidateDataTypes(inputTensorInfo, supportedTypes, descriptorName);
1289 
1290  // For Convolution2d, we allow to have BFloat16 input with Float32 output for optimization.
1291  if (inputTensorInfo.GetDataType() == DataType::BFloat16)
1292  {
1293  if (outputTensorInfo.GetDataType() != DataType::BFloat16 && outputTensorInfo.GetDataType() != DataType::Float32)
1294  {
1295  throw InvalidArgumentException(descriptorName + ": " + " Output tensor type must be BFloat16 or Float32 "
1296  "for BFloat16 input.");
1297  }
1298  }
1299  else
1300  {
1301  ValidateTensorDataTypesMatch(inputTensorInfo, outputTensorInfo, descriptorName, "input", "output");
1302  }
1303 }
armnn::Convolution2dDescriptor::m_BiasEnabled
bool m_BiasEnabled
Enable/disable bias.
Definition: Descriptors.hpp:454
+
armnn::Convolution2dQueueDescriptor::m_Bias
const ConstCpuTensorHandle * m_Bias
Definition: WorkloadData.hpp:201
+ + + + + + +
armnn::Convolution2dDescriptor::m_StrideX
uint32_t m_StrideX
Stride value when proceeding through input for the width dimension.
Definition: Descriptors.hpp:446
+
armnn::WorkloadInfo::m_InputTensorInfos
std::vector< TensorInfo > m_InputTensorInfos
Definition: WorkloadInfo.hpp:18
+
armnn::TensorInfo::GetDataType
DataType GetDataType() const
Definition: Tensor.hpp:194
+ +
armnn::Convolution2dQueueDescriptor::m_Weight
const ConstCpuTensorHandle * m_Weight
Definition: WorkloadData.hpp:200
+ +
armnn::WorkloadInfo::m_OutputTensorInfos
std::vector< TensorInfo > m_OutputTensorInfos
Definition: WorkloadInfo.hpp:19
+ + +
armnn::Convolution2dDescriptor::m_StrideY
uint32_t m_StrideY
Stride value when proceeding through input for the height dimension.
Definition: Descriptors.hpp:448
+
armnn::GetBiasDataType
DataType GetBiasDataType(DataType inputDataType)
Definition: WorkloadData.cpp:25
+ + +
armnn::ConstCpuTensorHandle::GetTensorInfo
const TensorInfo & GetTensorInfo() const
Definition: CpuTensorHandle.hpp:37
+
+
+
+

Member Data Documentation

+ +

◆ m_Bias

+ +
+
+ + + + +
const ConstCpuTensorHandle* m_Bias
+
+ +

Definition at line 201 of file WorkloadData.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), CompareConvolution2dTestImpl(), Convolution1dTestImpl(), Convolution2dLayer::CreateWorkload(), RefConvolution2dWorkload::RefConvolution2dWorkload(), SimpleConvolution2dNhwcTestImpl(), and SimpleConvolution2dTestImpl().

+ +
+
+ +

◆ m_Weight

+ +
+
+ + + + +
const ConstCpuTensorHandle* m_Weight
+
+ +

Definition at line 200 of file WorkloadData.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), ClConvolution2dWorkload::ClConvolution2dWorkload(), CompareConvolution2dTestImpl(), Convolution1dTestImpl(), Convolution2dLayer::CreateWorkload(), RefConvolution2dWorkload::RefConvolution2dWorkload(), SimpleConvolution2dNhwcTestImpl(), and SimpleConvolution2dTestImpl().

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