Compute Library
 23.11
CpuMaxUnpoolingLayerKernel Class Reference

Interface for the pooling layer kernel. More...

#include <CpuMaxUnpoolingLayerKernel.h>

Collaboration diagram for CpuMaxUnpoolingLayerKernel:
[legend]

Data Structures

struct  MaxUnpoolingKernel
 

Public Member Functions

 CpuMaxUnpoolingLayerKernel ()=default
 Default constructor. More...
 
 ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE (CpuMaxUnpoolingLayerKernel)
 
void configure (const ITensorInfo *src, const ITensorInfo *indices, ITensorInfo *dst, const PoolingLayerInfo &pool_info)
 Configure kernel for a given list of arguments. More...
 
void run_op (ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
 Execute the kernel on the passed window. More...
 
const char * name () const override
 Name of the kernel. More...
 
- Public Member Functions inherited from ICPPKernel
virtual ~ICPPKernel ()=default
 Default destructor. More...
 
virtual void run (const Window &window, const ThreadInfo &info)
 Execute the kernel on the passed window. More...
 
virtual void run_nd (const Window &window, const ThreadInfo &info, const Window &thread_locator)
 legacy compatibility layer for implemantions which do not support thread_locator In these cases we simply narrow the interface down the legacy version More...
 
virtual size_t get_mws (const CPUInfo &platform, size_t thread_count) const
 Return minimum workload size of the relevant kernel. 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 Windowwindow () 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 *src, const ITensorInfo *indices, const ITensorInfo *dst, const PoolingLayerInfo &pool_info)
 Static function to check if given info will lead to a valid configuration of CpuMaxUnpoolingLayerKernel. More...
 
static const std::vector< MaxUnpoolingKernel > & get_available_kernels ()
 
- Static Public Member Functions inherited from ICpuKernel< CpuMaxUnpoolingLayerKernel >
static const auto * get_implementation (const SelectorType &selector, KernelSelectionType selection_type=KernelSelectionType::Supported)
 Micro-kernel selector. More...
 

Additional Inherited Members

- Static Public Attributes inherited from ICPPKernel
static constexpr size_t default_mws = 1
 

Detailed Description

Interface for the pooling layer kernel.

Definition at line 37 of file CpuMaxUnpoolingLayerKernel.h.

Constructor & Destructor Documentation

◆ CpuMaxUnpoolingLayerKernel()

Default constructor.

Member Function Documentation

◆ ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE()

ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE ( CpuMaxUnpoolingLayerKernel  )

◆ configure()

void configure ( const ITensorInfo src,
const ITensorInfo indices,
ITensorInfo dst,
const PoolingLayerInfo pool_info 
)

Configure kernel for a given list of arguments.

Note
Dst shape must be equal to the shape of the original src to pool.
Parameters
[in]srcSource tensor to permute. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
[in]indicesTensor containing the offset to store the src elements in the dst tensor. CpuMaxUnpooling with indices should precede this function in order to properly reconstruct the output tensor. The tensor shape of this tensor has to be equal to the src tensor shape. Data type supported: U32.
[out]dstDestination tensor. Data types supported: Same as src
[in]pool_infoContains pooling operation information described in PoolingLayerInfo.

Definition at line 93 of file CpuMaxUnpoolingLayerKernel.cpp.

97 {
100  ARM_COMPUTE_UNUSED(indices);
101 
103  DataTypeISASelectorData{src->data_type(), CPUInfo::get().get_isa()});
105  _run_method = uk->ukernel;
106 
107  const TensorShape output_shape = compute_unpool_shape(*src, pool_info);
108  auto_init_if_empty(*dst, src->clone()->set_tensor_shape(output_shape));
109 
110  auto window = calculate_max_window(*src, Steps());
111  ICpuKernel::configure(window);
112 }

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, ARM_COMPUTE_UNUSED, arm_compute::auto_init_if_empty(), arm_compute::calculate_max_window(), arm_compute::misc::shape_calculator::compute_unpool_shape(), arm_compute::test::validation::dst, CPUInfo::get(), ICpuKernel< CpuMaxUnpoolingLayerKernel >::get_implementation(), arm_compute::test::validation::output_shape, arm_compute::test::validation::src, and arm_compute::cpu::kernels::validate_arguments().

◆ get_available_kernels()

