Compute Library
 21.05
ICLGEMMKernelConfiguration.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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_ICLGEMMKERNELCONFIGURATION_H
25 #define ARM_COMPUTE_ICLGEMMKERNELCONFIGURATION_H
26 
28 #include "arm_compute/core/Types.h"
29 
30 #include <array>
31 namespace arm_compute
32 {
33 /** Basic container for the OpenCL GEMM configuration functions */
34 template <class T>
36 {
37 public:
38  /** Alias for F32 index */
39  static constexpr size_t DT_F32 = 0;
40  /** Alias for F16 index */
41  static constexpr size_t DT_F16 = 1;
42  /** Alias for Int8 index */
43  static constexpr size_t DT_INT8 = 2;
44 
45  /** Constructor
46  *
47  * @param[in] func_f32 Function to call for GEMM F32
48  * @param[in] func_f16 Function to call for GEMM F16
49  * @param[in] func_int8 Function to call for GEMM Int8 (QASYMM8, QASYMM8_SIGNED, QSYMM8_PER_CHANNEL)
50  *
51  */
52  CLGEMMConfigArray(T func_f32, T func_f16, T func_int8)
53  : _configs{ func_f32, func_f16, func_int8 }
54  {
55  }
56 
57  /** Method to return the GEMM configuration function based on data type
58  *
59  * @param[in] data_type Input data type
60  *
61  * @return the valid function otherwise it returns nullptr if the data type is not valid
62  */
64  {
65  switch(data_type)
66  {
67  case DataType::F32:
68  return _configs.at(DT_F32);
69  case DataType::F16:
70  return _configs.at(DT_F16);
71  case DataType::QASYMM8:
74  return _configs.at(DT_INT8);
75  default:
76  return nullptr;
77  }
78  }
79 
80 private:
81  std::array<T, 3> _configs;
82 };
83 
84 /** Basic interface for the GEMM kernel configuration */
86 {
87 public:
88  /** Constructor
89  *
90  * @param[in] arch GPU target
91  */
93  : _target(arch)
94  {
95  }
96  /** Prevent instances of this class from being copied (As this class contains pointers) */
98  /** Prevent instances of this class from being copied (As this class contains pointers) */
100  /** Default Move Constructor. */
102  /** Default move assignment operator */
104  /** Virtual destructor */
105  virtual ~ICLGEMMKernelConfiguration() = default;
106  /** Given M, N, K and B, this method returns the @ref GEMMLHSMatrixInfo and @ref GEMMRHSMatrixInfo to be used
107  *
108  * @param[in] m Number of rows LHS matrix
109  * @param[in] n Number of columns RHS matrix
110  * @param[in] k Number of columns LHS matrix or number of rows RHS matrix
111  * @param[in] b Batch size
112  * @param[in] data_type Data type
113  */
114  virtual std::pair<GEMMLHSMatrixInfo, GEMMRHSMatrixInfo> configure(unsigned int m, unsigned int n, unsigned int k, unsigned int b, DataType data_type) = 0;
115 
116 protected:
117  GPUTarget _target;
118 };
119 } // namespace arm_compute
120 #endif /*ARM_COMPUTE_ICLGEMMKERNELCONFIGURATION_H */
Basic interface for the GEMM kernel configuration.
static constexpr size_t DT_INT8
Alias for Int8 index.
SimpleTensor< float > b
Definition: DFT.cpp:157
static constexpr size_t DT_F32
Alias for F32 index.
Basic container for the OpenCL GEMM configuration functions.
ICLGEMMKernelConfiguration(GPUTarget arch)
Constructor.
virtual ~ICLGEMMKernelConfiguration()=default
Virtual destructor.
1 channel, 1 F32 per channel
static constexpr size_t DT_F16
Alias for F16 index.
Copyright (c) 2017-2021 Arm Limited.
1 channel, 1 F16 per channel
T get_function(DataType data_type)
Method to return the GEMM configuration function based on data type.
const DataType data_type
Definition: Im2Col.cpp:150
virtual std::pair< GEMMLHSMatrixInfo, GEMMRHSMatrixInfo > configure(unsigned int m, unsigned int n, unsigned int k, unsigned int b, DataType data_type)=0
Given M, N, K and B, this method returns the GEMMLHSMatrixInfo and GEMMRHSMatrixInfo to be used.
quantized, asymmetric fixed-point 8-bit number unsigned
quantized, symmetric per channel fixed-point 8-bit number
GPUTarget
Available GPU Targets.
Definition: GPUTarget.h:34
CLGEMMConfigArray(T func_f32, T func_f16, T func_int8)
Constructor.
quantized, asymmetric fixed-point 8-bit number signed
DataType
Available data types.
Definition: Types.h:77
ICLGEMMKernelConfiguration & operator=(const ICLGEMMKernelConfiguration &)=delete
Prevent instances of this class from being copied (As this class contains pointers)