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/OperatorList.h | |
| 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/OperatorList.h')
| -rw-r--r-- | arm_compute/runtime/OperatorList.h | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/arm_compute/runtime/OperatorList.h b/arm_compute/runtime/OperatorList.h index e1c2bed41d..8f1f4ba0a9 100644 --- a/arm_compute/runtime/OperatorList.h +++ b/arm_compute/runtime/OperatorList.h @@ -94,7 +94,7 @@ /** BitwiseAnd * * Description: - * Function to performe bitwise AND between 2 tensors. + * Function to perform bitwise AND between 2 tensors. * * Equivalent Android NNAPI Op: * ANEURALNETWORKS_LOGICAL_AND @@ -104,7 +104,7 @@ /** BitwiseNot * * Description: - * Function to performe bitwise NOT. + * Function to perform bitwise NOT. * * Equivalent Android NNAPI Op: * ANEURALNETWORKS_LOGICAL_NOT @@ -114,7 +114,7 @@ /** BitwiseOr * * Description: - * Function to performe bitwise OR between 2 tensors. + * Function to perform bitwise OR between 2 tensors. * * Equivalent Android NNAPI Op: * ANEURALNETWORKS_LOGICAL_OR @@ -124,7 +124,7 @@ /** BitwiseXor * * Description: - * Function to performe bitwise XOR between 2 tensors. + * Function to perform bitwise XOR between 2 tensors. * * Equivalent Android NNAPI Op: * n/a @@ -189,7 +189,7 @@ /** ConvertFullyConnectedWeights * * Description: - * Function to tranpose the wieghts for the fully connected layer. + * Function to transpose the weights for the fully connected layer. * * Equivalent Android NNAPI Op: * n/a @@ -239,7 +239,7 @@ /** DeconvolutionLayer * * Description: - * Function to compute a deconvolution or tranpose convolution. + * Function to compute a deconvolution or transpose convolution. * * Equivalent Android NNAPI Op: * ANEURALNETWORKS_TRANSPOSE_CONV_2D @@ -326,7 +326,7 @@ * */ -/** ElementWiseOperations +/** ElementwiseOperations * * Description: * Function to perform in Cpu: @@ -426,7 +426,7 @@ /** FillBorder * * Description: - * Function to . + * Function to fill the borders within the XY-planes. * * Equivalent Android NNAPI Op: * n/a @@ -493,7 +493,7 @@ * */ -/** GEMMConv2D +/** GEMMConv2d * * Description: * General Matrix Multiplication. @@ -691,7 +691,7 @@ /** PixelWiseMultiplication * * Description: - * Function to performe a multiplication. + * Function to perform a multiplication. * * Equivalent Android NNAPI Op: * ANEURALNETWORKS_MUL @@ -701,7 +701,7 @@ /** PoolingLayer * * Description: - * Function to performe pooling with the specified pooling operation. + * Function to perform pooling with the specified pooling operation. * * Equivalent Android NNAPI Op: * ANEURALNETWORKS_AVERAGE_POOL_2D @@ -764,7 +764,7 @@ /** ReduceMean * * Description: - * Function to performe reduce mean operation. + * Function to perform reduce mean operation. * * Equivalent Android NNAPI Op: * ANEURALNETWORKS_MEAN @@ -774,7 +774,7 @@ /** ReductionOperation * * Description: - * Function to performe reduce with the following operations + * Function to perform reduce with the following operations * - ARG_IDX_MAX: Index of the max value * - ARG_IDX_MIN: Index of the min value * - MEAN_SUM: Mean of sum @@ -992,7 +992,7 @@ /** WinogradInputTransform * * Description: - * Function to. + * Function to perform a Winograd transform on the input tensor. * * Equivalent Android NNAPI Op: * n/a |