CLBatchToSpaceLayerKernel Class Reference

Interface for the batch to space kernel. More...

#include <CLBatchToSpaceLayerKernel.h>

Collaboration diagram for CLBatchToSpaceLayerKernel:

Public Member Functions
	CLBatchToSpaceLayerKernel ()
	Default constructor. More...
	CLBatchToSpaceLayerKernel (const CLBatchToSpaceLayerKernel &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
CLBatchToSpaceLayerKernel &	operator= (const CLBatchToSpaceLayerKernel &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
	CLBatchToSpaceLayerKernel (CLBatchToSpaceLayerKernel &&)=default
	Allow instances of this class to be moved. More...
CLBatchToSpaceLayerKernel &	operator= (CLBatchToSpaceLayerKernel &&)=default
	Allow instances of this class to be moved. More...
	~CLBatchToSpaceLayerKernel ()=default
	Default destructor. More...
void	configure (const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output)
	Initialise the kernel's inputs and output. More...
void	configure (const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output)
	Initialise the kernel's inputs and output. More...
void	configure (const ICLTensor *input, const int32_t block_shape_x, const int32_t block_shape_y, ICLTensor *output, const CropInfo &crop_info)
	Initialise the kernel's inputs and output (Static block shape). More...
void	configure (const CLCompileContext &compile_context, const ICLTensor *input, const int32_t block_shape_x, const int32_t block_shape_y, ICLTensor *output, const CropInfo &crop_info)
	Initialise the kernel's inputs and output (Static block shape). 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...
CLKernelType	type () const
	Returns the CL kernel type. 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...
void	add_5D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
	Add the passed 5D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
void	add_3d_tensor_nhw_argument (unsigned int &idx, const ICLTensor *tensor)
	Add the passed NHW 3D tensor's parameters to the object's kernel's arguments by passing strides, dimensions and the offset to the first valid element in bytes. More...
void	add_4d_tensor_nhwc_argument (unsigned int &idx, const ICLTensor *tensor)
	Add the passed NHWC 4D tensor's parameters to the object's kernel's arguments by passing strides, dimensions and the offset to the first valid element in bytes. 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...
cl::NDRange	get_cached_gws () const
	Get the cached gws used to enqueue this kernel. More...
void	cache_gws (const cl::NDRange &gws)
	Cache the latest gws used to enqueue this kernel. 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 Window &	window () const
	The maximum window the kernel can be executed on. More...
bool	is_window_configured () const
	Function to check if the embedded window of this kernel has been configured. More...

Static Public Member Functions
static Status	validate (const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output)
	Static function to check if given info will lead to a valid configuration of CLBatchToSpaceLayerKernel. More...
static Status	validate (const ITensorInfo *input, const int32_t block_shape_x, const int32_t block_shape_y, const ITensorInfo *output, const CropInfo &crop_info)
	Static function to check if given info will lead to a valid configuration of CLBatchToSpaceLayerKernel (Static block shape). More...
Static Public Member Functions inherited from ICLKernel
constexpr static unsigned int	num_arguments_per_3d_tensor_nhw ()
	Returns the number of arguments enqueued per NHW 3D Tensor object. More...
constexpr static unsigned int	num_arguments_per_4d_tensor_nhwc ()
	Returns the number of arguments enqueued per NHWC 4D Tensor object. More...
constexpr static unsigned int	num_arguments_per_1D_array ()
	Returns the number of arguments enqueued per 1D array object. More...
constexpr static unsigned int	num_arguments_per_1D_tensor ()
	Returns the number of arguments enqueued per 1D tensor object. More...
constexpr static unsigned int	num_arguments_per_2D_tensor ()
	Returns the number of arguments enqueued per 2D tensor object. More...
constexpr static unsigned int	num_arguments_per_3D_tensor ()
	Returns the number of arguments enqueued per 3D tensor object. More...
constexpr static 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, bool use_dummy_work_items)
	Get the global work size given an execution window. More...

Detailed Description

Interface for the batch to space kernel.

Definition at line 36 of file CLBatchToSpaceLayerKernel.h.

Constructor & Destructor Documentation

CLBatchToSpaceLayerKernel() [1/3]

CLBatchToSpaceLayerKernel

(

)

Default constructor.

Definition at line 88 of file CLBatchToSpaceLayerKernel.cpp.

                                                     : _input(nullptr), _block_shape(nullptr), _output(nullptr)
{
    _type = CLKernelType::ELEMENTWISE;
}

References arm_compute::ELEMENTWISE.

CLBatchToSpaceLayerKernel() [2/3]

CLBatchToSpaceLayerKernel ( const CLBatchToSpaceLayerKernel &  )

delete

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

CLBatchToSpaceLayerKernel() [3/3]

CLBatchToSpaceLayerKernel ( CLBatchToSpaceLayerKernel &&  )

default

Allow instances of this class to be moved.

~CLBatchToSpaceLayerKernel()

~CLBatchToSpaceLayerKernel ( )

default

Default destructor.

Member Function Documentation

configure() [1/4]

void configure	(	const CLCompileContext &	compile_context,
		const ICLTensor *	input,
		const ICLTensor *	block_shape,
		ICLTensor *	output
	)

Initialise the kernel's inputs and output.

Parameters

[in]	compile_context	The compile context to be used.
[in]	input	Tensor input. Supported tensor rank: 4. Data types supported: All.
[in]	block_shape	1-D tensor with shape [M]. Data types supported: S32
[out]	output	Tensor output. Data types supported: same as input

Deprecated:

This method for dynamic block shape is not fully mature and will be removed in 23.08 release

Definition at line 98 of file CLBatchToSpaceLayerKernel.cpp.

{
    ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
 
    auto padding_info = get_padding_info({input, block_shape, output});
 
    ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), block_shape->info(), output->info()));
 
    _input       = input;
    _block_shape = block_shape;
    _output      = output;
 
    // Create kernel
    CLBuildOptions build_opts;
    build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(output->info()->data_type()));
    build_opts.add_option("-DBATCH_SIZE=" + support::cpp11::to_string(output->info()->dimension(3)));
    _kernel = create_kernel(compile_context,
                            "batch_to_space_" + lower_string(string_from_data_layout(input->info()->data_layout())),
                            build_opts.options());
 
    // Configure kernel window
    Window win = calculate_max_window(*output->info(), Steps());
    ICLKernel::configure_internal(win);
 
    ARM_COMPUTE_ERROR_ON(has_padding_changed(padding_info));
}

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::calculate_max_window(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), 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::lower_string(), CLBuildOptions::options(), arm_compute::string_from_data_layout(), arm_compute::support::cpp11::to_string(), and arm_compute::cpu::kernels::validate_arguments().

