Compute Library
 19.11
CLChannelShuffleLayerKernel Class Reference

Interface for the channel shuffle kernel. More...

#include <CLChannelShuffleLayerKernel.h>

Collaboration diagram for CLChannelShuffleLayerKernel:
[legend]

Public Member Functions

 CLChannelShuffleLayerKernel ()
 Default constructor. More...
 
 CLChannelShuffleLayerKernel (const CLChannelShuffleLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLChannelShuffleLayerKerneloperator= (const CLChannelShuffleLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLChannelShuffleLayerKernel (CLChannelShuffleLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLChannelShuffleLayerKerneloperator= (CLChannelShuffleLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLChannelShuffleLayerKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, unsigned int num_groups)
 Configure function's inputs and outputs. 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, unsigned int num_groups)
 Static function to check if given info will lead to a valid configuration of CLChannelShuffleLayerKernel. 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 channel shuffle kernel.

Definition at line 34 of file CLChannelShuffleLayerKernel.h.

Constructor & Destructor Documentation

◆ CLChannelShuffleLayerKernel() [1/3]

Default constructor.

Definition at line 90 of file CLChannelShuffleLayerKernel.cpp.

91  : _input(nullptr), _output(nullptr)
92 {
93 }

◆ CLChannelShuffleLayerKernel() [2/3]

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

◆ CLChannelShuffleLayerKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLChannelShuffleLayerKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output,
unsigned int  num_groups 
)

Configure function's inputs and outputs.

Parameters
[in]inputInput tensor. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[out]outputOutput tensor. Data type supported: Same as input
[in]num_groupsNumber of groups. Must be greater than 1 and the number of channels of the tensors must be a multiple of the number of groups.

Definition at line 95 of file CLChannelShuffleLayerKernel.cpp.

96 {
98 
99  _input = input;
100  _output = output;
101 
102  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), num_groups));
103 
104  const DataLayout data_layout = input->info()->data_layout();
105  const bool is_nhwc = data_layout == DataLayout::NHWC;
106  const unsigned int channels = input->info()->dimension(get_data_layout_dimension_index(data_layout, DataLayoutDimension::CHANNEL));
107  const unsigned int vec_size = is_nhwc ? 4 : max_cl_vector_width / input->info()->element_size();
108 
109  // Set kernel build options
110  CLBuildOptions build_opts;
111  build_opts.add_option("-DNUM_GROUPS=" + support::cpp11::to_string(num_groups));
112  build_opts.add_option("-DK=" + support::cpp11::to_string(channels / num_groups));
113  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(vec_size));
114  build_opts.add_option("-DSRC_DIM_Z=" + support::cpp11::to_string(input->info()->dimension(2)));
115  build_opts.add_option("-DLAST_ACCESSED=" + support::cpp11::to_string(std::max(static_cast<int>(channels - vec_size), 0)));
116  build_opts.add_option("-DDATA_TYPE=" + get_cl_unsigned_type_from_element_size(input->info()->element_size()));
117 
118  // Create kernel
119  std::string kernel_name = "channel_shuffle_" + lower_string(string_from_data_layout(data_layout));
120  ;
121  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
122 
123  // Configure kernel window
124  auto win_config = validate_and_configure_window(input->info(), output->info());
125  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
126  ICLKernel::configure_internal(win_config.second);
127 
128  // Set config_id for enabling LWS tuning
129  _config_id = kernel_name;
130  _config_id += "_";
131  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
132  _config_id += "_";
133  _config_id += support::cpp11::to_string(num_groups);
134  _config_id += "_";
135  _config_id += support::cpp11::to_string(input->info()->dimension(0));
136  _config_id += "_";
137  _config_id += support::cpp11::to_string(input->info()->dimension(1));
138  _config_id += "_";
139  _config_id += support::cpp11::to_string(input->info()->dimension(2));
140  _config_id += "_";
141  _config_id += support::cpp11::to_string(output->info()->dimension(0));
142  _config_id += "_";
143  _config_id += support::cpp11::to_string(output->info()->dimension(1));
144  _config_id += "_";
145  _config_id += support::cpp11::to_string(output->info()->dimension(2));
146 }
const DataLayout data_layout
Definition: Im2Col.cpp:146
std::string to_string(T &&value)
Convert integer and float values to string.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#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:333
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
const unsigned int num_groups
Definition: Im2Col.cpp:148
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
#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
Num samples, height, width, channels.
std::string get_cl_unsigned_type_from_element_size(size_t element_size)
Translates the element size to an unsigned integer data type.
Definition: CLHelpers.cpp:101
size_t get_data_layout_dimension_index(const DataLayout data_layout, const DataLayoutDimension data_layout_dimension)
Get the index of the given dimension.
Definition: Helpers.inl:327
DataLayout
[DataLayout enum definition]
Definition: Types.h:116

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::CHANNEL, arm_compute::create_kernel(), arm_compute::test::validation::data_layout, ITensorInfo::dimension(), CLKernelLibrary::get(), arm_compute::get_cl_unsigned_type_from_element_size(), arm_compute::get_data_layout_dimension_index(), ITensor::info(), arm_compute::test::validation::input, arm_compute::lower_string(), arm_compute::NHWC, arm_compute::test::validation::num_groups, CLBuildOptions::options(), arm_compute::string_from_data_layout(), arm_compute::string_from_data_type(), and arm_compute::support::cpp11::to_string().

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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 156 of file CLChannelShuffleLayerKernel.cpp.

157 {
160 
161  unsigned int idx = 0;
162  add_4D_tensor_argument(idx, _input, window);
163  add_4D_tensor_argument(idx, _output, window);
164  enqueue(queue, *this, window, lws_hint());
165 }
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
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
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.
Definition: ICLKernel.h:168
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941

References ICLKernel::add_4D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), ICLKernel::lws_hint(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
unsigned int  num_groups 
)
static

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

Parameters
[in]inputInput tensor info. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[in]outputOutput tensor info. Data type supported: Same as input
[in]num_groupsNumber of groups. Must be greater than 1 and the number of channels of the tensors must be a multiple of the number of groups.
Returns
a status

Definition at line 148 of file CLChannelShuffleLayerKernel.cpp.

149 {
150  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, num_groups));
151  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get()).first);
152 
153  return Status{};
154 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
const unsigned int num_groups
Definition: Im2Col.cpp:148

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

Referenced by CLChannelShuffleLayer::validate().


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