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 --- .../classarmnn_1_1_cl_convolution3d_workload.xhtml | 344 +++++++++++++++++++++ 1 file changed, 344 insertions(+) create mode 100644 latest/classarmnn_1_1_cl_convolution3d_workload.xhtml (limited to 'latest/classarmnn_1_1_cl_convolution3d_workload.xhtml') diff --git a/latest/classarmnn_1_1_cl_convolution3d_workload.xhtml b/latest/classarmnn_1_1_cl_convolution3d_workload.xhtml new file mode 100644 index 0000000000..cb0846b2fb --- /dev/null +++ b/latest/classarmnn_1_1_cl_convolution3d_workload.xhtml @@ -0,0 +1,344 @@ + + + + + + + + + + + + + +ArmNN: ClConvolution3dWorkload Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  23.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
ClConvolution3dWorkload Class Reference
+
+
+ +

#include <ClConvolution3dWorkload.hpp>

+
+Inheritance diagram for ClConvolution3dWorkload:
+
+
+ + +ClBaseWorkload< Convolution3dQueueDescriptor > +BaseWorkload< Convolution3dQueueDescriptor > +IWorkload + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ClConvolution3dWorkload (const Convolution3dQueueDescriptor &descriptor, const WorkloadInfo &info, std::shared_ptr< arm_compute::MemoryManagerOnDemand > &memoryManager, const arm_compute::CLCompileContext &clCompileContext, const bool isFastMathEnabled=false)
 
void Execute () const override
 
- Public Member Functions inherited from ClBaseWorkload< Convolution3dQueueDescriptor >
 ClBaseWorkload (const Convolution3dQueueDescriptor &descriptor, const WorkloadInfo &info)
 
void ReplaceInputTensorHandle (ITensorHandle *tensorHandle, unsigned int slot) override
 
void ReplaceOutputTensorHandle (ITensorHandle *tensorHandle, unsigned int slot) override
 
- Public Member Functions inherited from BaseWorkload< Convolution3dQueueDescriptor >
 BaseWorkload (const Convolution3dQueueDescriptor &descriptor, const WorkloadInfo &info)
 
void ExecuteAsync (ExecutionData &executionData) override
 
void PostAllocationConfigure () override
 
const Convolution3dQueueDescriptor & GetData () const
 
arm::pipe::ProfilingGuid GetGuid () const final
 
virtual bool SupportsTensorHandleReplacement () const override
 
- Public Member Functions inherited from IWorkload
virtual ~IWorkload ()
 
virtual arm::pipe::ProfilingGuid GetGuid () const =0
 
virtual bool SupportsTensorHandleReplacement () const =0
 
virtual void RegisterDebugCallback (const DebugCallbackFunction &)
 
virtual armnn::Optional< armnn::MemoryRequirements > GetMemoryRequirements ()
 
+ + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from ClBaseWorkload< Convolution3dQueueDescriptor >
virtual void Reconfigure ()
 
- Protected Attributes inherited from BaseWorkload< Convolution3dQueueDescriptor >
Convolution3dQueueDescriptor m_Data
 
const arm::pipe::ProfilingGuid m_Guid
 
+

Detailed Description

+
+

Definition at line 26 of file ClConvolution3dWorkload.hpp.

+

Constructor & Destructor Documentation

+ +

◆ ClConvolution3dWorkload()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClConvolution3dWorkload (const Convolution3dQueueDescriptor & descriptor,
const WorkloadInfo & info,
std::shared_ptr< arm_compute::MemoryManagerOnDemand > & memoryManager,
const arm_compute::CLCompileContext & clCompileContext,
const bool isFastMathEnabled = false 
)
+
+ +

Definition at line 56 of file ClConvolution3dWorkload.cpp.

+
61  : ClBaseWorkload<Convolution3dQueueDescriptor>(descriptor, info)
+
62  , m_ConvolutionLayer()
+
63 {
+
64  IgnoreUnused(memoryManager);
+
65 
+
66  uint32_t numInputs = m_Data.m_Parameters.m_BiasEnabled ? 3: 2;
+
67  m_Data.ValidateInputsOutputs("ClConvolution3dWorkload", numInputs, 1);
+
68 
+
69  arm_compute::ICLTensor& input = static_cast<IClTensorHandle*>(m_Data.m_Inputs[0])->GetTensor();
+
70  arm_compute::ICLTensor& weights = static_cast<IClTensorHandle*>(m_Data.m_Inputs[1])->GetTensor();
+
71  arm_compute::ICLTensor* biasesPtr = nullptr;
+
72  if (m_Data.m_Parameters.m_BiasEnabled)
+
73  {
+
74  biasesPtr = &static_cast<IClTensorHandle*>(m_Data.m_Inputs[2])->GetTensor();
+
75  }
+
76  arm_compute::ICLTensor& output = static_cast<IClTensorHandle*>(m_Data.m_Outputs[0])->GetTensor();
+
77 
+
78  arm_compute::DataLayout aclDataLayout = ConvertDataLayout(m_Data.m_Parameters.m_DataLayout);
+
79  input.info()->set_data_layout(aclDataLayout);
+
80  weights.info()->set_data_layout(aclDataLayout);
+
81  output.info()->set_data_layout(aclDataLayout);
+
82 
+
83  const arm_compute::Conv3dInfo aclConv3DInfo = ComputeConv3DInfo(descriptor,
+
84  isFastMathEnabled);
+
85 
+
86  {
+
87  ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "ClConvolution3dWorkload_configure");
+
88  m_ConvolutionLayer.configure(clCompileContext,
+
89  &input,
+
90  &weights,
+
91  biasesPtr,
+
92  &output,
+
93  aclConv3DInfo);
+
94  }
+
95  // Add details for profiling output
+
96  WorkloadInfo detailsInfo;
+
97 
+
98  detailsInfo.m_InputTensorInfos = info.m_InputTensorInfos;
+
99  detailsInfo.m_OutputTensorInfos = info.m_OutputTensorInfos;
+
100 
+
101  // Report Profiling Details
+
102  ARMNN_REPORT_PROFILING_WORKLOAD_DESC("ClConvolution3dWorkload_Construct",
+
103  descriptor.m_Parameters,
+
104  detailsInfo,
+
105  this->GetGuid());
+
106 
+
107  // Force Compute Library to perform the necessary copying and reshaping, after which
+
108  // delete all the input tensors that will no longer be needed
+
109  m_ConvolutionLayer.prepare();
+
110 }
+
+

