Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2023 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 | */ |
Gunes Bayir | c1204c7 | 2023-10-10 17:41:56 +0100 | [diff] [blame] | 24 | #ifndef ACL_SRC_GPU_CL_OPERATORS_CLMATMUL_H |
| 25 | #define ACL_SRC_GPU_CL_OPERATORS_CLMATMUL_H |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 26 | |
SiCong Li | 9129549 | 2023-07-21 18:16:13 +0100 | [diff] [blame] | 27 | #include "arm_compute/function_info/ActivationLayerInfo.h" |
| 28 | #include "arm_compute/function_info/MatMulInfo.h" |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 29 | |
Gunes Bayir | c1204c7 | 2023-10-10 17:41:56 +0100 | [diff] [blame] | 30 | #include "src/gpu/cl/IClKernel.h" |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 31 | #include "src/gpu/cl/IClOperator.h" |
Jakub Sujak | e9b3ee2 | 2023-04-17 12:08:48 +0100 | [diff] [blame] | 32 | |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 33 | #include <memory> |
| 34 | |
| 35 | namespace arm_compute |
| 36 | { |
| 37 | namespace opencl |
| 38 | { |
| 39 | /** Basic operator to execute BatchMatMul on OpenCL. This operator calls the following OpenCL kernels: |
| 40 | * |
Jakub Sujak | 1ed6a14 | 2023-04-13 21:14:42 +0100 | [diff] [blame] | 41 | * -# @ref kernels::ClMatMulNativeKernel |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 42 | */ |
| 43 | class ClMatMul : public IClOperator |
| 44 | { |
| 45 | public: |
| 46 | /** Constructor */ |
| 47 | ClMatMul(); |
Jakub Sujak | e9b3ee2 | 2023-04-17 12:08:48 +0100 | [diff] [blame] | 48 | /** Default destructor */ |
| 49 | ~ClMatMul() = default; |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 50 | /** Initialise the kernel's inputs and output |
| 51 | * |
| 52 | * Valid data layouts: |
| 53 | * - All |
| 54 | * |
| 55 | * Valid data type configurations: |
Jakub Sujak | e9b3ee2 | 2023-04-17 12:08:48 +0100 | [diff] [blame] | 56 | * |lhs |rhs |dst | |
| 57 | * |:--------------|:--------------|:--------------| |
| 58 | * |F32 |F32 |F32 | |
| 59 | * |F16 |F16 |F16 | |
| 60 | * |QASYMM8_SIGNED |QASYMM8_SIGNED |QASYMM8_SIGNED | |
| 61 | * |QASYMM8 |QASYMM8 |QASYMM8 | |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 62 | * |
| 63 | * @note BatchMatMul: Batched Matrix Multiply - [A * B], Multiplies all slices (slice is an element of a batch) of Tensors A and B |
| 64 | * and stores the result in the dst tensor of the same batch size. |
| 65 | * Batch here is number of slices from A and B multiplied at a time, do not confuse with the batch dimension 'N' of NHWC/NCHW |
| 66 | * For NHWC for example: the batch is the higher dimensions H * N, and in general it is H * all higher dimensions. |
| 67 | * @note All tensors must have the same data type. |
| 68 | * |
| 69 | * @param[in] compile_context The compile context to be used. |
Jakub Sujak | e9b3ee2 | 2023-04-17 12:08:48 +0100 | [diff] [blame] | 70 | * @param[in] lhs Left-hand side tensor info. Data types supported: F16/F32/QASYMM8_SIGNED/QASYMM8. |
| 71 | * @param[in] rhs Right-hand side tensor info. Data types supported: same as @p lhs. |
| 72 | * @param[out] dst Output tensor to store the result of the batched matrix multiplication. Data types supported: same as @p lhs. |
| 73 | * @param[in] matmul_info Contains MatMul operation information described in @ref MatMulInfo. |
Mohammed Suhail Munshi | 94abde4 | 2023-05-25 16:48:43 +0100 | [diff] [blame] | 74 | * @param[in] act_info Class containing information about fused activation function. |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 75 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 76 | void configure(const CLCompileContext &compile_context, |
| 77 | ITensorInfo *lhs, |
| 78 | ITensorInfo *rhs, |
| 79 | ITensorInfo *dst, |
| 80 | const MatMulInfo &matmul_info, |
Mohammed Suhail Munshi | 94abde4 | 2023-05-25 16:48:43 +0100 | [diff] [blame] | 81 | const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 82 | /** Static function to check if given info will lead to a valid configuration |
| 83 | * |
| 84 | * Similar to @ref ClMatMul::configure() |
| 85 | * |
| 86 | * @return a status |
| 87 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 88 | static Status validate(const ITensorInfo *lhs, |
| 89 | const ITensorInfo *rhs, |
| 90 | const ITensorInfo *dst, |
| 91 | const MatMulInfo &matmul_info, |
| 92 | const ActivationLayerInfo &act_info = ActivationLayerInfo()); |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 93 | // Inherited methods overridden: |
| 94 | void run(ITensorPack &tensors) override; |
| 95 | |
| 96 | private: |
Gunes Bayir | c1204c7 | 2023-10-10 17:41:56 +0100 | [diff] [blame] | 97 | std::unique_ptr<opencl::IClKernel> _matmul_kernel{nullptr}; |
Ramy Elgammal | f26ea2f | 2023-03-24 11:42:03 +0000 | [diff] [blame] | 98 | }; |
| 99 | } // namespace opencl |
| 100 | } // namespace arm_compute |
Gunes Bayir | c1204c7 | 2023-10-10 17:41:56 +0100 | [diff] [blame] | 101 | #endif // ACL_SRC_GPU_CL_OPERATORS_CLMATMUL_H |