Compute Library
 22.08
NEConvertFullyConnectedWeights.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_NECONVERTFULLYCONNECTEDWEIGHTS_H
25 #define ARM_COMPUTE_NECONVERTFULLYCONNECTEDWEIGHTS_H
26 
28 
29 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class ITensor;
35 class ITensorInfo;
36 
37 /** Basic function to run @ref cpu::kernels::CpuConvertFullyConnectedWeightsKernel. */
39 {
40 public:
41  /** Default constructor */
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
49  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
51  /** Default destructor */
53  /** Initialize the function.
54  *
55  * Valid data layouts:
56  * - NHWC
57  * - NCHW
58  *
59  * Valid data type configurations:
60  * |src |dst |
61  * |:--------------|:--------------|
62  * |All |All |
63  *
64  * @param[in] input Source weights tensor to convert. Must be 2 dimensional. Data types supported: All.
65  * @param[out] output The converted weights tensor. Shape and Data Type: Same as @p input.
66  * @param[in] original_input_shape Shape of the original input tensor (the one entering fully connected layer).
67  * @param[in] data_layout The data layout the weights have been trained in.
68  */
69  void configure(const ITensor *input, ITensor *output, const TensorShape &original_input_shape, DataLayout data_layout);
70  /** Static function to check if given info will lead to a valid configuration of @ref NEConvertFullyConnectedWeights
71  *
72  * @param[in] input Source weights tensor info to convert. Must be 2 dimensional. Data types supported: All.
73  * @param[in] output The converted weights tensor info. Shape and Data Type: Same as @p input.
74  * @param[in] original_input_shape Shape of the original input tensor (the one entering fully connected layer).
75  * @param[in] data_layout The data layout the weights have been trained in.
76  *
77  * @return A Status
78  */
79  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const TensorShape &original_input_shape, DataLayout data_layout);
80 
81  // Inherited methods overriden:
82  void run() override;
83 
84 private:
85  struct Impl;
86  std::unique_ptr<Impl> _impl;
87 };
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_NECONVERTFULLYCONNECTEDWEIGHTS_H */
NEConvertFullyConnectedWeights & operator=(const NEConvertFullyConnectedWeights &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Shape of a tensor.
Definition: TensorShape.h:39
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
Basic function to run cpu::kernels::CpuConvertFullyConnectedWeightsKernel.
void configure(const ITensor *input, ITensor *output, const TensorShape &original_input_shape, DataLayout data_layout)
Initialize the function.
~NEConvertFullyConnectedWeights()
Default destructor.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const TensorShape &original_input_shape, DataLayout data_layout)
Static function to check if given info will lead to a valid configuration of NEConvertFullyConnectedW...
DataLayout
[DataLayout enum definition]
Definition: Types.h:113
void run() override
Run the kernels contained in the function.