Compute Library
 22.05
NEMeanStdDevNormalizationKernel.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2022 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  */
25 
29 #include "arm_compute/core/Types.h"
31 #include "src/core/CPP/Validate.h"
32 #include "src/core/NEON/NEMath.h"
38 
39 namespace arm_compute
40 {
41 namespace
42 {
43 struct MeanStdDevNormSelectorData
44 {
46 };
47 
50 
51 struct MeanStdDevNormKernel
52 {
53  const char *name;
54  const MeanStdDevNormSelctorPtr is_selected;
55  MeanStdDevNormUKernelPtr ukernel;
56 };
57 
58 static const MeanStdDevNormKernel available_kernels[] =
59 {
60  {
61  "fp32_neon_meanstddevnorm",
62  [](const MeanStdDevNormSelectorData & data) { return data.dt == DataType::F32; },
64  },
65 #ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
66  {
67  "fp16_neon_meanstddevnorm",
68  [](const MeanStdDevNormSelectorData & data) { return data.dt == DataType::F16; },
70  },
71 #endif // __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
72 };
73 
74 /** Micro-kernel selector
75  *
76  * @param[in] data Selection data passed to help pick the appropriate micro-kernel
77  *
78  * @return A matching micro-kernel else nullptr
79  */
80 const MeanStdDevNormKernel *get_implementation(const MeanStdDevNormSelectorData &data)
81 {
82  for(const auto &uk : available_kernels)
83  {
84  if(uk.is_selected(data))
85  {
86  return &uk;
87  }
88  }
89  return nullptr;
90 }
91 
92 Status validate_arguments(const ITensorInfo *input, const ITensorInfo *output, float epsilon)
93 {
94  ARM_COMPUTE_UNUSED(epsilon);
97  ARM_COMPUTE_RETURN_ERROR_ON_MSG(input->num_dimensions() > 2, "Input tensor cannot have more than 2 dimensions");
99 
100  // Checks performed when output is configured
101  if((output != nullptr) && (output->total_size() != 0))
102  {
105  }
106  return Status{};
107 }
108 
109 std::pair<Status, Window> validate_and_configure_window(ITensorInfo *input, ITensorInfo *output)
110 {
111  if(output != nullptr)
112  {
113  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
114  // Output auto inizialitation if not yet initialized
115  auto_init_if_empty(*output, *input);
116  }
117 
118  // This kernel doesn't need padding. A left-over for loop on dimension X, we cannot have any read or write out of memory
119  // For this reason num_elems_processed_per_iteration is set to 1
120  Window win = calculate_max_window(*input, Steps());
121 
122  return std::make_pair(Status{}, win);
123 }
124 } // namespace
125 
127  : _input(nullptr), _output(nullptr), _epsilon(1e-8f)
128 {
129 }
130 
132 {
134 
135  ARM_COMPUTE_ERROR_THROW_ON(NEMeanStdDevNormalizationKernel::validate(input->info(), (output != nullptr) ? output->info() : nullptr, epsilon));
136 
137  _input = input;
138  _output = (output == nullptr) ? input : output;
139  _epsilon = epsilon;
140 
141  // Configure kernel window
142  auto win_config = validate_and_configure_window(input->info(), (output == nullptr) ? nullptr : output->info());
143  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
144  ICPPKernel::configure(win_config.second);
145 }
146 
148 {
149  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, epsilon));
150  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), (output != nullptr) ? output->clone().get() : nullptr).first);
151  return Status{};
152 }
153 
155 {
156  ARM_COMPUTE_UNUSED(info);
159 
160  const auto *uk = get_implementation(MeanStdDevNormSelectorData{ _output->info()->data_type() });
161  ARM_COMPUTE_ERROR_ON(uk == nullptr || uk->ukernel == nullptr);
162 
163  uk->ukernel(_input, _output, _epsilon, window);
164 }
165 } // namespace arm_compute
const char * name
void neon_fp32_meanstddevnorm(ITensor *input, ITensor *output, float epsilon, const Window &window)
Definition: fp32.cpp:30
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
#define ARM_COMPUTE_RETURN_ERROR_ON_CPU_F16_UNSUPPORTED(tensor)
Definition: Validate.h:115
#define REGISTER_FP16_NEON(func_name)
Definition: Registrars.h:48
MeanStdDevNormUKernelPtr ukernel
#define REGISTER_FP32_NEON(func_name)
Definition: Registrars.h:74
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
virtual DataType data_type() const =0
Data type used for each element of the tensor.
1 channel, 1 F32 per channel
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Status class.
Definition: Error.h:52
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
decltype(strategy::transforms) typedef type
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
1 channel, 1 F16 per channel
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:915
static Status validate(const ITensorInfo *input, const ITensorInfo *output=nullptr, float epsilon=1e-8f)
Static function to check if given info will lead to a valid configuration of NEMeanStdDevNormalizatio...
const MeanStdDevNormSelctorPtr is_selected
void configure(ITensor *input, ITensor *output=nullptr, float epsilon=1e-8f)
Initialise the kernel&#39;s input and outputs.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *src, ITensorInfo *dst)
void neon_fp16_meanstddevnorm(ITensor *input, ITensor *output, float epsilon, const Window &window)
Information about executing thread and CPU.
Definition: CPPTypes.h:169
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(...)
Definition: Validate.h:439
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:541
#define ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:788
#define ARM_COMPUTE_RETURN_ERROR_ON_MSG(cond, msg)
If the condition is true, an error is returned.
Definition: Error.h:244
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
Includes all wrapper headers at once.
DataType
Available data types.
Definition: Types.h:79
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201