configure() [2/4]

void configure	(	const CLCompileContext &	compile_context,
		const ICLTensor *	input,
		const int32_t	block_shape_x,
		const int32_t	block_shape_y,
		ICLTensor *	output,
		const CropInfo &	crop_info
	)

Initialise the kernel's inputs and output (Static block shape).

Parameters

[in]	compile_context	The compile context to be used.
[in]	input	Tensor input. Supported tensor rank: 4. Data types supported: All.
[in]	block_shape_x	Block shape x value.
[in]	block_shape_y	Block shape y value.
[out]	output	Tensor output. Data types supported: same as input
[in]	crop_info	Specifies how the output shape is cropped after batch to space is performed

Definition at line 137 of file CLBatchToSpaceLayerKernel.cpp.

{
    ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
 
    const TensorShape output_shape = compute_batch_to_space_shape(
        input->info()->data_layout(), input->info()->tensor_shape(), block_shape_x, block_shape_y);
    auto_init_if_empty(*output->info(), input->info()->clone()->set_tensor_shape(output_shape));
 
    ARM_COMPUTE_ERROR_THROW_ON(
        validate_arguments_static(input->info(), block_shape_x, block_shape_y, output->info(), crop_info));
 
    _input  = input;
    _output = output;
 
    // Create kernel
    CLBuildOptions build_opts;
    build_opts.add_option("-DDATA_TYPE=" +
                          get_cl_unsigned_type_from_element_size(data_size_from_type(input->info()->data_type())));
    build_opts.add_option("-DBATCH_SIZE=" + support::cpp11::to_string(output->info()->dimension(3)));
    build_opts.add_option("-DBLOCK_SHAPE_X=" + support::cpp11::to_string(block_shape_x));
    build_opts.add_option("-DBLOCK_SHAPE_Y=" + support::cpp11::to_string(block_shape_y));
    build_opts.add_option("-DCROP_LEFT=" + support::cpp11::to_string(crop_info.left));
    build_opts.add_option("-DCROP_TOP=" + support::cpp11::to_string(crop_info.top));
    _kernel = create_kernel(
        compile_context, "batch_to_space_static_" + lower_string(string_from_data_layout(input->info()->data_layout())),
        build_opts.options());
 
    // Configure kernel window
    Window win = calculate_max_window(*output->info(), Steps());
    ICLKernel::configure_internal(win);
}

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), arm_compute::calculate_max_window(), arm_compute::misc::shape_calculator::compute_batch_to_space_shape(), arm_compute::create_kernel(), arm_compute::data_size_from_type(), ITensorInfo::dimension(), arm_compute::get_cl_unsigned_type_from_element_size(), ITensor::info(), arm_compute::test::validation::input, Padding2D::left, arm_compute::lower_string(), CLBuildOptions::options(), arm_compute::test::validation::output_shape, arm_compute::string_from_data_layout(), arm_compute::support::cpp11::to_string(), and Padding2D::top.

configure() [3/4]

void configure	(	const ICLTensor *	input,
		const ICLTensor *	block_shape,
		ICLTensor *	output
	)

Initialise the kernel's inputs and output.

Parameters

[in]	input	Tensor input. Supported tensor rank: 4. Data types supported: All.
[in]	block_shape	1-D tensor with shape [M]. Data types supported: S32
[out]	output	Tensor output. Data types supported: same as input

Deprecated:

This method for dynamic block shape is not fully mature and will be removed in 23.08 release

Definition at line 93 of file CLBatchToSpaceLayerKernel.cpp.

