ArmNN
 23.05
ClBatchMatMulWorkload.cpp
Go to the documentation of this file.
1 //
2 // Copyright © 2022-2023 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
7 
8 #include "ClWorkloadUtils.hpp"
9 
12 
14 
16 
17 #include <cl/ClTensorHandle.hpp>
18 
19 
20 namespace armnn
21 {
22 
24  const TensorInfo& inputInfoY,
25  const TensorInfo& outputInfo,
26  const BatchMatMulDescriptor& descriptor,
27  const ActivationDescriptor* activationDescriptor)
28 {
29  if (descriptor.m_AdjointX || descriptor.m_AdjointY )
30  {
31  throw Exception("Support for adjoint not implemented.");
32  }
34  {
35  throw Exception("Only supported the MatMul in the last 2 dimensions");
36  }
37 
38  arm_compute::TensorInfo aclInputInfoX = armcomputetensorutils::BuildArmComputeTensorInfo(inputInfoX);
39  arm_compute::TensorInfo aclInputInfoY = armcomputetensorutils::BuildArmComputeTensorInfo(inputInfoY);
40  const arm_compute::TensorInfo aclOutputInfo = armcomputetensorutils::BuildArmComputeTensorInfo(outputInfo);
41 
42  // GeMM dispatches kernel handles dynamic inputs differently to static so this flag needs to be set
43  aclInputInfoX.set_are_values_constant(false);
44  aclInputInfoY.set_are_values_constant(false);
45 
46  const arm_compute::ActivationLayerInfo activationInfo = ConvertActivationDescriptorToAclActivationLayerInfo(
47  activationDescriptor);
48 
49  arm_compute::MatMulInfo matMulInfo;
50  matMulInfo.adj_lhs(descriptor.m_TransposeX);
51  matMulInfo.adj_rhs(descriptor.m_TransposeY);
52  matMulInfo.fused_activation(activationInfo);
53 
54  return arm_compute::CLMatMul::validate(&aclInputInfoX, &aclInputInfoY, &aclOutputInfo, matMulInfo);
55 }
56 
58  const WorkloadInfo& info,
59  const arm_compute::CLCompileContext& clCompileContext)
61 {
62  // Report Profiling Details
63  ARMNN_REPORT_PROFILING_WORKLOAD_DESC("ClBatchMatMulWorkload_Construct",
64  descriptor.m_Parameters,
65  info,
66  this->GetGuid());
67 
68  if (descriptor.m_Parameters.m_AdjointX || descriptor.m_Parameters.m_AdjointY )
69  {
70  throw Exception("Support for adjoint not implemented.");
71  }
74  {
75  throw Exception("Only supported the MatMul in the last 2 dimensions");
76  }
77 
78  m_Data.ValidateInputsOutputs("ClBatchMatMulWorkload", 2, 1);
79 
80  arm_compute::ICLTensor& inputX = PolymorphicDowncast<ClTensorHandle*>(m_Data.m_Inputs[0])->GetTensor();
81  arm_compute::ICLTensor& inputY = PolymorphicDowncast<ClTensorHandle*>(m_Data.m_Inputs[1])->GetTensor();
82  auto outputHandle = PolymorphicDowncast<ClTensorHandle*>(m_Data.m_Outputs[0]);
83  arm_compute::ICLTensor& output = outputHandle->GetTensor();
84 
85  // GeMM dispatches kernel handles dynamic inputs differently to static so this flag needs to be set
86  inputX.info()->set_are_values_constant(false);
87  inputY.info()->set_are_values_constant(false);
88 
89  const arm_compute::ActivationLayerInfo activationInfo = ConvertAdditionalInfoToAclActivationLayerInfo(descriptor);
90 
91  arm_compute::MatMulInfo matMulInfo;
92  matMulInfo.adj_lhs(descriptor.m_Parameters.m_TransposeX);
93  matMulInfo.adj_rhs(descriptor.m_Parameters.m_TransposeY);
94  matMulInfo.fused_activation(activationInfo);
95 
96  m_MatMulLayer.configure(clCompileContext, &inputX, &inputY, &output, matMulInfo);
97 
98  // Report Profiling Details
99  WorkloadInfo detailsInfo;
100  detailsInfo.m_InputTensorInfos = info.m_InputTensorInfos;
101  detailsInfo.m_OutputTensorInfos = info.m_OutputTensorInfos;
102  ARMNN_REPORT_PROFILING_WORKLOAD_DESC("ClBatchMatMulWorkload_Construct",
103  descriptor.m_Parameters,
104  detailsInfo,
105  GetGuid());
106 }
107 
109 {
110  ARMNN_SCOPED_PROFILING_EVENT_CL_GUID("ClBatchMatMulWorkload_Execute", this->GetGuid());
111  RunClFunction(m_MatMulLayer, CHECK_LOCATION());
112 }
113 } //namespace armnn
armnn::BatchMatMulDescriptor::m_TransposeX
bool m_TransposeX
Transpose the slices of each input tensor Transpose and Adjoint can not both be set to true for the s...
Definition: Descriptors.hpp:1579
armnn::BaseWorkload< BatchMatMulQueueDescriptor >::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:472
armnn::ConvertActivationDescriptorToAclActivationLayerInfo
arm_compute::ActivationLayerInfo ConvertActivationDescriptorToAclActivationLayerInfo(const ActivationDescriptor &actDesc)
Definition: ArmComputeUtils.hpp:85
armnn::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
armnn::BatchMatMulQueueDescriptor
Definition: WorkloadData.hpp:748
armnn::ActivationDescriptor
An ActivationDescriptor for the ActivationLayer.
Definition: Descriptors.hpp:36
armnn::ClBatchMatMulValidate
arm_compute::Status ClBatchMatMulValidate(const TensorInfo &inputInfoX, const TensorInfo &inputInfoY, const TensorInfo &outputInfo, const BatchMatMulDescriptor &descriptor, const ActivationDescriptor *activationDescriptor)
Definition: ClBatchMatMulWorkload.cpp:23
armnn::BatchMatMulDescriptor
A BatchMatMulDescriptor for the BatchMatMul operator.
Definition: Descriptors.hpp:1551
PolymorphicDowncast.hpp
armnn::BaseWorkload< BatchMatMulQueueDescriptor >::m_Data
BatchMatMulQueueDescriptor m_Data
Definition: Workload.hpp:83
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnn::DataLayout::NCHW
@ NCHW
armnn::WorkloadInfo::m_OutputTensorInfos
std::vector< TensorInfo > m_OutputTensorInfos
Definition: WorkloadInfo.hpp:19
armnn::BatchMatMulDescriptor::m_DataLayoutX
DataLayout m_DataLayoutX
Data layout of each input tensor, such as NHWC/NDHWC (leave as default for arbitrary layout)
Definition: Descriptors.hpp:1588
ArmComputeTensorUtils.hpp
armnn::BatchMatMulDescriptor::m_TransposeY
bool m_TransposeY
Definition: Descriptors.hpp:1580
ArmComputeUtils.hpp
armnn::TensorInfo
Definition: Tensor.hpp:152
armnn::RunClFunction
void RunClFunction(arm_compute::IFunction &function, const CheckLocation &location)
Definition: ClWorkloadUtils.hpp:160
armnn::Status
Status
Definition: Types.hpp:42
armnn::ClBaseWorkload
Definition: ClBaseWorkload.hpp:13
armnn::ClBatchMatMulWorkload::ClBatchMatMulWorkload
ClBatchMatMulWorkload(const BatchMatMulQueueDescriptor &descriptor, const WorkloadInfo &info, const arm_compute::CLCompileContext &clCompileContext)
Definition: ClBatchMatMulWorkload.cpp:57
armnn::ConvertAdditionalInfoToAclActivationLayerInfo
arm_compute::ActivationLayerInfo ConvertAdditionalInfoToAclActivationLayerInfo(const QueueDescriptor &queueDescriptor)
Definition: ArmComputeUtils.hpp:103
armnn::WorkloadInfo
Contains information about TensorInfos of a layer.
Definition: WorkloadInfo.hpp:16
armnn::QueueDescriptorWithParameters::m_Parameters
LayerDescriptor m_Parameters
Definition: WorkloadData.hpp:66
ARMNN_REPORT_PROFILING_WORKLOAD_DESC
#define ARMNN_REPORT_PROFILING_WORKLOAD_DESC(name, desc, infos, guid)
Definition: Profiling.hpp:227
ClBatchMatMulWorkload.hpp
armnn::BatchMatMulDescriptor::m_DataLayoutY
DataLayout m_DataLayoutY
Definition: Descriptors.hpp:1589
ClWorkloadUtils.hpp
armnn::QueueDescriptor::m_Outputs
std::vector< ITensorHandle * > m_Outputs
Definition: WorkloadData.hpp:27
WorkloadUtils.hpp
armnn::BatchMatMulDescriptor::m_AdjointY
bool m_AdjointY
Definition: Descriptors.hpp:1585
armnn::BatchMatMulDescriptor::m_AdjointX
bool m_AdjointX
Adjoint the slices of each input tensor Transpose and Adjoint can not both be set to true for the sam...
Definition: Descriptors.hpp:1584
ARMNN_SCOPED_PROFILING_EVENT_CL_GUID
#define ARMNN_SCOPED_PROFILING_EVENT_CL_GUID(name, guid)
Definition: ClWorkloadUtils.hpp:28
armnn::ClBatchMatMulWorkload::Execute
virtual void Execute() const override
Definition: ClBatchMatMulWorkload.cpp:108
ClTensorHandle.hpp
armnn::WorkloadInfo::m_InputTensorInfos
std::vector< TensorInfo > m_InputTensorInfos
Definition: WorkloadInfo.hpp:18
armnn::QueueDescriptor::m_Inputs
std::vector< ITensorHandle * > m_Inputs
Definition: WorkloadData.hpp:26
armnn::BoostLogSeverityMapping::info
@ info