• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2018-2020 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_CLCONVERTFULLYCONNECTEDWEIGHTSKERNEL_H
25 #define ARM_COMPUTE_CLCONVERTFULLYCONNECTEDWEIGHTSKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
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 class CLConvertFullyConnectedWeightsKernel : public ICLKernel
42 {
43 public:
44     /** Default constructor */
45     CLConvertFullyConnectedWeightsKernel();
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     CLConvertFullyConnectedWeightsKernel(const CLConvertFullyConnectedWeightsKernel &) = delete;
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     CLConvertFullyConnectedWeightsKernel &operator=(const CLConvertFullyConnectedWeightsKernel &) = delete;
50     /** Allow instances of this class to be moved */
51     CLConvertFullyConnectedWeightsKernel(CLConvertFullyConnectedWeightsKernel &&) = default;
52     /** Allow instances of this class to be moved */
53     CLConvertFullyConnectedWeightsKernel &operator=(CLConvertFullyConnectedWeightsKernel &&) = default;
54     /** Default destructor */
55     ~CLConvertFullyConnectedWeightsKernel() = default;
56     /** Set the input and output tensor.
57      *
58      * @param[in]  input                Source weights tensor to convert. Must be 2 dimensional. Data types supported: All.
59      * @param[out] output               The converted weights tensor. Shape and Data Type: Same as @p input.
60      * @param[in]  original_input_shape Shape of the original input tensor (the one entering fully connected layer).
61      * @param[in]  data_layout          The data layout the weights have been trained in.
62      */
63     void configure(const ICLTensor *input, ICLTensor *output, const TensorShape &original_input_shape, DataLayout data_layout);
64     /** Set the input and output tensor.
65      *
66      * @param[in]  compile_context      The compile context to be used.
67      * @param[in]  input                Source weights tensor to convert. Must be 2 dimensional. Data types supported: All.
68      * @param[out] output               The converted weights tensor. Shape and Data Type: Same as @p input.
69      * @param[in]  original_input_shape Shape of the original input tensor (the one entering fully connected layer).
70      * @param[in]  data_layout          The data layout the weights have been trained in.
71      */
72     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const TensorShape &original_input_shape, DataLayout data_layout);
73     /** Static function to check if given info will lead to a valid configuration of @ref CLConvertFullyConnectedWeightsKernel
74      *
75      * @param[in] input                Source weights tensor info to convert. Must be 2 dimensional. Data types supported: All.
76      * @param[in] output               The converted weights tensor info. Shape and Data Type: Same as @p input.
77      * @param[in] original_input_shape Shape of the original input tensor (the one entering fully connected layer).
78      * @param[in] data_layout          The data layout the weights have been trained in.
79      */
80     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const TensorShape &original_input_shape, DataLayout data_layout);
81 
82     // Inherited methods overridden:
83     void run(const Window &window, cl::CommandQueue &queue) override;
84 
85 private:
86     const ICLTensor *_input;
87     ICLTensor       *_output;
88 };
89 } // namespace arm_compute
90 #endif /*ARM_COMPUTE_CLCONVERTFULLYCONNECTEDWEIGHTSKERNEL_H */
91