arm_compute/runtime/NEON/functions/NESoftmaxLayer.h

   1 /*
   2  * Copyright (c) 2017 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_NESOFTMAXLAYER_H__
  25 #define __ARM_COMPUTE_NESOFTMAXLAYER_H__
  26
  27 #include "arm_compute/core/NEON/kernels/NEFillBorderKernel.h"
  28 #include "arm_compute/core/NEON/kernels/NESoftmaxLayerKernel.h"
  29 #include "arm_compute/runtime/IFunction.h"
  30 #include "arm_compute/runtime/Tensor.h"
  31
  32 namespace arm_compute
  33 {
  34 class ITensor;
  35
  36 /** Basic function to compute a SoftmaxLayer.
  37  *
  38  * Softmax is calculated by :
  39  * @f[ out = exp(x - max(x)) / sum(exp(x - max(x))) @f]
  40  *
  41  * This function runs the following kernels:
  42  * -# @ref NELogits1DMaxKernel
  43  * -# @ref NELogits1DShiftExpSumKernel
  44  * -# @ref NELogits1DNormKernel
  45  */
  46 class NESoftmaxLayer : public IFunction
  47 {
  48 public:
  49     /** Constructor */
  50     NESoftmaxLayer();
  51     /** Set the input and output tensors.
  52      *
  53      * @param[in]  input  Source tensor. Data types supported: F32.
  54      * @param[out] output Destination tensor. Data types supported: same as @p input.
  55      */
  56     void configure(ITensor *input, ITensor *output);
  57
  58     // Inherited methods overridden:
  59     void run() override;
  60
  61 private:
  62     NELogits1DMaxKernel         _max_kernel;
  63     NELogits1DShiftExpSumKernel _shift_exp_sum_kernel;
  64     NELogits1DNormKernel        _norm_kernel;
  65     NEFillBorderKernel          _fill_border_kernel;
  66     NEFillBorderKernel          _fill_border_kernel_sum;
  67     Tensor                      _max;
  68     Tensor                      _sum;
  69     Tensor                      _tmp;
  70 };
  71 }
  72 #endif /* __ARM_COMPUTE_NESOFTMAXLAYER_H__ */