Compute Library
 21.02
CLDepthConvertLayerKernel Class Reference

Interface for the depth conversion kernel. More...

#include <CLDepthConvertLayerKernel.h>

Collaboration diagram for CLDepthConvertLayerKernel:
[legend]

Public Member Functions

void configure (const ICLTensor *input, ICLTensor *output, ConvertPolicy policy, uint32_t shift)
 Set the input and output of the kernel. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, ConvertPolicy policy, uint32_t shift)
 Set the input and output of the kernel. More...
 
- Public Member Functions inherited from ICLSimple3DKernel
void run (const Window &window, cl::CommandQueue &queue) override
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
- Public Member Functions inherited from ICLSimpleKernel
 ICLSimpleKernel ()
 Constructor. More...
 
 ICLSimpleKernel (const ICLSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICLSimpleKerneloperator= (const ICLSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICLSimpleKernel (ICLSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
ICLSimpleKerneloperator= (ICLSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~ICLSimpleKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined=false, const BorderSize &border_size=BorderSize())
 Configure the kernel. More...
 
- Public Member Functions inherited from ICLKernel
 ICLKernel ()
 Constructor. More...
 
cl::Kernel & kernel ()
 Returns a reference to the OpenCL kernel of this object. More...
 
template<typename T >
void add_1D_array_argument (unsigned int &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed 1D array's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
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. More...
 
void add_2D_tensor_argument_if (bool cond, 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 if the condition is true. More...
 
void add_3D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_4D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 4D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
virtual void run_op (ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
template<typename T >
void add_argument (unsigned int &idx, T value)
 Add the passed parameters to the object's kernel's arguments starting from the index idx. More...
 
void set_lws_hint (const cl::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
cl::NDRange lws_hint () const
 Return the Local-Workgroup-Size hint. More...
 
void set_wbsm_hint (const cl_int &wbsm_hint)
 Set the workgroup batch size modifier hint. More...
 
cl_int wbsm_hint () const
 Return the workgroup batch size modifier hint. More...
 
const std::string & config_id () const
 Get the configuration ID. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
void set_target (cl::Device &device)
 Set the targeted GPU architecture according to the CL device. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. More...
 
size_t get_max_workgroup_size ()
 Get the maximum workgroup size for the device the CLKernelLibrary uses. More...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
template<typename T , unsigned int dimension_size>
void add_array_argument (unsigned &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed array's parameters to the object's kernel's arguments starting from the index idx. More...
 
- Public Member Functions inherited from IKernel
 IKernel ()
 Constructor. More...
 
virtual ~IKernel ()=default
 Destructor. More...
 
virtual bool is_parallelisable () const
 Indicates whether or not the kernel is parallelisable. More...
 
virtual BorderSize border_size () const
 The size of the border for that kernel. More...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input, const ITensorInfo *output, ConvertPolicy policy, uint32_t shift)
 Static function to check if given info will lead to a valid configuration of CLDepthConvertLayerKernel. More...
 
- Static Public Member Functions inherited from ICLKernel
static constexpr unsigned int num_arguments_per_1D_array ()
 Returns the number of arguments enqueued per 1D array object. More...
 
static constexpr unsigned int num_arguments_per_1D_tensor ()
 Returns the number of arguments enqueued per 1D tensor object. More...
 
static constexpr unsigned int num_arguments_per_2D_tensor ()
 Returns the number of arguments enqueued per 2D tensor object. More...
 
static constexpr unsigned int num_arguments_per_3D_tensor ()
 Returns the number of arguments enqueued per 3D tensor object. More...
 
static constexpr unsigned int num_arguments_per_4D_tensor ()
 Returns the number of arguments enqueued per 4D tensor object. More...
 
static cl::NDRange gws_from_window (const Window &window)
 Get the global work size given an execution window. More...
 

Detailed Description

Interface for the depth conversion kernel.

Definition at line 37 of file CLDepthConvertLayerKernel.h.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output,
ConvertPolicy  policy,
uint32_t  shift 
)

Set the input and output of the kernel.

Valid conversions Input -> Output :

  • QSYMM8_PER_CHANNEL -> QASYMM8 (ATTENTION: it is the user's responsibility to keep track of the quantization info in the TensorInfo meta-data)
  • U8 -> S8, U16, S16, U32, S32, F16, F32
  • U16 -> U8, S8, S16, U32, S32, F16, F32
  • S16 -> U8, S8, U16, U32, S32, F16, F32
  • U32 -> U8, S8, U16, S16, S32, F16, F32
  • S32 -> U8, S8, U16, S16, U32, F16, F32
  • F16 -> U8, S8, U16, S16, U32, F32
  • F32 -> U8, S8, U16, S16, U32, F16
Parameters
[in]inputThe input tensor to convert. Data types supported: U8/S8/QSYMM8_PER_CHANNEL/U16/S16/U32/S32/F16/F32.
[out]outputThe output tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
[in]policyConversion policy
[in]shiftValue for down/up conversions. Must be 0 <= shift < 8.

Definition at line 76 of file CLDepthConvertLayerKernel.cpp.

References CLKernelLibrary::get().

77 {
78  configure(CLKernelLibrary::get().get_compile_context(), input, output, policy, shift);
79 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *input, ICLTensor *output, ConvertPolicy policy, uint32_t shift)
Set the input and output of the kernel.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output,
ConvertPolicy  policy,
uint32_t  shift 
)

Set the input and output of the kernel.

Valid conversions Input -> Output :

  • QSYMM8_PER_CHANNEL -> QASYMM8 (ATTENTION: it is the user's responsibility to keep track of the quantization info in the TensorInfo meta-data)
  • U8 -> S8, U16, S16, U32, S32, F16, F32
  • U16 -> U8, S8, S16, U32, S32, F16, F32
  • S16 -> U8, S8, U16, U32, S32, F16, F32
  • U32 -> U8, S8, U16, S16, S32, F16, F32
  • S32 -> U8, S8, U16, S16, U32, F16, F32
  • F16 -> U8, S8, U16, S16, U32, F32
  • F32 -> U8, S8, U16, S16, U32, F16
Parameters
[in]compile_contextThe compile context to be used.
[in]inputThe input tensor to convert. Data types supported: U8/S8/QSYMM8_PER_CHANNEL/U16/S16/U32/S32/F16/F32.
[out]outputThe output tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
[in]policyConversion policy
[in]shiftValue for down/up conversions. Must be 0 <= shift < 8.

Definition at line 81 of file CLDepthConvertLayerKernel.cpp.

References CLBuildOptions::add_option(), arm_compute::adjust_vec_size(), ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::calculate_max_window(), Window::collapse_if_possible(), arm_compute::create_kernel(), arm_compute::data_size_from_type(), ITensorInfo::data_type(), ITensorInfo::dimension(), Window::DimZ, ITensorInfo::element_size(), arm_compute::get_cl_type_from_data_type(), arm_compute::get_padding_info(), arm_compute::has_padding_changed(), ITensor::info(), arm_compute::test::validation::input, arm_compute::test::validation::input_size, arm_compute::is_data_type_float(), arm_compute::is_data_type_quantized(), kernel_name, arm_compute::lower_string(), ICLKernel::num_arguments_per_3D_tensor(), num_elems_processed_per_iteration, arm_compute::test::validation::output_size, arm_compute::SATURATE, arm_compute::set_shape_if_empty(), ITensorInfo::set_valid_region(), arm_compute::string_from_data_type(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), ITensorInfo::valid_region(), arm_compute::validate_arguments(), and IKernel::window().

82 {
84 
85  _input = input;
86  _output = output;
87 
88  // Auto initialize output shape if not initialized (We can only auto-configure the shape, datatype must be given)
89  set_shape_if_empty(*output->info(), input->info()->tensor_shape());
90 
91  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), policy, shift));
92 
93  auto padding_info = get_padding_info({ input, output });
94 
95  // Get data sizes
96  const size_t input_size = data_size_from_type(input->info()->data_type());
97  const size_t output_size = data_size_from_type(output->info()->data_type());
98 
99  // Get number of elements to process per iterations
100  const unsigned int num_elems_processed_per_iteration = adjust_vec_size(16 / input->info()->element_size(), input->info()->dimension(0));
101 
102  // Set build options
103  CLBuildOptions build_opts;
104  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(num_elems_processed_per_iteration));
105  build_opts.add_option("-DVEC_SIZE_LEFTOVER=" + support::cpp11::to_string(input->info()->dimension(0) % num_elems_processed_per_iteration));
106  build_opts.add_option("-DDATA_TYPE_IN=" + get_cl_type_from_data_type(input->info()->data_type()));
107  build_opts.add_option("-DDATA_TYPE_OUT=" + get_cl_type_from_data_type(output->info()->data_type()));
108  // Conversions from float always SATURATE as out-of-bounds conversion from float->integer is implementation defined
109  build_opts.add_option_if(is_data_type_float(input->info()->data_type()) || policy == ConvertPolicy::SATURATE, "-DSATURATE");
110  build_opts.add_option_if(is_data_type_float(input->info()->data_type()) || is_data_type_float(output->info()->data_type()), "-DIS_DATA_TYPE_FLOAT");
111  build_opts.add_option_if(is_data_type_quantized(input->info()->data_type()), "-DIS_DATA_TYPE_QUANTIZED");
112 
113  // Create kernel
114  const std::string kernel_name = (input_size >= output_size) ? "convert_depth_down" : "convert_depth_up";
115  _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
116 
117  // Set shift arg
118  unsigned int idx = 2 * num_arguments_per_3D_tensor(); // Skip the input and output parameters
119  _kernel.setArg(idx++, shift);
120 
121  // Since we have a leftover vector size calculated using the input tensor shape, it is required to
122  // have the input region equal to the tensor shape
123  ValidRegion input_valid_region = input->info()->valid_region();
124  input->info()->set_valid_region(ValidRegion(Coordinates(0, 0), input->info()->tensor_shape()));
125 
126  // Configure kernel
127  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration));
128  ICLKernel::configure_internal(win);
129 
130  // Collapse window
131  const Window &full_window = window();
132  Window collapsed_window = full_window.collapse_if_possible(full_window, Window::DimZ);
133  ICLKernel::configure_internal(collapsed_window);
134 
135  // Restore the valid region
136  input->info()->set_valid_region(input_valid_region);
137 
139 
140  // Set config_id for enabling LWS tuning
141  _config_id = kernel_name;
142  _config_id += "_";
143  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
144  _config_id += "_";
145  _config_id += support::cpp11::to_string(input->info()->dimension(0));
146  _config_id += "_";
147  _config_id += support::cpp11::to_string(input->info()->dimension(1));
148  _config_id += "_";
149  _config_id += support::cpp11::to_string(output->info()->dimension(0));
150  _config_id += "_";
151  _config_id += support::cpp11::to_string(output->info()->dimension(1));
152 }
bool is_data_type_quantized(DataType dt)
Check if a given data type is of quantized type.
Definition: Utils.h:1168
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:350
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.
Definition: CLHelpers.cpp:403
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
static constexpr unsigned int num_arguments_per_3D_tensor()
Returns the number of arguments enqueued per 3D tensor object.
Definition: ICLKernel.h:214
std::string kernel_name
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:37
size_t data_size_from_type(DataType data_type)
The size in bytes of the data type.
Definition: Utils.h:106
bool set_shape_if_empty(ITensorInfo &info, const TensorShape &shape)
Set the shape to the specified value if the current assignment is empty.
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.
Definition: Utils.cpp:528
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
std::unordered_map< const ITensorInfo *, PaddingSize > get_padding_info(std::initializer_list< const ITensorInfo *> infos)
Stores padding information before configuring a kernel.
Definition: Utils.cpp:513
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
unsigned int num_elems_processed_per_iteration
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
unsigned int adjust_vec_size(unsigned int vec_size, size_t dim0)
Returns the adjusted vector size in case it is less than the input&#39;s first dimension, getting rounded down to its closest valid vector size.
Definition: Utils.h:1358
bool is_data_type_float(DataType dt)
Check if a given data type is of floating point type.
Definition: Utils.h:1148

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
ConvertPolicy  policy,
uint32_t  shift 
)
static

Static function to check if given info will lead to a valid configuration of CLDepthConvertLayerKernel.

Parameters
[in]inputSource tensor info. Data types supported: U8/S8/QSYMM8_PER_CHANNEL/U16/S16/U32/S32/F16/F32.
[in]outputDestination tensor info. Data type supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
[in]policyConversion policy
[in]shiftValue for down/up conversions. Must be 0 <= shift < 8.
Returns
a status

Definition at line 154 of file CLDepthConvertLayerKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, and arm_compute::validate_arguments().

Referenced by CLCast::validate(), CLDepthConvertLayer::validate(), and CLGEMMLowpMatrixMultiplyCore::validate().

155 {
156  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, policy, shift));
157 
158  return Status{};
159 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)

The documentation for this class was generated from the following files: