src/core/CL/kernels/CLBatchToSpaceLayerKernel.cpp - ml/ComputeLibrary - Gitiles

 /*
  * Copyright (c) 2018-2021, 2023 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to
  * deal in the Software without restriction, including without limitation the
  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  * sell copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
  * The above copyright notice and this permission notice shall be included in all
  * copies or substantial portions of the Software.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
 #include "src/core/CL/kernels/CLBatchToSpaceLayerKernel.h"

 #include "arm_compute/core/CL/CLHelpers.h"
 #include "arm_compute/core/CL/ICLTensor.h"
 #include "arm_compute/core/TensorInfo.h"
 #include "arm_compute/core/utils/misc/ShapeCalculator.h"
 #include "arm_compute/core/utils/StringUtils.h"

 #include "src/core/CL/CLValidate.h"
 #include "src/core/helpers/AutoConfiguration.h"
 #include "src/core/helpers/WindowHelpers.h"
 #include "support/StringSupport.h"

 using namespace arm_compute::misc::shape_calculator;
 namespace arm_compute
 {
 namespace
 {
 Status validate_arguments(const ITensorInfo *input, const ITensorInfo *block_info, const ITensorInfo *output)
 {
     ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, block_info, output);
     ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(block_info, 1, DataType::S32);
     ARM_COMPUTE_RETURN_ERROR_ON(input->num_dimensions() > 4);
     ARM_COMPUTE_RETURN_ERROR_ON(input->data_type() == DataType::UNKNOWN);

     // Validate output if initialized
     if (output->total_size() != 0)
     {
         ARM_COMPUTE_RETURN_ERROR_ON(output->num_dimensions() > 4);
         ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(input, output);
     }

     return Status{};
 }
 Status validate_arguments_static(const ITensorInfo *input,
                                  const int          block_shape_x,
                                  const int          block_shape_y,
                                  const ITensorInfo *output,
                                  const CropInfo    &crop_info)
 {
     ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, output);
     ARM_COMPUTE_RETURN_ERROR_ON(input->num_dimensions() > 4);
     ARM_COMPUTE_RETURN_ERROR_ON(block_shape_x <= 0);
     ARM_COMPUTE_RETURN_ERROR_ON(block_shape_y <= 0);

     const DataLayout data_layout = input->data_layout();
     const int        idx_batch   = get_data_layout_dimension_index(data_layout, DataLayoutDimension::BATCHES);
     ARM_COMPUTE_RETURN_ERROR_ON(input->tensor_shape()[idx_batch] % (block_shape_x * block_shape_y) != 0);

     // Validate output if initialized
     if (output->total_size() != 0)
     {
         const TensorShape expected_output_shape = compute_batch_to_space_shape(
             input->data_layout(), input->tensor_shape(), block_shape_x, block_shape_y, crop_info);
         const TensorInfo expected_output = output->clone()->set_tensor_shape(expected_output_shape);
         ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(output, &expected_output);
         ARM_COMPUTE_RETURN_ERROR_ON(output->num_dimensions() > 4);
         ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(input, output);
     }

     return Status{};
 }
 } // namespace

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

 void CLBatchToSpaceLayerKernel::configure(const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output)
 {
     configure(CLKernelLibrary::get().get_compile_context(), input, block_shape, output);
 }

 void CLBatchToSpaceLayerKernel::configure(const CLCompileContext &compile_context,
                                           const ICLTensor        *input,
                                           const ICLTensor        *block_shape,
                                           ICLTensor              *output)
 {
     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));
 }

 void CLBatchToSpaceLayerKernel::configure(const ICLTensor *input,
                                           const int32_t    block_shape_x,
                                           const int32_t    block_shape_y,
                                           ICLTensor       *output,
                                           const CropInfo  &crop_info)
 {
     configure(CLKernelLibrary::get().get_compile_context(), input, block_shape_x, block_shape_y, output, crop_info);
 }

 void CLBatchToSpaceLayerKernel::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)
 {
     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);
 }

 Status
 CLBatchToSpaceLayerKernel::validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output)
 {
     ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, block_shape, output);
     ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, block_shape, output));
     return Status{};
 }

 Status CLBatchToSpaceLayerKernel::validate(const ITensorInfo *input,
                                            const int32_t      block_shape_x,
                                            const int32_t      block_shape_y,
                                            const ITensorInfo *output,
                                            const CropInfo    &crop_info)
 {
     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{};
 }

 void CLBatchToSpaceLayerKernel::run(const Window &window, cl::CommandQueue &queue)
 {
     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));
 }
 } // namespace arm_compute
	/*
	* Copyright (c) 2018-2021, 2023 Arm Limited.
	*
	* SPDX-License-Identifier: MIT
	*
	* Permission is hereby granted, free of charge, to any person obtaining a copy
	* of this software and associated documentation files (the "Software"), to
	* deal in the Software without restriction, including without limitation the
	* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
	* sell copies of the Software, and to permit persons to whom the Software is
	* furnished to do so, subject to the following conditions:
	*
	* The above copyright notice and this permission notice shall be included in all
	* copies or substantial portions of the Software.
	*
	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	* SOFTWARE.
	*/
	#include "src/core/CL/kernels/CLBatchToSpaceLayerKernel.h"

	#include "arm_compute/core/CL/CLHelpers.h"
	#include "arm_compute/core/CL/ICLTensor.h"
	#include "arm_compute/core/TensorInfo.h"
	#include "arm_compute/core/utils/misc/ShapeCalculator.h"
	#include "arm_compute/core/utils/StringUtils.h"

	#include "src/core/CL/CLValidate.h"
	#include "src/core/helpers/AutoConfiguration.h"
	#include "src/core/helpers/WindowHelpers.h"
	#include "support/StringSupport.h"

	using namespace arm_compute::misc::shape_calculator;
	namespace arm_compute
	{
	namespace
	{
	Status validate_arguments(const ITensorInfo input, const ITensorInfo block_info, const ITensorInfo *output)
	{
	ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, block_info, output);
	ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(block_info, 1, DataType::S32);
	ARM_COMPUTE_RETURN_ERROR_ON(input->num_dimensions() > 4);
	ARM_COMPUTE_RETURN_ERROR_ON(input->data_type() == DataType::UNKNOWN);

	// Validate output if initialized
	if (output->total_size() != 0)
	{
	ARM_COMPUTE_RETURN_ERROR_ON(output->num_dimensions() > 4);
	ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(input, output);
	}

	return Status{};
	}
	Status validate_arguments_static(const ITensorInfo *input,
	const int block_shape_x,
	const int block_shape_y,
	const ITensorInfo *output,
	const CropInfo &crop_info)
	{
	ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, output);
	ARM_COMPUTE_RETURN_ERROR_ON(input->num_dimensions() > 4);
	ARM_COMPUTE_RETURN_ERROR_ON(block_shape_x <= 0);
	ARM_COMPUTE_RETURN_ERROR_ON(block_shape_y <= 0);

	const DataLayout data_layout = input->data_layout();
	const int idx_batch = get_data_layout_dimension_index(data_layout, DataLayoutDimension::BATCHES);
	ARM_COMPUTE_RETURN_ERROR_ON(input->tensor_shape()[idx_batch] % (block_shape_x * block_shape_y) != 0);

	// Validate output if initialized
	if (output->total_size() != 0)
	{
	const TensorShape expected_output_shape = compute_batch_to_space_shape(
	input->data_layout(), input->tensor_shape(), block_shape_x, block_shape_y, crop_info);
	const TensorInfo expected_output = output->clone()->set_tensor_shape(expected_output_shape);
	ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(output, &expected_output);
	ARM_COMPUTE_RETURN_ERROR_ON(output->num_dimensions() > 4);
	ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(input, output);
	}

	return Status{};
	}
	} // namespace

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

	void CLBatchToSpaceLayerKernel::configure(const ICLTensor input, const ICLTensor block_shape, ICLTensor *output)
	{
	configure(CLKernelLibrary::get().get_compile_context(), input, block_shape, output);
	}

	void CLBatchToSpaceLayerKernel::configure(const CLCompileContext &compile_context,
	const ICLTensor *input,
	const ICLTensor *block_shape,
	ICLTensor *output)
	{
	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));
	}

	void CLBatchToSpaceLayerKernel::configure(const ICLTensor *input,
	const int32_t block_shape_x,
	const int32_t block_shape_y,
	ICLTensor *output,
	const CropInfo &crop_info)
	{
	configure(CLKernelLibrary::get().get_compile_context(), input, block_shape_x, block_shape_y, output, crop_info);
	}

	void CLBatchToSpaceLayerKernel::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)
	{
	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);
	}

	Status
	CLBatchToSpaceLayerKernel::validate(const ITensorInfo input, const ITensorInfo block_shape, const ITensorInfo *output)
	{
	ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, block_shape, output);
	ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, block_shape, output));
	return Status{};
	}

	Status CLBatchToSpaceLayerKernel::validate(const ITensorInfo *input,
	const int32_t block_shape_x,
	const int32_t block_shape_y,
	const ITensorInfo *output,
	const CropInfo &crop_info)
	{
	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{};
	}

	void CLBatchToSpaceLayerKernel::run(const Window &window, cl::CommandQueue &queue)
	{
	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));
	}
	} // namespace arm_compute