Compute Library
 22.02
ClConvertFullyConnectedWeightsKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CL_CONVERT_FULLYCONNECTED_WEIGHTS_KERNEL_H
25 #define ARM_COMPUTE_CL_CONVERT_FULLYCONNECTED_WEIGHTS_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
29 #include "src/gpu/cl/IClKernel.h"
30 
31 namespace arm_compute
32 {
33 /** Interface to convert the 2D Fully Connected weights from NCHW to NHWC or vice versa.
34  *
35  * @note This function can be applied to the 2D weights used by a Fully Connected layer if:
36  * - It follows a Convolution layer
37  * - The data layout used by the network does not match the one the model has been trained in.
38  *
39  * @note This function assumes the weights are already reshaped (transposed)
40  */
41 namespace opencl
42 {
43 namespace kernels
44 {
46 {
47 public:
50  /** Set the src and dst tensor.
51  *
52  * @param[in] compile_context The compile context to be used.
53  * @param[in] src Source weights tensor info to convert. Must be 2 dimensional. Data types supported: All.
54  * @param[out] dst The converted weights tensor info. Shape and Data Type: Same as @p src.
55  * @param[in] original_src_shape Shape of the original src tensor (the one entering fully connected layer).
56  * @param[in] data_layout The data layout the weights have been trained in.
57  */
58  void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const TensorShape &original_src_shape, DataLayout data_layout);
59  /** Static function to check if given info will lead to a valid configuration
60  *
61  * Similar to @ref ClConvertFullyConnectedWeightsKernel::configure()
62  *
63  * @return a status
64  */
65  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const TensorShape &original_src_shape, DataLayout data_layout);
66 
67  // Inherited methods overridden:
68  void run_op(ITensorPack &tensors, const Window &window, ::cl::CommandQueue &queue) override;
69 };
70 } // namespace kernels
71 } // namespace opencl
72 } // namespace arm_compute
73 #endif /* ARM_COMPUTE_CL_CONVERT_FULLYCONNECTED_WEIGHTS_KERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Shape of a tensor.
Definition: TensorShape.h:39
void run_op(ITensorPack &tensors, const Window &window, ::cl::CommandQueue &queue) override
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:68
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const TensorShape &original_src_shape, DataLayout data_layout)
Static function to check if given info will lead to a valid configuration.
CLCompileContext class.
ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(ClConvertFullyConnectedWeightsKernel)
Tensor packing service.
Definition: ITensorPack.h:39
void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const TensorShape &original_src_shape, DataLayout data_layout)
Set the src and dst tensor.
DataLayout
[DataLayout enum definition]
Definition: Types.h:113
Describe a multidimensional execution window.
Definition: Window.h:39