const std::vector< CpuMaxUnpoolingLayerKernel::MaxUnpoolingKernel > & get_available_kernels ( )
static

Definition at line 142 of file CpuMaxUnpoolingLayerKernel.cpp.

143 {
144  return available_kernels;
145 }

◆ name()

const char * name ( ) const
overridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 137 of file CpuMaxUnpoolingLayerKernel.cpp.

138 {
139  return "CpuMaxUnpoolingLayerKernel";
140 }

◆ run_op()

void run_op ( ITensorPack tensors,
const Window window,
const ThreadInfo info 
)
overridevirtual

Execute the kernel on the passed window.

Warning
If is_parallelisable() returns false then the passed window must be equal to window()
Note
The window has to be a region within the window returned by the window() method
The width of the window has to be a multiple of num_elems_processed_per_iteration().
Parameters
[in]tensorsA vector containing the tensors to operate on.
[in]windowRegion on which to execute the kernel. (Must be a region of the window returned by window())
[in]infoInfo about executing thread and CPU.

Reimplemented from ICPPKernel.

Definition at line 124 of file CpuMaxUnpoolingLayerKernel.cpp.

125 {
129 
130  const auto src = tensors.get_const_tensor(TensorType::ACL_SRC_0);
131  const auto indices = tensors.get_const_tensor(TensorType::ACL_SRC_1);
132  const auto dst = tensors.get_tensor(TensorType::ACL_DST);
133 
134  _run_method(src, indices, dst, window);
135 }

References arm_compute::ACL_DST, arm_compute::ACL_SRC_0, arm_compute::ACL_SRC_1, ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, arm_compute::test::validation::dst, ITensorPack::get_const_tensor(), ITensorPack::get_tensor(), arm_compute::test::validation::info, arm_compute::test::validation::src, and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo src,
const ITensorInfo indices,
const ITensorInfo dst,
const PoolingLayerInfo pool_info 
)
static

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

Parameters
[in]srcSource tensor to permute. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
[in]indicesTensor info of the indices of the maximal values. Data type supported: U32.
[out]dstDestination tensor. Data types supported: Same as src
[in]pool_infoContains pooling operation information described in PoolingLayerInfo.
Returns
a status

Definition at line 114 of file CpuMaxUnpoolingLayerKernel.cpp.

118 {
120  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(src, indices, dst, pool_info));
121  return Status{};
122 }

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

Referenced by CpuMaxUnpooling::validate().


The documentation for this class was generated from the following files:
arm_compute::test::validation::src
SimpleTensor< float > src
Definition: DFT.cpp:155
arm_compute::calculate_max_window
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
Definition: WindowHelpers.cpp:29
arm_compute::test::validation::output_shape
TensorShape output_shape
Definition: LSTMLayerQuantized.cpp:469
arm_compute::test::validation::dst
auto dst
Definition: DFT.cpp:170
arm_compute::cpu::kernels::validate_arguments
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
Definition: CpuDirectConv2dKernel.cpp:57
ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:1079
arm_compute::CPUInfo::get
static CPUInfo & get()
Access the KernelLibrary singleton.
Definition: CPPTypes.cpp:41
arm_compute::ACL_SRC_0
@ ACL_SRC_0
Definition: Types.h:45
arm_compute::ACL_SRC_1
@ ACL_SRC_1
Definition: Types.h:46
ARM_COMPUTE_RETURN_ON_ERROR
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:205
ARM_COMPUTE_ERROR_ON_NULLPTR
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159
ARM_COMPUTE_ERROR_THROW_ON
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
arm_compute::ACL_DST
@ ACL_DST
Definition: Types.h:55
arm_compute::auto_init_if_empty
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
Definition: AutoConfiguration.h:43
arm_compute::misc::shape_calculator::compute_unpool_shape
TensorShape compute_unpool_shape(const ITensorInfo &input, PoolingLayerInfo pool_info)
Calculate the output unpool shape of a tensor.
Definition: ShapeCalculator.h:907
ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:203
ARM_COMPUTE_UNUSED
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:151
arm_compute::cpu::ICpuKernel< CpuMaxUnpoolingLayerKernel >::get_implementation
static const auto * get_implementation(const SelectorType &selector, KernelSelectionType selection_type=KernelSelectionType::Supported)
Micro-kernel selector.
Definition: ICpuKernel.h:54
arm_compute::IKernel::window
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
arm_compute::test::validation::info
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)