Compute Library
 21.05
CpuSoftmaxKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CPU_SOFTMAXKERNEL_H
25 #define ARM_COMPUTE_CPU_SOFTMAXKERNEL_H
26 
27 #include "src/core/common/Macros.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Interface for the identifying the max value of 1D Logits */
38 {
39 public:
40  /** Constructor */
43  /** Set the input and output tensors.
44  *
45  * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
46  * @param[out] dst Destination tensor info. Data types supported: same as @p input
47  */
48  void configure(const ITensorInfo *src, ITensorInfo *dst);
49  /** Static function to check if given info will lead to a valid configuration of @ref CpuLogits1DMaxKernel
50  *
51  * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
52  * @param[in] dst Destination tensor info. Data types supported: same as @p input
53  *
54  * @return a status
55  */
56  static Status validate(const ITensorInfo *src, const ITensorInfo *dst);
57 
58  // Inherited methods overridden:
59  void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
60  const char *name() const override;
61 };
62 
63 /** Interface for softmax computation for QASYMM8 with pre-computed max. */
64 template <bool IS_LOG = false>
66 {
67 public:
68  /** Default constructor */
71 
72  /** Set the input and output tensors.
73  *
74  * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
75  * @param[in] max Max values tensor info. Same shape as input with dimension 0 set to 1.
76  * Data types supported: same as @p input.
77  * @param[out] dst Destination tensor info. Data types supported: same as @p input.
78  * @param[in] beta A scaling factor for the exponent.
79  *
80  * @param tmp Auxiliary tensor info. Must be type F32 and same shape as the input.
81  */
82  void configure(const ITensorInfo *src, const ITensorInfo *max, ITensorInfo *dst, const float beta, ITensorInfo *tmp);
83  /** Static function to check if given info will lead to a valid configuration of @ref CpuLogits1DSoftmaxKernel
84  *
85  * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
86  * @param[in] max Max values tensor info. Same shape as input with dimension 0 set to 1.
87  * Data types supported: same as @p input.
88  * @param[in] dst Destination tensor info. Data types supported: same as @p input.
89  * @param[in] beta A scaling factor for the exponent.
90  * @param[in] tmp Tensor info of auxiliary. Must be type F32 and same shape as the input.
91  *
92  * @return a status
93  */
94  static Status validate(const ITensorInfo *src, const ITensorInfo *max,
95  const ITensorInfo *dst, const float beta, const ITensorInfo *tmp);
96 
97  // Inherited methods overridden:
98  void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
99  const char *name() const override;
100 
101 private:
102  float _beta;
103 };
104 } // namespace kernels
105 } // namespace cpu
106 } // namespace arm_compute
107 #endif /* ARM_COMPUTE_CPU_SOFTMAXKERNEL_H */
const char * name() const override
Name of the kernel.
ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuLogits1DMaxKernel)
static Status validate(const ITensorInfo *src, const ITensorInfo *dst)
Static function to check if given info will lead to a valid configuration of CpuLogits1DMaxKernel.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void configure(const ITensorInfo *src, const ITensorInfo *max, ITensorInfo *dst, const float beta, ITensorInfo *tmp)
Set the input and output tensors.
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Interface for softmax computation for QASYMM8 with pre-computed max.
Status class.
Definition: Error.h:52
const char * name() const override
Name of the kernel.
ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuLogits1DSoftmaxKernel)
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
void configure(const ITensorInfo *src, ITensorInfo *dst)
Set the input and output tensors.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:252
static Status validate(const ITensorInfo *src, const ITensorInfo *max, const ITensorInfo *dst, const float beta, const ITensorInfo *tmp)
Static function to check if given info will lead to a valid configuration of CpuLogits1DSoftmaxKernel...
Tensor packing service.
Definition: ITensorPack.h:37
Interface for the identifying the max value of 1D Logits.
Describe a multidimensional execution window.
Definition: Window.h:39
void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.