Compute Library
 22.11
CLL2NormalizeLayer.cpp
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  */
25 
27 #include "arm_compute/core/Error.h"
35 
36 #include "src/common/utils/Log.h"
37 
38 namespace arm_compute
39 {
40 namespace
41 {
42 constexpr int max_input_tensor_dim = 3;
43 } // namespace
44 
45 CLL2NormalizeLayer::CLL2NormalizeLayer(std::shared_ptr<IMemoryManager> memory_manager)
46  : _memory_group(std::move(memory_manager)),
47  _reduce_func(),
48  _normalize_kernel(std::make_unique<CLL2NormalizeLayerKernel>()),
49  _sumsq()
50 {
51 }
52 
54 
56 {
57  configure(CLKernelLibrary::get().get_compile_context(), input, output, axis, epsilon);
58 }
59 
60 void CLL2NormalizeLayer::configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, int axis, float epsilon)
61 {
62  ARM_COMPUTE_LOG_PARAMS(input, output, axis, epsilon);
63 
64  // Reset auxiliary tensor
65  _sumsq.allocator()->init(TensorInfo());
66 
67  // Manage intermediate buffers
68  _memory_group.manage(&_sumsq);
69 
70  // Configure kernels
71  const uint32_t actual_axis = wrap_around(axis, max_input_tensor_dim);
72  _reduce_func.configure(compile_context, input, &_sumsq, actual_axis, ReductionOperation::SUM_SQUARE);
73  _normalize_kernel->configure(compile_context, input, &_sumsq, output, axis, epsilon);
74 
75  // Allocate intermediate tensor
76  _sumsq.allocator()->allocate();
77 }
78 
80 {
81  TensorShape shape(input->tensor_shape());
82 
83  // Create intermediate tensor info
84  TensorInfo sum_sq;
85  sum_sq.set_data_type(input->data_type());
86  sum_sq.set_tensor_shape(shape);
87 
88  const uint32_t actual_axis = wrap_around(axis, max_input_tensor_dim);
90 
91  // Reduce shape on axis
92  shape.set(actual_axis, 1);
93  sum_sq.set_tensor_shape(shape);
94 
95  ARM_COMPUTE_RETURN_ON_ERROR(CLL2NormalizeLayerKernel::validate(input, &sum_sq, output, axis, epsilon));
96 
97  return Status{};
98 }
99 
101 {
102  MemoryGroupResourceScope scope_mg(_memory_group);
103 
104  _reduce_func.run();
105  CLScheduler::get().enqueue(*_normalize_kernel, true);
106 }
107 } // namespace arm_compute
static Status validate(const ITensorInfo *input, const ITensorInfo *output, int axis, float epsilon=1e-12f)
Static function to check if given info will lead to a valid configuration of CLL2NormalizeLayer.
Shape of a tensor.
Definition: TensorShape.h:39
static CLScheduler & get()
Access the scheduler singleton.
virtual ITensorInfo & set_tensor_shape(const TensorShape &shape)=0
Set the shape of an already initialized tensor.
#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.
ITensorInfo & set_data_type(DataType data_type) override
Set the data type to the specified value.
Definition: TensorInfo.cpp:307
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
CLTensorAllocator * allocator()
Return a pointer to the tensor&#39;s allocator.
Definition: CLTensor.cpp:61
Status class.
Definition: Error.h:52
void init(const TensorInfo &input, size_t alignment=0)
Initialize a tensor based on the passed TensorInfo.
Copyright (c) 2017-2022 Arm Limited.
void manage(IMemoryManageable *obj) override
Sets a object to be managed by the given memory group.
Definition: MemoryGroup.h:79
CLL2NormalizeLayer(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Constructor.
Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
T wrap_around(T x, T m)
Wrap-around a number within the range 0 <= x < m.
Definition: Helpers.h:247
~CLL2NormalizeLayer()
Default Destructor.
void configure(ICLTensor *input, ICLTensor *output, int axis, float epsilon=1e-12f)
Set the input and output tensors.
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
void run() override
Run the kernels contained in the function.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, ReductionOperation op, bool keep_dims=true)
Static function to check if given info will lead to a valid configuration of CLReductionOperation.
void run() override
Run the kernels contained in the function.
void enqueue(ICLKernel &kernel, bool flush=true)
Schedule the execution of the passed kernel if possible.
CLCompileContext class.
void allocate() override
Allocate size specified by TensorInfo of OpenCL memory.
Memory group resources scope handling class.
Definition: IMemoryGroup.h:82
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Interface for performing a L2 normalize on a given axis given the square sum of it in this axis...
static Status validate(const ITensorInfo *input, const ITensorInfo *sum, const ITensorInfo *output, int axis, float epsilon)
Static function to check if given info will lead to a valid configuration of CLL2NormalizeLayerKernel...
#define ARM_COMPUTE_LOG_PARAMS(...)
Store the tensor&#39;s metadata.
Definition: TensorInfo.h:43
void configure(ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op, bool keep_dims=true)
Set the input and output tensors.