Compute Library
 19.08
CLMinMaxLayerKernel Class Reference

Interface for the kernel to perform min max search on a 3D tensor. More...

#include <CLMinMaxLayerKernel.h>

Collaboration diagram for CLMinMaxLayerKernel:
[legend]

Public Member Functions

 CLMinMaxLayerKernel ()
 Default constructor. More...
 
 CLMinMaxLayerKernel (const CLMinMaxLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLMinMaxLayerKerneloperator= (const CLMinMaxLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLMinMaxLayerKernel (CLMinMaxLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLMinMaxLayerKerneloperator= (CLMinMaxLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (const ICLTensor *input, ICLTensor *output)
 Initialise the kernel's input and output. More...
 
void reset (cl::CommandQueue &queue)
 Resets global minimum and maximum. 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)
 Static function to check if given info will lead to a valid configuration of CLMinMaxLayerKernel. 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 kernel to perform min max search on a 3D tensor.

Definition at line 35 of file CLMinMaxLayerKernel.h.

Constructor & Destructor Documentation

◆ CLMinMaxLayerKernel() [1/3]

Default constructor.

Definition at line 83 of file CLMinMaxLayerKernel.cpp.

84  : _input(nullptr), _output(nullptr)
85 {
86 }

◆ CLMinMaxLayerKernel() [2/3]

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

◆ CLMinMaxLayerKernel() [3/3]

Allow instances of this class to be moved.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output 
)

Initialise the kernel's input and output.

Parameters
[in]inputInput tensor with at least 3 dimensions. The dimensions over the third will be interpreted as batches.Data types supported: F32.
[out]outputOutput tensor with shape [2, batches, ...] which stores the minimum and maximum values for each 3D input tensor. The dimensions over the second must match the batched dimensions of the input tensor. Data types supported: F32.

Definition at line 88 of file CLMinMaxLayerKernel.cpp.

89 {
90  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
91  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info()));
92 
93  _input = input;
94  _output = output;
95 
96  std::set<std::string> build_opts;
97  build_opts.emplace("-DWIDTH=" + support::cpp11::to_string(input->info()->dimension(0)));
98  build_opts.emplace("-DHEIGHT=" + support::cpp11::to_string(input->info()->dimension(1)));
99  build_opts.emplace("-DDEPTH=" + support::cpp11::to_string(input->info()->dimension(2)));
100 
101  // Create kernel
102  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel("minmax_layer", build_opts));
103 
104  auto win_config = validate_and_configure_window(input->info(), output->info());
105 
106  ARM_COMPUTE_ERROR_THROW_ON(std::get<0>(win_config));
107 
108  ICLKernel::configure_internal(std::get<1>(win_config));
109 }
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
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 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:327
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
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

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::dimension(), CLKernelLibrary::get(), ITensor::info(), arm_compute::support::cpp11::to_string(), and arm_compute::validate_and_configure_window().

◆ operator=() [1/2]

CLMinMaxLayerKernel& operator= ( const CLMinMaxLayerKernel )
delete

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

◆ operator=() [2/2]

CLMinMaxLayerKernel& operator= ( CLMinMaxLayerKernel &&  )
default

Allow instances of this class to be moved.

◆ reset()

void reset ( cl::CommandQueue &  queue)

Resets global minimum and maximum.

Parameters
[in,out]queueCommand queue on which to map and unmap the min_max tensor

Definition at line 119 of file CLMinMaxLayerKernel.cpp.

120 {
121  _output->map(queue, true);
122 
123  Window window_output;
124  window_output.use_tensor_dimensions(_output->info()->tensor_shape());
125  window_output.set(Window::DimX, Window::Dimension(0, 1, 1));
126 
127  Iterator output(_output, window_output);
128 
129  // Reset output
130  execute_window_loop(window_output, [&](const Coordinates &)
131  {
132  auto *ptr = reinterpret_cast<float *>(output.ptr());
133  ptr[0] = std::numeric_limits<float>::max();
134  ptr[1] = std::numeric_limits<float>::min();
135  },
136  output);
137 
138  _output->unmap(queue);
139 }
void map(cl::CommandQueue &q, bool blocking=true)
Enqueue a map operation of the allocated buffer on the given queue.
Definition: ICLTensor.cpp:35
Describe one of the image's dimensions with a start, end and step.
Definition: Window.h:75
void use_tensor_dimensions(const TensorShape &shape, size_t first_dimension=Window::DimX)
Use the tensor's dimensions to fill the window dimensions.
Definition: Window.inl:250
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
void unmap(cl::CommandQueue &q)
Enqueue an unmap operation of the allocated and mapped buffer on the given queue.
Definition: ICLTensor.cpp:40
Coordinates of an item.
Definition: Coordinates.h:37
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:48
void execute_window_loop(const Window &w, L &&lambda_function, Ts &&... iterators)
Iterate through the passed window, automatically adjusting the iterators and calling the lambda_funct...
Definition: Helpers.inl:122
Iterator updated by execute_window_loop for each window element.
Definition: Helpers.h:318
Describe a multidimensional execution window.
Definition: Window.h:39

References Window::DimX, arm_compute::execute_window_loop(), ITensor::info(), ICLTensor::map(), Iterator::ptr(), Window::set(), ITensorInfo::tensor_shape(), ICLTensor::unmap(), and Window::use_tensor_dimensions().

◆ 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 141 of file CLMinMaxLayerKernel.cpp.

142 {
145 
146  Window window_collapsed = window.collapse_if_possible(ICLKernel::window(), 3);
147  Window slice = window_collapsed.first_slice_window_3D();
148  slice.set(Window::DimX, Window::Dimension(0, 1, 1));
149  slice.set(Window::DimY, Window::Dimension(0, 1, 1));
150  slice.set(Window::DimZ, Window::Dimension(0, 1, 1));
151 
152  do
153  {
154  Window output_slice = slice.shift_dimensions(2);
155 
156  unsigned int idx = 0;
157  // Set inputs
158  add_3D_tensor_argument(idx, _input, slice);
159  add_1D_tensor_argument(idx, _output, output_slice);
160  enqueue(queue, *this, slice);
161  }
162  while(window_collapsed.slide_window_slice_3D(slice));
163 }
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
Describe one of the image's dimensions with a start, end and step.
Definition: Window.h:75
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
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
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
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:319
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
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.
Definition: ICLKernel.h:110
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:275
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
Describe a multidimensional execution window.
Definition: Window.h:39
#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_1D_tensor_argument(), ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse_if_possible(), Window::DimX, Window::DimY, Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_3D(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output 
)
static

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

Parameters
[in]inputInput tensor info. Data types supported: F32.
[in]outputOutput tensor info with shape [2, batches, ...] which stores the minimum and maximum values for each 3D input tensor. The dimensions over the second must match the batched dimensions of the input tensor. Data types supported: F32.
Returns
a status

Definition at line 111 of file CLMinMaxLayerKernel.cpp.

112 {
113  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output));
114  ARM_COMPUTE_RETURN_ON_ERROR(std::get<0>(validate_and_configure_window(input->clone().get(), output->clone().get())));
115 
116  return Status{};
117 }
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
Status class.
Definition: Error.h:52
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.

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


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