| /* |
| * Copyright (c) 2019-2020 Arm Limited. |
| * |
| * SPDX-License-Identifier: MIT |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a copy |
| * of this software and associated documentation files (the "Software"), to |
| * deal in the Software without restriction, including without limitation the |
| * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| * sell copies of the Software, and to permit persons to whom the Software is |
| * furnished to do so, subject to the following conditions: |
| * |
| * The above copyright notice and this permission notice shall be included in all |
| * copies or substantial portions of the Software. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| * SOFTWARE. |
| */ |
| #ifndef ARM_COMPUTE_CL /* Needed by Utils.cpp to handle OpenCL exceptions properly */ |
| #error "This example needs to be built with -DARM_COMPUTE_CL" |
| #endif /* ARM_COMPUTE_CL */ |
| |
| #include "CommonGemmExampleOptions.h" |
| #include "arm_compute/core/Helpers.h" |
| #include "arm_compute/core/KernelDescriptors.h" |
| #include "arm_compute/core/Types.h" |
| #include "arm_compute/core/utils/misc/ShapeCalculator.h" |
| #include "arm_compute/runtime/CL/CLScheduler.h" |
| #include "arm_compute/runtime/CL/CLTuner.h" |
| #include "src/core/CL/kernels/CLGEMMMatrixMultiplyNativeKernel.h" |
| #include "tests/CL/Helper.h" |
| #include "utils/Utils.h" |
| #include "utils/command_line/CommandLineOptions.h" |
| #include "utils/command_line/CommandLineParser.h" |
| |
| #include <cstdlib> |
| |
| using namespace arm_compute; |
| using namespace utils; |
| using namespace arm_compute::misc::shape_calculator; |
| using namespace gemm_tuner; |
| |
| namespace |
| { |
| /** Structure holding all tunable gemm configs specific to this example/strategy */ |
| struct GemmConfigs |
| { |
| size_t m0{ 4 }; /**< Number of rows processed by the matrix multiplication */ |
| size_t n0{ 4 }; /**< Number of columns processed by the matrix multiplication */ |
| size_t k0{ 4 }; /**< Number of partial accumulations performed by the matrix multiplication */ |
| }; |
| |
| /** Formatted output of the GemmConfigs type |
| * |
| * @param[out] os Output stream. |
| * @param[in] configs Tunable configurations to output |
| * |
| * @return Modified output stream. |
| */ |
| ::std::ostream &operator<<(::std::ostream &os, const GemmConfigs &configs) |
| { |
| std::string false_str = std::string("false"); |
| std::string true_str = std::string("true"); |
| |
| os << "m0 : " << configs.m0 << std::endl; |
| os << "n0 : " << configs.n0 << std::endl; |
| os << "k0 : " << configs.k0 << std::endl; |
| return os; |
| } |
| |
| /** Command line options for gemm configs */ |
| class GemmConfigOptions |
| { |
| public: |
| /** Constructor |
| * |
| * @param[in,out] parser A parser on which "parse()" hasn't been called yet. |
| */ |
| GemmConfigOptions(CommandLineParser &parser) |
| : m0(parser.add_positional_option<SimpleOption<size_t>>("m0", 4)), |
| n0(parser.add_positional_option<SimpleOption<size_t>>("n0", 4)), |
| k0(parser.add_positional_option<SimpleOption<size_t>>("k0", 4)) |
| { |
| m0->set_help("Number of rows processed by the matrix multiplication"); |
| n0->set_help("Number of columns processed by the matrix multiplication"); |
| k0->set_help("Number of partial accumulations performed by the matrix multiplication"); |
| } |
| /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| GemmConfigOptions(const GemmConfigOptions &) = delete; |
| /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| GemmConfigOptions &operator=(const GemmConfigOptions &) = delete; |
| /** Allow instances of this class to be moved */ |
| GemmConfigOptions(GemmConfigOptions &&) = default; |
| /** Allow instances of this class to be moved */ |
| GemmConfigOptions &operator=(GemmConfigOptions &&) = default; |
| /** Default destructor */ |
| ~GemmConfigOptions() = default; |
| |
| SimpleOption<size_t> *m0; /**< Number of rows processed by the matrix multiplication option */ |
| SimpleOption<size_t> *n0; /**< Number of columns processed by the matrix multiplication option */ |
| SimpleOption<size_t> *k0; /**< Number of partial accumulations performed by the matrix multiplication option */ |
| }; |
| |
| /** Consumes the gemm configuration options and creates a structure containing all information |
| * |
| * @param[in] options Options to consume |
| * |
| * @return Structure containing the gemm configurations |
| */ |
| GemmConfigs consume_gemm_configs(const GemmConfigOptions &options) |
| { |
| GemmConfigs configs; |
| configs.m0 = options.m0->value(); |
| configs.n0 = options.n0->value(); |
| configs.k0 = options.k0->value(); |
| return configs; |
| } |
| |
| } // namespace |
| // Create function for CLGEMMMatrixMultiplyNativeKernel |
| using CLGEMMMatrixMultiplyNative = test::CLSynthetizeFunction<CLGEMMMatrixMultiplyNativeKernel>; |
| |
| class CLGEMMMatrixMultiplyNativeExample : public Example |
| { |
| public: |
| bool do_setup(int argc, char **argv) override |
| { |
| // Default parameters |
| const float alpha = 1.0f; |
| const float beta = 0.0f; |
| const ActivationLayerInfo act_info = ActivationLayerInfo(); |
| CommonGemmExampleParams params; |
| GemmConfigs configs; |
| |
| // Set up command line parser and options |
| CommandLineParser parser; |
| CommonGemmExampleOptions param_options(parser); |
| GemmConfigOptions config_options(parser); |
| |
| // Parse command line options |
| parser.parse(argc, argv); |
| if(param_options.help->is_set() && param_options.help->value()) |
| { |
| // Print help message |
| parser.print_help(argv[0]); |
| return false; |
| } |
| if(!parser.validate()) |
| { |
| // Invalid arguments. Use default parameters and configs |
| std::cerr << "Invalid arguments." << std::endl; |
| parser.print_help(argv[0]); |
| std::cerr << "Falling back to default parameters and configs" << std::endl; |
| } |
| else |
| { |
| // Get parameters and configs from command-line options |
| params = consume_common_gemm_example_parameters(param_options); |
| configs = consume_gemm_configs(config_options); |
| } |
| |
| // Print gemm parameters and configurations |
| std::cout << "Gemm parameters:" << std::endl; |
| std::cout << params << std::endl; |
| std::cout << "Gemm configurations:" << std::endl; |
| std::cout << configs << std::endl; |
| |
| CLScheduler::get().default_init(&tuner); |
| |
| lhs.allocator()->init(TensorInfo(TensorShape(params.K, params.M, params.B), 1, params.data_type)); |
| rhs.allocator()->init(TensorInfo(TensorShape(params.N, params.K, params.B), 1, params.data_type)); |
| bias.allocator()->init(TensorInfo(TensorShape(params.N, 1, params.B), 1, params.data_type)); |
| |
| GEMMLHSMatrixInfo lhs_info; |
| lhs_info.m0 = configs.m0; |
| lhs_info.k0 = configs.k0; |
| |
| GEMMRHSMatrixInfo rhs_info; |
| rhs_info.n0 = configs.n0; |
| rhs_info.k0 = configs.k0; |
| |
| GEMMKernelInfo kernel_info; |
| kernel_info.m = params.M; |
| kernel_info.n = params.N; |
| kernel_info.k = params.K; |
| kernel_info.depth_output_gemm3d = 0; |
| kernel_info.reinterpret_input_as_3d = false; |
| kernel_info.broadcast_bias = true; |
| kernel_info.activation_info = act_info; |
| |
| // Validate argments |
| Status status{}; |
| status = gemm.validate((&lhs)->info(), (&rhs)->info(), (&bias)->info(), (&dst)->info(), alpha, beta, lhs_info, rhs_info, kernel_info); |
| if(!status) |
| { |
| // Unsupported arguments |
| std::cerr << "Unsupported arguments." << std::endl; |
| std::cerr << "Check documentation for supported/unsupported combinations" << std::endl; |
| return false; |
| } |
| |
| // Configure function |
| gemm.configure(&lhs, &rhs, &bias, &dst, alpha, beta, lhs_info, rhs_info, kernel_info); |
| |
| // Allocate tensors |
| lhs.allocator()->allocate(); |
| rhs.allocator()->allocate(); |
| bias.allocator()->allocate(); |
| dst.allocator()->allocate(); |
| |
| return true; |
| } |
| void do_run() override |
| { |
| // Execute the function |
| gemm.run(); |
| |
| // Make sure all the OpenCL jobs are done executing: |
| CLScheduler::get().sync(); |
| } |
| |
| void do_teardown() override |
| { |
| } |
| |
| private: |
| CLTensor lhs{}; |
| CLTensor rhs{}; |
| CLTensor bias{}; |
| CLTensor dst{}; |
| CLTuner tuner{}; |
| CLGEMMMatrixMultiplyNative gemm{}; |
| }; |
| |
| /** Main program for gemm native test |
| * |
| * @param[in] argc Number of arguments |
| * @param[in] argv Arguments ( [optional] M, [optional] N, [optional] K, [optional] B, [optional] m0, [optional] n0, [optional] k0 ) |
| */ |
| int main(int argc, char **argv) |
| { |
| return run_example<CLGEMMMatrixMultiplyNativeExample>(argc, argv); |
| } |