50 using ElementsProcessed = Steps;
52 inline Status
validate_arguments(
const ITensorInfo *input0,
const ITensorInfo *input1,
const ITensorInfo *input2,
const ITensorInfo *output,
float beta,
53 bool is_interleaved_transposed,
const GEMMReshapeInfo &reshape_info,
bool fp_mixed_precision)
62 ARM_COMPUTE_RETURN_ERROR_ON_MSG(is_interleaved_transposed && reshape_info.reinterpret_input_as_3d(),
"The input tensor cannot be reinterpreted as 3D if is_interleaved_transposed is true");
63 ARM_COMPUTE_RETURN_ERROR_ON_MSG(input1->num_dimensions() > 2 && reshape_info.reinterpret_input_as_3d(),
"The input1 tensor cannot have more than 2 dimensions if input0 has to be reinterpreted as 3D");
65 && (!reshape_info.broadcast_bias()),
66 "Bias addition only supported with broadcast mode in case the input or output has to be reinterpreted as 3D");
68 if(!is_interleaved_transposed)
74 const unsigned int m = reshape_info.reinterpret_input_as_3d() ? input0->dimension(1) * input0->dimension(2) : input0->dimension(1);
75 const unsigned int n = input1->dimension(0);
76 const unsigned int input2_dim0 = input2->dimension(0);
77 const unsigned int input2_dim1 = input2->dimension(1);
80 if(reshape_info.broadcast_bias())
92 GEMMRHSMatrixInfo rhs_info;
93 GEMMLHSMatrixInfo lhs_info;
94 const auto m = static_cast<unsigned int>(reshape_info.m());
95 const auto n = static_cast<unsigned int>(reshape_info.n());
96 const int k = reshape_info.k();
97 const int mult_transpose1xW_width = reshape_info.mult_transpose1xW_width();
98 const int mult_interleave4x4_height = reshape_info.mult_interleave4x4_height();
99 rhs_info.n0 = max_cl_vector_width / input1->element_size();
101 rhs_info.h0 = mult_transpose1xW_width;
102 rhs_info.interleave =
false;
103 rhs_info.transpose =
false;
106 lhs_info.v0 = mult_interleave4x4_height;
107 lhs_info.interleave =
true;
108 lhs_info.transpose =
true;
110 TensorShape tensor_shape0{ input0->tensor_shape() };
111 tensor_shape0.set(0, k);
112 tensor_shape0.set(1, m);
114 TensorShape tensor_shape1{ input1->tensor_shape() };
115 tensor_shape1.set(0, n);
116 tensor_shape1.set(1, k);
118 const TensorInfo tensor_info0 = input0->clone()->set_tensor_shape(tensor_shape0);
119 const TensorInfo tensor_info1 = input1->clone()->set_tensor_shape(tensor_shape1);
121 const TensorInfo tensor_info_reshaped0 = input0->clone()->set_tensor_shape(
compute_lhs_reshaped_shape(tensor_info0, lhs_info));
122 const TensorInfo tensor_info_reshaped1 = input1->clone()->set_tensor_shape(
compute_rhs_reshaped_shape(tensor_info1, rhs_info));
129 const unsigned int input2_dim0 = input2->dimension(0);
130 const unsigned int input2_dim1 = input2->dimension(1);
133 if(reshape_info.broadcast_bias())
144 if(output->total_size() != 0)
146 const TensorInfo tensor_info_output = output->clone()->set_tensor_shape(
compute_mm_shape(*input0, *input1, is_interleaved_transposed, reshape_info));
154 inline std::pair<Status, Window> validate_and_configure_window(ITensorInfo *input0, ITensorInfo *input1, ITensorInfo *input2, ITensorInfo *output,
155 float beta,
bool is_interleaved_transposed,
const GEMMReshapeInfo &reshape_info,
GPUTarget gpu_target,
156 ElementsProcessed &num_elements_processed)
159 bool window_changed =
false;
164 unsigned int &num_elems_processed_per_iteration_x = num_elements_processed[0];
165 unsigned int &num_elems_processed_per_iteration_y = num_elements_processed[1];
166 bool reinterpret_input_as_3d = reshape_info.reinterpret_input_as_3d();
167 bool reinterpret_output_as_3d = (reshape_info.depth_output_gemm3d() != 0);
171 if(reinterpret_input_as_3d == reinterpret_output_as_3d)
173 reinterpret_input_as_3d =
false;
174 reinterpret_output_as_3d =
false;
180 TensorInfo tmp_info(*output);
182 if(reinterpret_output_as_3d)
186 TensorShape tmp_shape(output->tensor_shape());
187 tmp_shape.collapse(2U, 1U);
188 tmp_info.set_tensor_shape(tmp_shape);
191 if(is_interleaved_transposed)
198 num_elems_processed_per_iteration_y = 4;
200 win =
calculate_max_window(tmp_info, Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y));
201 if(input2 !=
nullptr)
203 const int bias_processed_per_iteration_x = num_elems_processed_per_iteration_x;
205 const int bias_processed_per_iteration_y = reshape_info.broadcast_bias() ? 1 : num_elems_processed_per_iteration_y;
207 AccessWindowStatic input2_access(input2, 0, 0,
218 num_elems_processed_per_iteration_y = std::min(static_cast<int>(output->dimension(1)), 4);
224 num_elems_processed_per_iteration_x = (input1->dimension(0) <= 1000 && input0->num_dimensions() == 1) ? 2 : 4;
228 win =
calculate_max_window(tmp_info, Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y));
229 win_out =
calculate_max_window(*output, Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y));
230 AccessWindowStatic input0_access(input0, 0, 0, input0->dimension(0), input0->dimension(1));
231 AccessWindowStatic input1_access(input1, 0, 0,
ceil_to_multiple(input1->dimension(0), num_elems_processed_per_iteration_x), input1->dimension(1));
232 AccessWindowStatic output_access(output, 0, 0,
233 output->dimension(0),
234 output->dimension(1));
236 if(input2 !=
nullptr)
238 const int bias_processed_per_iteration_x = num_elems_processed_per_iteration_x;
240 AccessWindowStatic input2_access(input2, 0, 0,
242 input2->dimension(1));
256 Window collapsed = win;
257 const unsigned int dimension_to_collapse = std::min(static_cast<unsigned int>(output->num_dimensions()), 2u);
258 collapsed = win.collapse(win, dimension_to_collapse);
261 return std::make_pair(err, collapsed);
266 : _input0(nullptr), _input1(nullptr), _input2(nullptr), _output(nullptr), _slide_matrix_b(true), _reinterpret_input_as_3d(false), _reinterpret_output_as_3d(false), _add_bias(false),
267 _broadcast_bias(false)
274 configure(
CLKernelLibrary::get().get_compile_context(), input0, input1, input2, output, alpha, beta, is_interleaved_transposed, reshape_info, fp_mixed_precision, activation_info);
285 is_interleaved_transposed, reshape_info, fp_mixed_precision));
316 ElementsProcessed num_elements_processed{};
319 auto win_config = validate_and_configure_window(input0->
info(), input1->
info(), (input2 !=
nullptr) ? input2->
info() :
nullptr, output->
info(), beta, is_interleaved_transposed, reshape_info,
320 gpu_target, num_elements_processed);
322 ICLKernel::configure_internal(win_config.second);
333 const unsigned int m0 = num_elements_processed.y();
334 const unsigned int n0 = num_elements_processed.x();
337 const unsigned int partial_store_m0 = internal_m % m0;
338 const unsigned int partial_store_n0 = n % n0;
346 build_opts.
add_option_if(reshape_info.broadcast_bias(),
"-DBROADCAST_BIAS");
360 if(is_interleaved_transposed)
362 const int mult_transpose1xW_width = reshape_info.mult_transpose1xW_width();
363 const int mult_interleave4x4_height = reshape_info.mult_interleave4x4_height();
432 _config_id =
"gemm_";
433 _config_id += (is_interleaved_transposed ?
"reshaped_" :
"");
434 _config_id += (
_add_bias ?
"add_bias_" :
"");
436 _config_id += (fp_mixed_precision ?
"fp_mixed_" :
"");
458 ElementsProcessed num_elements_processed{};
463 input1->
clone().get(),
464 (input2 !=
nullptr) ? input2->
clone().get() :
nullptr,
465 output->
clone().get(),
467 is_interleaved_transposed,
470 num_elements_processed)
500 _kernel.setArg<cl_uint>(idx0, static_cast<unsigned int>(total_cross_plane_pad));
508 _kernel.setArg<cl_uint>(idx0, static_cast<unsigned int>(total_cross_plane_pad));
518 slice_b = slice_matrix_b;
521 unsigned int idx = 0;
unsigned int top
top of the border
virtual size_t num_dimensions() const =0
The number of dimensions of the tensor (rank)
bool is_one(float a, float epsilon=0.00001f)
Checks if the input floating point number is 1.0f checking if the difference is within a range define...
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
#define ARM_COMPUTE_RETURN_ERROR_ON_F16_UNSUPPORTED(tensor)
const Window & window() const
The maximum window the kernel can be executed on.
std::unordered_map< const ITensorInfo *, PaddingSize > get_padding_info(std::initializer_list< const ITensorInfo * > infos)
Stores padding information before configuring a kernel.
bool enabled() const
Check if initialised.
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
void enqueue(cl::CommandQueue &queue, ICLKernel &kernel, const Window &window, const cl::NDRange &lws_hint=CLKernelLibrary::get().default_ndrange(), bool use_dummy_work_items=false)
Add the kernel to the command queue with the given window.
const StringSet & options() const
Gets the current options list set.
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
void set_lws_hint(const cl::NDRange &lws_hint)
Set the Local-Workgroup-Size hint.
const ICLTensor * _input2
float a() const
Get the alpha value.
GEMM reshape information class.
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
std::string to_string(T &&value)
Convert integer and float values to string.
virtual DataType data_type() const =0
Data type used for each element of the tensor.
TensorShape compute_mm_shape(const ITensorInfo &input0, const ITensorInfo &input1, bool is_interleaved_transposed, const GEMMReshapeInfo &reshape_info)
Calculate the matrix multiplication output shape of two tensors.
1 channel, 1 F32 per channel
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
const std::string & string_from_activation_func(ActivationLayerInfo::ActivationFunction act)
Translates a given activation function to a string.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
Store the tensor's metadata.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Describe one of the image's dimensions with a start, end and step.
unsigned int bottom
bottom of the border
GPUTarget get_arch_from_target(GPUTarget target)
Helper function to get the GPU arch.
std::string lower_string(const std::string &val)
Lower a given string.
#define ARM_COMPUTE_RETURN_ERROR_ON(cond)
If the condition is true, an error is returned.
Activation Layer Information class.
CLGEMMMatrixMultiplyKernel()
Default constructor.
static Status validate(const ITensorInfo *input0, const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, float alpha, float beta, bool is_interleaved_transposed, const GEMMReshapeInfo &reshape_info, GPUTarget gpu_target, bool fp_mixed_precision=false, const ActivationLayerInfo &activation_info=ActivationLayerInfo())
Static function to check if given info will lead to a valid configuration of CLGEMMMatrixMultiplyKern...
Copyright (c) 2017-2021 Arm Limited.
1 channel, 1 F16 per channel
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
void add_option(std::string option)
Adds option to the existing build option list.
bool _reinterpret_input_as_3d
void configure(const ICLTensor *input0, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, float alpha, float beta=0.f, bool is_interleaved_transposed=true, const GEMMReshapeInfo &reshape_info=GEMMReshapeInfo(), bool fp_mixed_precision=false, const ActivationLayerInfo &activation_info=ActivationLayerInfo())
Initialise the kernel's input, output and alpha.
cl::Kernel create_kernel(const CLCompileContext &ctx, const std::string &kernel_name, const std::set< std::string > &build_opts=std::set< std::string >())
Creates an opencl kernel using a compile context.
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
TensorShape compute_lhs_reshaped_shape(const ITensorInfo &a, const GEMMLHSMatrixInfo &lhs_info, bool reinterpret_input_as_3d=false)
Calculate the Left Hand Side matrix reshaped shape.
const ICLTensor * _input1
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
auto ceil_to_multiple(S value, T divisor) -> decltype(((value+divisor - 1)/divisor) *divisor)
Computes the smallest number larger or equal to value that is a multiple of divisor.
GPUTarget get_target() const
Get the targeted GPU architecture.
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
TensorShape compute_rhs_reshaped_shape(const ITensorInfo &a, const GEMMRHSMatrixInfo &rhs_info)
Calculate the Right Hand Side matrix reshaped shape.
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
size_t data_size_from_type(DataType data_type)
The size in bytes of the data type.
void add_option_if(bool cond, std::string option)
Adds option if a given condition is true;.
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
virtual PaddingSize padding() const =0
Padding of tensor.
static constexpr unsigned int num_arguments_per_2D_tensor()
Returns the number of arguments enqueued per 2D tensor object.
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
bool has_padding_changed(const std::unordered_map< const ITensorInfo *, PaddingSize > &padding_map)
Check if the previously stored padding info has changed after configuring a kernel.
const ICLTensor * _input0
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
void add_2D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx.
Interface for OpenCL tensor.
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(...)
#define ARM_COMPUTE_CREATE_ERROR(error_code, msg)
Creates an error with a given message.
GPUTarget
Available GPU Targets.
Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context.
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(...)
#define ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
bool _reinterpret_output_as_3d
Wrapper to configure the Khronos OpenCL C++ header.
bool is_zero(float a, float epsilon=0.00001f)
Checks if the input floating point number is 0.0f checking if the difference is within a range define...
#define ARM_COMPUTE_RETURN_ERROR_ON_MSG(cond, msg)
If the condition is true, an error is returned.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
ActivationFunction activation() const
Get the type of activation function.
float b() const
Get the beta value.
virtual const Strides & strides_in_bytes() const =0
The strides in bytes for accessing each dimension of the tensor.
Window first_slice_window_3D() const
First 3D slice of the window.
DataType
Available data types.
Describe a multidimensional execution window.
bool is_data_type_float(DataType dt)
Check if a given data type is of floating point type.
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)