summaryrefslogtreecommitdiff
path: root/compute/ARMComputeEx/arm_compute/core/CL/kernels/CLInstanceNormalizationLayerKernelEx.h
blob: f5e147e03c800c0cf9dd0eac847d571bf4490586 (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
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 * Copyright (c) 2019 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_CLINSTANCENORMALIZATIONLAYERKERNELEX_H__
#define __ARM_COMPUTE_CLINSTANCENORMALIZATIONLAYERKERNELEX_H__

#include "arm_compute/core/CL/ICLKernel.h"

namespace arm_compute
{
class ICLTensor;

/** Interface for performing an instance normalization */
class CLInstanceNormalizationLayerKernelEx : public ICLKernel
{
public:
  /** Constructor */
  CLInstanceNormalizationLayerKernelEx();
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CLInstanceNormalizationLayerKernelEx(const CLInstanceNormalizationLayerKernelEx &) = delete;
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CLInstanceNormalizationLayerKernelEx &
  operator=(const CLInstanceNormalizationLayerKernelEx &) = delete;
  /** Default Move Constructor. */
  CLInstanceNormalizationLayerKernelEx(CLInstanceNormalizationLayerKernelEx &&) = default;
  /** Default move assignment operator */
  CLInstanceNormalizationLayerKernelEx &
  operator=(CLInstanceNormalizationLayerKernelEx &&) = default;
  /** Default destructor */
  ~CLInstanceNormalizationLayerKernelEx() = default;

  /** Set the input and output tensors.
   *
   * @param[in, out] input   Source tensor. Data types supported: F16/F32. Data layout supported:
   * NCHW
   * @param[out]     output  Destination tensor. Data types and data layouts supported: same as @p
   * input.
   * @param[in]      gamma   (Optional) The scale tensor applied to the normalized tensor. Defaults
   * to nullptr
   * @param[in]      beta    (Optional) The offset tensor applied to the normalized tensor. Defaults
   * to nullptr
   * @param[in]      epsilon (Optional) Lower bound value for the normalization. Defaults to 1e-12
   */
  void configure(ICLTensor *input, ICLTensor *output, ICLTensor *gamma = nullptr,
                 ICLTensor *beta = nullptr, float epsilon = 1e-12f);

  /** Static function to check if given info will lead to a valid configuration of @ref
   * CLInstanceNormalizationLayerEx.
   *
   * @param[in] input   Source tensor info. In case of @p output tensor = nullptr this tensor will
   * store the result of the normalization.
   *                    Data types supported: F16/F32. Data layout supported: NHWC, NCHW
   * @param[in] output  Destination tensor info. Data types and data layouts supported: same as @p
   * input.
   * @param[in] gamma   (Optional) The scale tensor applied to the normalized tensor. Defaults to
   * nullptr
   * @param[in] beta    (Optional) The offset tensor applied to the normalized tensor. Defaults to
   * nullptr
   * @param[in] epsilon (Optional) Lower bound value for the normalization. Defaults to 1e-12
   *
   * @return a status
   */
  static Status validate(const ITensorInfo *input, const ITensorInfo *output,
                         const ITensorInfo *gamma = nullptr, const ITensorInfo *beta = nullptr,
                         float epsilon = 1e-12f);

  // Inherited methods overridden:
  void run(const Window &window, cl::CommandQueue &queue) override;

private:
  ICLTensor *_input;
  ICLTensor *_output;
  ICLTensor *_gamma;
  ICLTensor *_beta;
  float _epsilon;
  bool _run_in_place;
};
} // namespace arm_compute
#endif /*__ARM_COMPUTE_CLINSTANCENORMALIZATIONLAYERKERNELEX_H__ */