Compute Library
 21.02
NESoftmaxLayer.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_NESOFTMAXLAYER_H
25 #define ARM_COMPUTE_NESOFTMAXLAYER_H
26 
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 class ITensorInfo;
35 
36 /** Basic function to compute a SoftmaxLayer and a Log SoftmaxLayer. */
37 template <bool IS_LOG = false>
39 {
40 public:
41  /** Constructor */
42  NESoftmaxLayerGeneric(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  /** Default move constructor */
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  /** Default move assignment operator */
51  /** Default destructor */
53  /** Set the input and output tensors.
54  *
55  * @param[in,out] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. If the width is not a
56  * multiple of the internal processing block size, @ref NEFillBorder replicates the
57  * last value of each row to the nearest multiple.
58  * @param[out] output Destination tensor. Data types supported: same as @p input.
59  * @param[in] beta (Optional) A scaling factor for the exponent.
60  * @param[in] axis (Optional) The dimension in which to apply the function. E.g. for input of shape 4x5x6 and
61  * axis=1, softmax will be applied to 4x6=24 vectors of size 5. Defaults to 0
62  */
63  void configure(ITensor *input, ITensor *output, float beta = 1.0f, int32_t axis = 0);
64  /** Static function to check if given info will lead to a valid configuration of @ref NESoftmaxLayer
65  *
66  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
67  * @param[in] output Destination tensor info. Data types supported: same as @p input
68  * @param[in] beta (Optional) A scaling factor for the exponent.
69  * @param[in] axis (Optional) The dimension in which to apply the function. E.g. for input of shape 4x5x6 and
70  * axis=1, softmax will be applied to 4x6=24 vectors of size 5. Defaults to 0
71  *
72  * @return a status
73  */
74  static Status validate(const ITensorInfo *input, const ITensorInfo *output, float beta = 1.0f, int32_t axis = 0);
75 
76  // Inherited methods overridden:
77  void run() override;
78 
79 private:
80  MemoryGroup _memory_group;
81  struct Impl;
82  std::unique_ptr<Impl> _impl;
83 };
84 
87 
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_NESOFTMAXLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
~NESoftmaxLayerGeneric()
Default destructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Basic function to compute a SoftmaxLayer and a Log SoftmaxLayer.
void run() override
Run the kernels contained in the function.
void configure(ITensor *input, ITensor *output, float beta=1.0f, int32_t axis=0)
Set the input and output tensors.
NESoftmaxLayerGeneric & operator=(const NESoftmaxLayerGeneric &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
static Status validate(const ITensorInfo *input, const ITensorInfo *output, float beta=1.0f, int32_t axis=0)
Static function to check if given info will lead to a valid configuration of NESoftmaxLayer.
NESoftmaxLayerGeneric(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Constructor.