aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/core/NEON/kernels/NESoftmaxLayerKernel.h
blob: 0e0be7936b72fa86c1f8ce747c9352dc04643b84 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * Copyright (c) 2017-2020 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.
 */
#ifndef ARM_COMPUTE_NESOFTMAXLAYERKERNEL_H
#define ARM_COMPUTE_NESOFTMAXLAYERKERNEL_H

#include "arm_compute/core/NEON/INEKernel.h"
#include "arm_compute/core/NEON/INESimpleKernel.h"

namespace arm_compute
{
class ITensor;

/** Interface for the identifying the max value of 1D Logits */
class NELogits1DMaxKernel : public INESimpleKernel
{
public:
    const char *name() const override
    {
        return "NELogits1DMaxKernel";
    }
    /** Default constructor */
    NELogits1DMaxKernel();
    /** Set the input and output tensors.
     *
     * @param[in]  input  Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
     * @param[out] output Destination tensor. Data types supported: same as @p input
     */
    void configure(const ITensor *input, ITensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref NELogits1DMaxKernel
     *
     * @param[in] input  Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
     * @param[in] output Destination tensor. Data types supported: same as @p input
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run(const Window &window, const ThreadInfo &info) override;
    BorderSize border_size() const override;

private:
    using Logits1DMaxFunction = void(const ITensor &in, ITensor &out, const Window &window);

private:
    Logits1DMaxFunction *_func;
    BorderSize           _border_size;
};

/** Interface for softmax computation for QASYMM8 with pre-computed max. */
template <bool IS_LOG = false>
class NELogits1DSoftmaxKernel : public INEKernel
{
public:
    const char *name() const override
    {
        if(IS_LOG)
        {
            return "NELogits1DSoftmaxKernel";
        }
        else
        {
            return "NELogits1DLogSoftmaxKernel";
        }
    }
    /** Default constructor */
    NELogits1DSoftmaxKernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    NELogits1DSoftmaxKernel(const NELogits1DSoftmaxKernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    NELogits1DSoftmaxKernel &operator=(const NELogits1DSoftmaxKernel &) = delete;
    /** Allow instances of this class to be moved */
    NELogits1DSoftmaxKernel(NELogits1DSoftmaxKernel &&) = default;
    /** Allow instances of this class to be moved */
    NELogits1DSoftmaxKernel &operator=(NELogits1DSoftmaxKernel &&) = default;
    /** Default destructor */
    ~NELogits1DSoftmaxKernel() = default;
    /** Set the input and output tensors.
     *
     * @param[in]  input  Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
     * @param[in]  max    Max values tensor. Same shape as input with dimension 0 set to 1.
     *                    Data types supported: same as @p input.
     * @param[out] output Destination tensor. Data types supported: same as @p input.
     * @param[in]  beta   A scaling factor for the exponent.
     *
     * @param      tmp    Auxiliary tensor. Must be type F32 and same shape as the input.
     */
    void configure(const ITensor *input, const ITensor *max, ITensor *output, const float beta, ITensor *tmp);
    /** Static function to check if given info will lead to a valid configuration of @ref NELogits1DSoftmaxKernel
     *
     * @param[in] input  Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
     * @param[in] max    Max values tensor info. Same shape as input with dimension 0 set to 1.
     *                   Data types supported: same as @p input.
     * @param[in] output Destination tensor info. Data types supported: same as @p input.
     * @param[in] beta   A scaling factor for the exponent.
     * @param[in] tmp    Tensor info of auxiliary. Must be type F32 and same shape as the input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *max,
                           const ITensorInfo *output, const float beta, const ITensorInfo *tmp);

    // Inherited methods overridden:
    void run(const Window &window, const ThreadInfo &info) override;

private:
    using LogitsSoftmaxFunction = void(const ITensor &in, const ITensor &max, void *const tmp, ITensor &out, const float beta,
                                       const Window &window);

    LogitsSoftmaxFunction *_func;
    const ITensor         *_input;
    const ITensor         *_max;
    ITensor               *_output;
    float                  _beta;
    ITensor               *_tmp; //Temporary. Used internally
};
} // namespace arm_compute
#endif /*ARM_COMPUTE_NESOFTMAXLAYERKERNEL_H */