Compute Library
 19.08
CLYOLOLayerKernel Class Reference

Interface for the YOLO layer kernel that performs partial activation. More...

#include <CLYOLOLayerKernel.h>

Collaboration diagram for CLYOLOLayerKernel:
[legend]

Public Member Functions

 CLYOLOLayerKernel ()
 Default constructor. More...
 
 CLYOLOLayerKernel (const CLYOLOLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLYOLOLayerKerneloperator= (const CLYOLOLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLYOLOLayerKernel (CLYOLOLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLYOLOLayerKerneloperator= (CLYOLOLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLYOLOLayerKernel ()=default
 Default destructor. More...
 
void configure (ICLTensor *input, ICLTensor *output, const ActivationLayerInfo &act_info, int32_t num_classes)
 Set the input and output tensor. More...
 
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 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...
 
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...
 
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<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...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
- 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, const ActivationLayerInfo &act_info, int32_t num_classes)
 Static function to check if given info will lead to a valid configuration of CLYOLOLayerKernel. 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 YOLO layer kernel that performs partial activation.

For each box, activate only:

  • x and y position (channel 0 and 1 of each box)
  • objectiveness (channel 4 of each box)
  • classes (channel 5 to (classes - 5) of each box)

Definition at line 39 of file CLYOLOLayerKernel.h.

Constructor & Destructor Documentation

◆ CLYOLOLayerKernel() [1/3]

Default constructor.

Definition at line 98 of file CLYOLOLayerKernel.cpp.

99  : _input(nullptr), _output(nullptr), _run_in_place(false)
100 {
101 }

◆ CLYOLOLayerKernel() [2/3]

CLYOLOLayerKernel ( const CLYOLOLayerKernel )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ CLYOLOLayerKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLYOLOLayerKernel()

~CLYOLOLayerKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure()

void configure ( ICLTensor input,
ICLTensor output,
const ActivationLayerInfo act_info,
int32_t  num_classes 
)

Set the input and output tensor.

Note
If the output tensor is a nullptr, the activation function will be performed in-place
Parameters
[in,out]inputSource tensor. In case of output tensor = nullptr, this tensor will store the result of the activation function. Data types supported: F16/F32.
[out]outputDestination tensor. Data type supported: same as input
[in]act_infoActivation layer information.
[in]num_classesNumber of classes to activate (must be submultiple of input channels)

Definition at line 103 of file CLYOLOLayerKernel.cpp.

104 {
106 
107  _run_in_place = (output == nullptr) || (output == input);
108 
109  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), (output != nullptr) ? output->info() : nullptr, act_info, num_classes));
110 
111  const bool is_nchw = input->info()->data_layout() == DataLayout::NCHW;
112  const unsigned int num_elems_processed_per_iteration = is_nchw ? 16 / input->info()->element_size() : 1;
113  const DataType dt = input->info()->data_type();
114  float a_const = act_info.a();
115  float b_const = act_info.b();
116 
117  // Set build options
118  CLBuildOptions build_opts;
119  build_opts.add_option("-DACTIVATION_TYPE=" + lower_string(string_from_activation_func(act_info.activation())));
120  build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(dt));
121  build_opts.add_option("-DSELECT_DATA_TYPE=" + get_cl_select_type_from_data_type(dt));
122  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(num_elems_processed_per_iteration));
123  build_opts.add_option("-DA_VAL=" + float_to_string_with_full_precision(a_const));
124  build_opts.add_option("-DB_VAL=" + float_to_string_with_full_precision(b_const));
125  build_opts.add_option("-DNUM_CLASSES=" + support::cpp11::to_string(num_classes));
126  build_opts.add_option_if(_run_in_place, "-DIN_PLACE");
127 
128  // Create kernel
129  std::string kernel_name = std::string("yolo_layer_") + lower_string(string_from_data_layout(input->info()->data_layout()));
130  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
131 
132  // Make sure _kernel is initialized before calling the parent's configure
133  _input = input;
134  _output = output;
135 
136  // Configure kernel window
137  auto win_config = validate_and_configure_window(input->info(), (_run_in_place) ? nullptr : output->info());
138  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
139  ICLKernel::configure_internal(win_config.second);
140 
141  // Set config_id for enabling LWS tuning
142  _config_id = "yolo_layer_";
143  _config_id += lower_string(string_from_data_type(dt));
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 += lower_string(string_from_data_layout(input->info()->data_layout()));
150 }
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
std::string get_cl_select_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL select type.
Definition: CLHelpers.cpp:68
std::string to_string(T &&value)
Convert integer and float values to string.
const std::string & string_from_activation_func(ActivationLayerInfo::ActivationFunction act)
Translates a given activation function to a string.
Definition: Utils.cpp:170
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:327
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
Definition: Utils.h:1066
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:35
std::unique_ptr< Kernel > create_kernel()
Helper function to create and return a unique_ptr pointed to a CL/GLES kernel object.
Definition: Helpers.h:86
Num samples, channels, height, width.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
const std::string & string_from_data_layout(DataLayout dl)
Convert a data layout identity into a string.
Definition: Utils.cpp:132
DataType
Available data types.
Definition: Types.h:74

