Compute Library
 22.11
CpuActivationKernel Class Reference

Interface for the activation kernel. More...

#include <CpuActivationKernel.h>

Collaboration diagram for CpuActivationKernel:
[legend]

Data Structures

struct  ActivationKernel
 

Public Member Functions

 CpuActivationKernel ()=default
 
 ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE (CpuActivationKernel)
 
void configure (const ITensorInfo *src, ITensorInfo *dst, ActivationLayerInfo activation_info)
 Configure kernel for a given list of arguments. More...
 
size_t get_mws (const CPUInfo &platform, size_t thread_count) const override
 Return minimum workload size of the relevant kernel. 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...
 
size_t get_split_dimension_hint () const
 Get the preferred dimension in which the scheduler splits the work into multiple jobs. 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...
 
- 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 *dst, const ActivationLayerInfo &act_info)
 Static function to check if given info will lead to a valid configuration. More...
 
static const std::vector< ActivationKernel > & get_available_kernels ()
 
- Static Public Member Functions inherited from ICpuKernel< CpuActivationKernel >
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 activation kernel.

Definition at line 37 of file CpuActivationKernel.h.

Constructor & Destructor Documentation

◆ CpuActivationKernel()

CpuActivationKernel ( )
default

Member Function Documentation

◆ ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE()

ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE ( CpuActivationKernel  )

◆ configure()

void configure ( const ITensorInfo src,
ITensorInfo dst,
ActivationLayerInfo  activation_info 
)

Configure kernel for a given list of arguments.

Note
If the output tensor is a nullptr, the activation function will be performed in-place
Parameters
[in,out]srcSource tensor info. In case of dst tensor = nullptr, this tensor will store the result of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
[out]dstDestination tensor info. Data type supported: same as src
[in]activation_infoActivation layer information.

Definition at line 183 of file CpuActivationKernel.cpp.

References ActivationLayerInfo::activation(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, ARM_COMPUTE_UNUSED, arm_compute::auto_init_if_empty(), arm_compute::calculate_squashed_or_max_window(), ICloneable< T >::clone(), ITensorInfo::data_type(), arm_compute::test::validation::dst, CPUInfo::get(), ICpuKernel< CpuActivationKernel >::get_implementation(), CPUInfo::get_isa(), ActivationLayerInfo::is_lut_supported(), ITensorInfo::quantization_info(), QuantizationInfo::uniform(), and arm_compute::cpu::kernels::validate_arguments().

184 {
188 
189  const auto uk = CpuActivationKernel::get_implementation(ActivationDataTypeISASelectorData{ src->data_type(), CPUInfo::get().get_isa(), activation_info.activation() });
190  if(dst != nullptr)
191  {
192  // dst auto inizialitation if not yet initialized
193  auto_init_if_empty(*dst, *src->clone());
194  }
195 
197 
198  _run_method = uk->ukernel;
199  _name = std::string("CpuActivationKernel").append("/").append(uk->name);
200 
201 #ifdef __aarch64__
202  if(ActivationLayerInfo::is_lut_supported(activation_info.activation(), src->data_type()))
203  {
204  activation_info.init_lut(src->data_type(), src->quantization_info().uniform(), (dst) ? dst->quantization_info().uniform() : src->quantization_info().uniform());
205  }
206 #endif // __aarch64__
207  _act_info = activation_info;
208 
209  Window win;
210 
211  // Use squashed window
212  std::tie(win, _split_dimension) = calculate_squashed_or_max_window(*src);
213  ICPPKernel::configure(win);
214 }
static const auto * get_implementation(const SelectorType &selector, KernelSelectionType selection_type=KernelSelectionType::Supported)
Micro-kernel selector.
Definition: ICpuKernel.h:53
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
SimpleTensor< float > src
Definition: DFT.cpp:155
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
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...
std::pair< Window, size_t > calculate_squashed_or_max_window(const ITensorInfo &src0, const ITensorInfo &src1)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
static CPUInfo & get()
Access the KernelLibrary singleton.
Definition: CPPTypes.cpp:40
static bool is_lut_supported(ActivationFunction act_func, DataType data_type)
Definition: Types.h:1736
cpuinfo::CpuIsaInfo get_isa() const
Gets the current cpu&#39;s ISA information.
Definition: CPPTypes.cpp:124

◆ get_available_kernels()

const std::vector< CpuActivationKernel::ActivationKernel > & get_available_kernels ( )
static

Definition at line 259 of file CpuActivationKernel.cpp.

260 {
261  return available_kernels;
262 }

◆ get_mws()

size_t get_mws ( const CPUInfo platform,
size_t  thread_count 
) const
overridevirtual

Return minimum workload size of the relevant kernel.

Parameters
[in]platformThe CPU platform used to create the context.
[in]thread_countNumber of threads in the execution.
Returns
[out] small_network_mws Minimum workload size for requsted configuration.

Reimplemented from ICPPKernel.

Definition at line 225 of file CpuActivationKernel.cpp.

References ARM_COMPUTE_UNUSED, and ICPPKernel::default_mws.

226 {
227  ARM_COMPUTE_UNUSED(thread_count);
228  ARM_COMPUTE_UNUSED(platform);
229 
231 }
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
static constexpr size_t default_mws
Definition: ICPPKernel.h:41

◆ get_split_dimension_hint()

size_t get_split_dimension_hint ( ) const
inline

Get the preferred dimension in which the scheduler splits the work into multiple jobs.

Returns
The split dimension hint.

Definition at line 80 of file CpuActivationKernel.h.

81  {
82  return _split_dimension;
83  }

◆ name()

const char * name ( ) const
overridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 254 of file CpuActivationKernel.cpp.

255 {
256  return _name.c_str();
257 }

◆ 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 233 of file CpuActivationKernel.cpp.

References arm_compute::ACL_DST, arm_compute::ACL_SRC, ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, ITensorPack::empty(), ActivationLayerInfo::enabled(), ITensorPack::get_const_tensor(), ITensorPack::get_tensor(), and IKernel::window().

234 {
235  // Early exit on disabled activation
236  if(!_act_info.enabled())
237  {
238  return;
239  }
240 
244 
245  ARM_COMPUTE_ERROR_ON(tensors.empty());
246  ARM_COMPUTE_ERROR_ON(_run_method == nullptr);
247 
248  const ITensor *src = tensors.get_const_tensor(TensorType::ACL_SRC);
249  ITensor *dst = tensors.get_tensor(TensorType::ACL_DST);
250 
251  _run_method(src, dst, _act_info, window);
252 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
bool enabled() const
Check if initialised.
Definition: Types.h:1694
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
SimpleTensor< float > src
Definition: DFT.cpp:155
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:915
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201

◆ validate()

Status validate ( const ITensorInfo src,
const ITensorInfo dst,
const ActivationLayerInfo act_info 
)
static

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

Similar to CpuActivationKernel::configure()

Returns
a status

Definition at line 216 of file CpuActivationKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, ARM_COMPUTE_UNUSED, ICloneable< T >::clone(), arm_compute::cpu::kernels::validate_and_configure_window(), and arm_compute::cpu::kernels::validate_arguments().

Referenced by CpuActivation::validate().

217 {
218  ARM_COMPUTE_UNUSED(act_info);
220  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(src->clone().get(), (dst != nullptr) ? dst->clone().get() : nullptr).first);
221 
222  return Status{};
223 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
SimpleTensor< float > src
Definition: DFT.cpp:155
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *src, ITensorInfo *dst)

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