From cc4815f10bf2253646fba9f0e1c336a5c36e8dfd Mon Sep 17 00:00:00 2001 From: Georgios Pinitas Date: Wed, 4 Dec 2019 18:02:41 +0000 Subject: COMPMID-2959: Update NE/CL Permute documentation. Clarify that any permutation vector is supported by NE/CL Permute as long as its rank is not greater that 4 Change-Id: I4d2761f76131277d331b2f8bd69bd6dc3a2bb30d Signed-off-by: Georgios Pinitas Reviewed-on: https://review.mlplatform.org/c/2417 Reviewed-by: Michele Di Giorgio Comments-Addressed: Arm Jenkins Tested-by: Arm Jenkins --- arm_compute/core/CL/kernels/CLPermuteKernel.h | 4 ++++ arm_compute/core/NEON/kernels/NEPermuteKernel.h | 4 ++-- arm_compute/runtime/CL/functions/CLPermute.h | 4 ++++ arm_compute/runtime/NEON/functions/NEPermute.h | 4 ++-- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/arm_compute/core/CL/kernels/CLPermuteKernel.h b/arm_compute/core/CL/kernels/CLPermuteKernel.h index 7941fa470d..28e755aa79 100644 --- a/arm_compute/core/CL/kernels/CLPermuteKernel.h +++ b/arm_compute/core/CL/kernels/CLPermuteKernel.h @@ -48,6 +48,8 @@ public: /** Allow instances of this class to be moved */ CLPermuteKernel &operator=(CLPermuteKernel &&) = default; /** Set the input and output of the kernel. + * + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input The input tensor to permute. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32 * @param[in] output The output tensor. Data types supported: Same as @p input @@ -55,6 +57,8 @@ public: */ void configure(const ICLTensor *input, ICLTensor *output, const PermutationVector &perm); /** Static function to check if given info will lead to a valid configuration of @ref CLPermuteKernel + * + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input First tensor input info. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32. * @param[in] output Output tensor info. Data types supported: same as @p input. diff --git a/arm_compute/core/NEON/kernels/NEPermuteKernel.h b/arm_compute/core/NEON/kernels/NEPermuteKernel.h index 007500c435..794259c262 100644 --- a/arm_compute/core/NEON/kernels/NEPermuteKernel.h +++ b/arm_compute/core/NEON/kernels/NEPermuteKernel.h @@ -56,7 +56,7 @@ public: /** Set the input and output of the kernel. * - * @note Supported permutation vectors : [2, 0, 1], [1, 2, 0] + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input The input tensor to permute. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32 * @param[out] output The output tensor. Data types supported: Same as @p input @@ -65,7 +65,7 @@ public: void configure(const ITensor *input, ITensor *output, const PermutationVector &perm); /** Static function to check if given info will lead to a valid configuration of @ref CPPPermuteKernel * - * @note Supported permutation vectors : [2, 0, 1], [1, 2, 0] + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input The input tensor to permute. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32 * @param[in] output The output tensor. Data types supported: Same as @p input diff --git a/arm_compute/runtime/CL/functions/CLPermute.h b/arm_compute/runtime/CL/functions/CLPermute.h index 322c47212b..40d9b6393c 100644 --- a/arm_compute/runtime/CL/functions/CLPermute.h +++ b/arm_compute/runtime/CL/functions/CLPermute.h @@ -38,6 +38,8 @@ class CLPermute : public ICLSimpleFunction { public: /** Set the input and output tensors. + * + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input The input tensor to permute. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32 * @param[in] output The output tensor. Data types supported: Same as @p input @@ -45,6 +47,8 @@ public: */ void configure(const ICLTensor *input, ICLTensor *output, const PermutationVector &perm); /** Static function to check if given info will lead to a valid configuration of @ref CLPermute. + * + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input First tensor input info. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32. * @param[in] output Output tensor info. Data types supported: same as @p input. diff --git a/arm_compute/runtime/NEON/functions/NEPermute.h b/arm_compute/runtime/NEON/functions/NEPermute.h index 83e492434d..72e864283e 100644 --- a/arm_compute/runtime/NEON/functions/NEPermute.h +++ b/arm_compute/runtime/NEON/functions/NEPermute.h @@ -38,7 +38,7 @@ class NEPermute : public INESimpleFunctionNoBorder public: /** Configure the permute NEON kernel * - * @note Supported permutation vectors : [2, 0, 1], [1, 2, 0] + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input The input tensor to permute. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32 * @param[out] output The output tensor. Data types supported: Same as @p input @@ -47,7 +47,7 @@ public: void configure(const ITensor *input, ITensor *output, const PermutationVector &perm); /** Static function to check if given info will lead to a valid configuration of @ref NEPermute * - * @note Supported permutation vectors : [2, 0, 1], [1, 2, 0] + * @note Arbitrary permutation vectors are supported with rank not greater than 4 * * @param[in] input The input tensor to permute. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32 * @param[in] output The output tensor. Data types supported: Same as @p input -- cgit v1.2.1