diff options
author | Jakub Sujak <jakub.sujak@arm.com> | 2021-06-04 09:46:08 +0100 |
---|---|---|
committer | Michele Di Giorgio <michele.digiorgio@arm.com> | 2021-06-11 09:19:27 +0000 |
commit | ee301b384f4aeb697a5c249b8bb848d784146582 (patch) | |
tree | e42ecfcfdbf95d21d5d01a422663161d32fe1733 /arm_compute/runtime/NEON/functions | |
parent | a5c428a5428d1c7a9d1d03fd198d6a8578b6c12c (diff) | |
download | ComputeLibrary-ee301b384f4aeb697a5c249b8bb848d784146582.tar.gz |
Fix errata in documentation
This patch addresses the following errata found in the project documentation:
* Common typos.
* Missing use of trademarks.
* Incomplete operator descriptions.
* Examples of code that have since been removed from the library.
* Plus clarification over the usage of `All` category for data types and layouts.
In addition, the Operator list was not generated properly due to:
* Non-matching cases in the filenames (i.e. `Elementwise` and `ElementWise`). For consistency, all usages of the latter have been renamed to the former.
* Extra data layout tables in the headers for the `NESlice` and `NEStridedSlice` functions (note: not present in CL counterpart) meant documentation for those functions was generated twice.
Resolves: COMPMID-4561, COMPMID-4562, COMPMID-4563
Change-Id: I1eb24559545397749e636ffbf927727fb1bc6201
Signed-off-by: Jakub Sujak <jakub.sujak@arm.com>
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/5769
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Sheri Zhang <sheri.zhang@arm.com>
Reviewed-by: SiCong Li <sicong.li@arm.com>
Diffstat (limited to 'arm_compute/runtime/NEON/functions')
-rw-r--r-- | arm_compute/runtime/NEON/functions/NESlice.h | 8 | ||||
-rw-r--r-- | arm_compute/runtime/NEON/functions/NEStridedSlice.h | 8 |
2 files changed, 0 insertions, 16 deletions
diff --git a/arm_compute/runtime/NEON/functions/NESlice.h b/arm_compute/runtime/NEON/functions/NESlice.h index 550bfd2188..ac79a5c633 100644 --- a/arm_compute/runtime/NEON/functions/NESlice.h +++ b/arm_compute/runtime/NEON/functions/NESlice.h @@ -103,14 +103,6 @@ class NESlice : public INEOperator public: /** Configure kernel * - * Valid data layouts: - * - All - * - * Valid data type configurations: - * |src |dst | - * |:------|:------| - * |All |All | - * * @note Supported tensor rank: up to 4 * @note Start indices must be non-negative. 0 <= starts[i] * @note End coordinates can be negative, which represents the number of elements before the end of that dimension. diff --git a/arm_compute/runtime/NEON/functions/NEStridedSlice.h b/arm_compute/runtime/NEON/functions/NEStridedSlice.h index 0b4c2a63a1..4b14d946f6 100644 --- a/arm_compute/runtime/NEON/functions/NEStridedSlice.h +++ b/arm_compute/runtime/NEON/functions/NEStridedSlice.h @@ -109,14 +109,6 @@ class NEStridedSlice : public INEOperator public: /** Configure kernel * - * Valid data layouts: - * - All - * - * Valid data type configurations: - * |src |dst | - * |:------|:------| - * |All |All | - * * @note Supported tensor rank: up to 4 * * @param[in] input Source tensor info. Data type supported: All |