From 8609ca08556d4d928e290b963c71e731ac24bd52 Mon Sep 17 00:00:00 2001 From: Mohammed Suhail Munshi Date: Thu, 29 Feb 2024 17:00:07 +0000 Subject: Add skeleton for CLScatter op, reference and tests - Adds dataset for tests - Adds skeleton for function, operator, reference and tests Resolves: [COMPMID-6889] Signed-off-by: Mohammed Suhail Munshi Change-Id: I7e57e8b4577fef6aa7421e672894c249cad6c5fa Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/11234 Comments-Addressed: Arm Jenkins Reviewed-by: Gunes Bayir Tested-by: Arm Jenkins Benchmark: Arm Jenkins --- arm_compute/core/Types.h | 2 +- arm_compute/function_info/ScatterInfo.h | 54 +++++++++++++ arm_compute/runtime/CL/CLFunctions.h | 3 +- arm_compute/runtime/CL/functions/CLScatter.h | 109 +++++++++++++++++++++++++++ 4 files changed, 166 insertions(+), 2 deletions(-) create mode 100644 arm_compute/function_info/ScatterInfo.h create mode 100644 arm_compute/runtime/CL/functions/CLScatter.h (limited to 'arm_compute') diff --git a/arm_compute/core/Types.h b/arm_compute/core/Types.h index 6b51af17d4..f2f60c150e 100644 --- a/arm_compute/core/Types.h +++ b/arm_compute/core/Types.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2023 Arm Limited. + * Copyright (c) 2016-2024 Arm Limited. * * SPDX-License-Identifier: MIT * diff --git a/arm_compute/function_info/ScatterInfo.h b/arm_compute/function_info/ScatterInfo.h new file mode 100644 index 0000000000..176a863ac5 --- /dev/null +++ b/arm_compute/function_info/ScatterInfo.h @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2024 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 ACL_ARM_COMPUTE_FUNCTION_INFO_SCATTERINFO_H +#define ACL_ARM_COMPUTE_FUNCTION_INFO_SCATTERINFO_H + +#include "arm_compute/core/Error.h" + +namespace arm_compute +{ +/** Scatter Function */ +enum class ScatterFunction +{ + Update = 0, + Add = 1, + Sub = 2, + Max = 3, + Min = 4 +}; +/** Scatter operator information */ +struct ScatterInfo +{ + ScatterInfo(ScatterFunction f, bool zero) : func(f), zero_initialization(zero) + { + ARM_COMPUTE_ERROR_ON_MSG(f != ScatterFunction::Add && zero, + "Zero initialisation is only supported with Add Scatter Function."); + } + ScatterFunction func; /**< Type of scatter function to use with scatter operator*/ + bool zero_initialization{false}; /**< Fill output tensors with 0. Only available with add scatter function. */ +}; +} // namespace arm_compute + +#endif // ACL_ARM_COMPUTE_FUNCTION_INFO_SCATTERINFO_H diff --git a/arm_compute/runtime/CL/CLFunctions.h b/arm_compute/runtime/CL/CLFunctions.h index cf757239cb..a09ca551d2 100644 --- a/arm_compute/runtime/CL/CLFunctions.h +++ b/arm_compute/runtime/CL/CLFunctions.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2023 Arm Limited. + * Copyright (c) 2016-2024 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -101,6 +101,7 @@ #include "arm_compute/runtime/CL/functions/CLROIAlignLayer.h" #include "arm_compute/runtime/CL/functions/CLROIPoolingLayer.h" #include "arm_compute/runtime/CL/functions/CLScale.h" +#include "arm_compute/runtime/CL/functions/CLScatter.h" #include "arm_compute/runtime/CL/functions/CLSelect.h" #include "arm_compute/runtime/CL/functions/CLSlice.h" #include "arm_compute/runtime/CL/functions/CLSoftmaxLayer.h" diff --git a/arm_compute/runtime/CL/functions/CLScatter.h b/arm_compute/runtime/CL/functions/CLScatter.h new file mode 100644 index 0000000000..1c90d208bd --- /dev/null +++ b/arm_compute/runtime/CL/functions/CLScatter.h @@ -0,0 +1,109 @@ +/* + * Copyright (c) 2024 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 ACL_ARM_COMPUTE_RUNTIME_CL_FUNCTIONS_CLSCATTER_H +#define ACL_ARM_COMPUTE_RUNTIME_CL_FUNCTIONS_CLSCATTER_H + +#include "arm_compute/core/Error.h" +#include "arm_compute/runtime/IFunction.h" + +#include + +namespace arm_compute +{ +class ICLTensor; +class ITensorInfo; +struct ScatterInfo; +class CLCompileContext; + +/** Function to compute ScatterND Layer */ +class CLScatter : public IFunction +{ +public: + /** Default Constructor */ + CLScatter(); + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CLScatter(const CLScatter &) = delete; + /** Default move constructor */ + CLScatter(CLScatter &&); + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CLScatter &operator=(const CLScatter &) = delete; + /** Default move assignment operator */ + CLScatter &operator=(CLScatter &&); + /** Default destructor */ + ~CLScatter(); + /** Initialise the kernel's inputs and outputs + * + * Valid data layouts: + * - All + * + * + * @param[in] compile_context The compile context to be used. + * @param[in] src Source tensor. Values used to fill output. Can be nullptr when zero initialization is true. + * @param[in] updates Tensor containing values used to update output tensor. Data types supported: same as @p src + * @param[in] indices Tensor containing Indices to change in the output Tensor. Data types supported : U32 + * @param[out] output Destination tensor. Data types supported: same as @p src. + * @param[in] info Scatter info object. + */ + void configure(const CLCompileContext &compile_context, + const ICLTensor *src, + const ICLTensor *updates, + const ICLTensor *indices, + ICLTensor *output, + const ScatterInfo &info); + /** Initialise the kernel's inputs and output + * + * Similar to @ref CLScatter::configure() + */ + void configure(const ICLTensor *src, + const ICLTensor *updates, + const ICLTensor *indices, + ICLTensor *output, + const ScatterInfo &info); + /** Static function to check if given info will lead to a valid configuration of @ref CLScatter + * + * @param[in] src Source tensor. + * @param[in] updates Tensor containing values used for updating the output Tensor. Data types supported : same as @p src + * @param[in] indices Tensor containing Indices to change in the output Tensor. Data types supported : U32 + * @param[in] output Destination tensor. Data types supported: same as @p src. + * @param[in] info Scatter info containing type of scatter. + * + * @return a status + */ + static Status validate(const ITensorInfo *src, + const ITensorInfo *updates, + const ITensorInfo *indices, + const ITensorInfo *output, + const ScatterInfo &info); + + // Inherited methods overridden: + void run() override; + +private: + struct Impl; + std::unique_ptr _impl; +}; +} // namespace arm_compute + +#endif // ACL_ARM_COMPUTE_RUNTIME_CL_FUNCTIONS_CLSCATTER_H -- cgit v1.2.1