References arm_compute::test::validation::act_info, CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::data_layout(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), arm_compute::float_to_string_with_full_precision(), CLKernelLibrary::get(), arm_compute::get_cl_select_type_from_data_type(), arm_compute::get_cl_type_from_data_type(), ITensor::info(), arm_compute::lower_string(), arm_compute::NCHW, CLBuildOptions::options(), arm_compute::string_from_activation_func(), arm_compute::string_from_data_layout(), arm_compute::string_from_data_type(), arm_compute::support::cpp11::to_string(), and arm_compute::validate_and_configure_window().

◆ operator=() [1/2]

CLYOLOLayerKernel& operator= ( const CLYOLOLayerKernel )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

CLYOLOLayerKernel& operator= ( CLYOLOLayerKernel &&  )
default

Allow instances of this class to be moved.

◆ run()

void run ( const Window window,
cl::CommandQueue &  queue 
)
overridevirtual

Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.

Note
The queue is not flushed by this method, and therefore the kernel will not have been executed by the time this method returns.
Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]queueCommand queue on which to enqueue the kernel.

Implements ICLKernel.

Definition at line 161 of file CLYOLOLayerKernel.cpp.

162 {
165 
167  Window slice = collapsed.first_slice_window_3D();
168 
169  do
170  {
171  unsigned int idx = 0;
172  add_3D_tensor_argument(idx, _input, slice);
173  if(!_run_in_place)
174  {
175  add_3D_tensor_argument(idx, _output, slice);
176  }
177  enqueue(queue, *this, slice, lws_hint());
178  }
179  while(collapsed.slide_window_slice_3D(slice));
180 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
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.
Definition: ICLKernel.cpp:39
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:247
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.
Definition: ICLKernel.h:158
Window collapse_if_possible(const Window &full_window, size_t first, size_t last, bool *has_collapsed=nullptr) const
Collapse the dimensions between first and last if possible.
Definition: Window.inl:54
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse_if_possible(), Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_3D(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const ActivationLayerInfo act_info,
int32_t  num_classes 
)
static

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

Parameters
[in]inputSource tensor info. In case of output tensor info = nullptr, this tensor will store the result of the activation function. Data types supported: F16/F32.
[in]outputDestination tensor info. Data type supported: same as input
[in]act_infoActivation layer information.
[in]num_classesNumber of classes to activate (must be submultiple of input channels)
Returns
a status

Definition at line 152 of file CLYOLOLayerKernel.cpp.

153 {
154  const bool run_in_place = (output == nullptr) || (output == input);
155  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, act_info, num_classes));
156  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), (run_in_place) ? nullptr : output->clone().get()).first);
157 
158  return Status{};
159 }
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:193

References arm_compute::test::validation::act_info, ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), and arm_compute::validate_and_configure_window().

Referenced by CLYOLOLayer::validate().


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