{
    configure(CLKernelLibrary::get().get_compile_context(), input, block_shape, output);
}

References CLKernelLibrary::get(), and arm_compute::test::validation::input.

Referenced by CLBatchToSpaceLayerKernel::configure().

configure() [4/4]

void configure	(	const ICLTensor *	input,
		const int32_t	block_shape_x,
		const int32_t	block_shape_y,
		ICLTensor *	output,
		const CropInfo &	crop_info
	)

Initialise the kernel's inputs and output (Static block shape).

Parameters

[in]	input	Tensor input. Supported tensor rank: 4. Data types supported: All.
[in]	block_shape_x	Block shape x value.
[in]	block_shape_y	Block shape y value.
[out]	output	Tensor output. Data types supported: same as input
[in]	crop_info	Specifies how the output shape is cropped after batch to space is performed

Definition at line 128 of file CLBatchToSpaceLayerKernel.cpp.

{
    configure(CLKernelLibrary::get().get_compile_context(), input, block_shape_x, block_shape_y, output, crop_info);
}

References CLBatchToSpaceLayerKernel::configure(), CLKernelLibrary::get(), and arm_compute::test::validation::input.

operator=() [1/2]

CLBatchToSpaceLayerKernel& operator= ( CLBatchToSpaceLayerKernel &&  )

default

Allow instances of this class to be moved.

operator=() [2/2]

CLBatchToSpaceLayerKernel& operator= ( const CLBatchToSpaceLayerKernel &  )

delete

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

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]	window	Region on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]	queue	Command queue on which to enqueue the kernel.

Reimplemented from ICLKernel.

Definition at line 193 of file CLBatchToSpaceLayerKernel.cpp.

{
    ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this);
    ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(ICLKernel::window(), window);
 
    Window slice_out = window.first_slice_window_3D();
    Window slice_in  = window.first_slice_window_4D();
 
    Window vector_slice = window.first_slice_window_1D();
    vector_slice.set(Window::DimX, Window::Dimension(0, 0, 0));
 
    slice_in.set(Window::DimX, Window::Dimension(0, 0, 0));
    slice_in.set(Window::DimY, Window::Dimension(0, 0, 0));
    slice_in.set(Window::DimZ, Window::Dimension(0, 0, 0));
    slice_in.set(3, Window::Dimension(0, 0, 0));
 
    int batch_id = 0;
    do
    {
        unsigned int idx = 0;
        add_4D_tensor_argument(idx, _input, slice_in);
        add_argument(idx, batch_id);
        if (_block_shape != nullptr)
        {
            add_1D_tensor_argument(idx, _block_shape, vector_slice);
        }
        add_3D_tensor_argument(idx, _output, slice_out);
        enqueue(queue, *this, slice_out, lws_hint());
 
        ++batch_id;
    } while (window.slide_window_slice_3D(slice_out));
}

References ICLKernel::add_1D_tensor_argument(), ICLKernel::add_3D_tensor_argument(), ICLKernel::add_4D_tensor_argument(), ICLKernel::add_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::DimX, Window::DimY, Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_1D(), Window::first_slice_window_3D(), Window::first_slice_window_4D(), ICLKernel::lws_hint(), Window::set(), Window::slide_window_slice_3D(), and IKernel::window().

validate() [1/2]

Status validate ( const ITensorInfo *  input, const int32_t  block_shape_x, const int32_t  block_shape_y, const ITensorInfo *  output, const CropInfo &  crop_info  )

static

Static function to check if given info will lead to a valid configuration of CLBatchToSpaceLayerKernel (Static block shape).

Parameters

[in]	input	Tensor input. Supported tensor rank: 4. Data types supported: All.
[in]	block_shape_x	Block shape x value.
[in]	block_shape_y	Block shape y value.
[in]	output	Tensor output. Data types supported: same as input
[in]	crop_info	Specifies how the output shape is cropped after batch to space is performed

Returns

a status

Definition at line 182 of file CLBatchToSpaceLayerKernel.cpp.

{
    ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, output);
    ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments_static(input, block_shape_x, block_shape_y, output, crop_info));
    return Status{};
}

References ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, and arm_compute::test::validation::input.

validate() [2/2]

Status validate ( const ITensorInfo *  input, const ITensorInfo *  block_shape, const ITensorInfo *  output  )

static

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

Parameters

[in]	input	Tensor input. Supported tensor rank: 4. Data types supported: All.
[in]	block_shape	1-D tensor with shape [M]. Data types supported: S32
[in]	output	Tensor output. Data types supported: same as input

Returns

a status

Deprecated:

This method for dynamic block shape is not fully mature and will be removed in 23.08 release

Definition at line 175 of file CLBatchToSpaceLayerKernel.cpp.

{
    ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, block_shape, output);
    ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, block_shape, output));
    return Status{};
}

References ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, arm_compute::test::validation::input, and arm_compute::cpu::kernels::validate_arguments().

Referenced by CLBatchToSpaceLayer::validate().

---

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

• src/core/CL/kernels/CLBatchToSpaceLayerKernel.h
• src/core/CL/kernels/CLBatchToSpaceLayerKernel.cpp