References armnn::IgnoreUnused(), armnn::info, Convolution3dDescriptor::m_BiasEnabled, BaseWorkload< Convolution3dQueueDescriptor >::m_Data, QueueDescriptor::m_Inputs, QueueDescriptor::m_Outputs, QueueDescriptorWithParameters< LayerDescriptor >::m_Parameters, and QueueDescriptor::ValidateInputsOutputs().

+ +
+
+

Member Function Documentation

+ +

◆ Execute()

+ +
+
+ + + + + +
+ + + + + + + +
void Execute () const
+ 		+overridevirtual
+
+ +

Implements IWorkload.

+ +

Definition at line 112 of file ClConvolution3dWorkload.cpp.

+
113 {
+
114  ARMNN_SCOPED_PROFILING_EVENT_CL_GUID("ClConvolution3dWorkload_Execute", this->GetGuid());
+
115  RunClFunction(m_ConvolutionLayer, CHECK_LOCATION());
+
116 }
+
+

References ARMNN_SCOPED_PROFILING_EVENT_CL_GUID, CHECK_LOCATION, BaseWorkload< Convolution3dQueueDescriptor >::GetGuid(), and armnn::RunClFunction().

+ +
+
+
The documentation for this class was generated from the following files: +
+
+
armnn::BaseWorkload< Convolution3dQueueDescriptor >::GetGuid
arm::pipe::ProfilingGuid GetGuid() const final
Definition: Workload.hpp:61
+
armnn::QueueDescriptor::ValidateInputsOutputs
void ValidateInputsOutputs(const std::string &descName, unsigned int numExpectedIn, unsigned int numExpectedOut) const
Definition: WorkloadData.cpp:475
+
armnn::DataLayout
DataLayout
Definition: Types.hpp:62
+
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
+
armnn::IgnoreUnused
void IgnoreUnused(Ts &&...)
Definition: IgnoreUnused.hpp:14
+ +
ARMNN_SCOPED_PROFILING_EVENT
#define ARMNN_SCOPED_PROFILING_EVENT(backendId, name)
Definition: Profiling.hpp:220
+
armnn::ComputeConv3DInfo
arm_compute::Conv3dInfo ComputeConv3DInfo(const armnn::Convolution3dDescriptor descriptor, bool isFastMathEnabled, const ActivationDescriptor *activationDescriptor)
Utility function used to setup an arm_compute::Conv3dInfo object from convolution3d descriptor.
Definition: ArmComputeUtils.hpp:293
+
armnn::RunClFunction
void RunClFunction(arm_compute::IFunction &function, const CheckLocation &location)
Definition: ClWorkloadUtils.hpp:160
+ +
armnn::Convolution3dDescriptor::m_DataLayout
DataLayout m_DataLayout
The data layout to be used (NDHWC, NCDHW).
Definition: Descriptors.hpp:623
+ +
ARMNN_REPORT_PROFILING_WORKLOAD_DESC
#define ARMNN_REPORT_PROFILING_WORKLOAD_DESC(name, desc, infos, guid)
Definition: Profiling.hpp:227
+
armnn::QueueDescriptor::m_Outputs
std::vector< ITensorHandle * > m_Outputs
Definition: WorkloadData.hpp:27
+
armnn::Convolution3dDescriptor::m_BiasEnabled
bool m_BiasEnabled
Enable/disable bias.
Definition: Descriptors.hpp:621
+
ARMNN_SCOPED_PROFILING_EVENT_CL_GUID
#define ARMNN_SCOPED_PROFILING_EVENT_CL_GUID(name, guid)
Definition: ClWorkloadUtils.hpp:28
+
armnn::QueueDescriptor::m_Inputs
std::vector< ITensorHandle * > m_Inputs
Definition: WorkloadData.hpp:26
+ + + + + -- cgit v1.2.1