COMPMID-3984: Deprecate GLES functions.
authormorgolock <pablo.tello@arm.com>
Thu, 19 Nov 2020 10:07:14 +0000 (10:07 +0000)
committerPablo Marquez Tello <pablo.tello@arm.com>
Thu, 19 Nov 2020 18:08:44 +0000 (18:08 +0000)
Change-Id: I6f58c56d24e12f5691aec2376ad8d4bed064473b
Signed-off-by: morgolock <pablo.tello@arm.com>
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/4163
Reviewed-by: SiCong Li <sicong.li@arm.com>
Tested-by: Gian Marco Iodice <gianmarco.iodice@arm.com>
23 files changed:
arm_compute/runtime/GLES_COMPUTE/functions/GCAbsoluteDifference.h
arm_compute/runtime/GLES_COMPUTE/functions/GCActivationLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCArithmeticAddition.h
arm_compute/runtime/GLES_COMPUTE/functions/GCBatchNormalizationLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCConcatenateLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCConvolutionLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCDepthwiseConvolutionLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCDirectConvolutionLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCDropoutLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCFillBorder.h
arm_compute/runtime/GLES_COMPUTE/functions/GCFullyConnectedLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCGEMM.h
arm_compute/runtime/GLES_COMPUTE/functions/GCGEMMInterleave4x4.h
arm_compute/runtime/GLES_COMPUTE/functions/GCGEMMTranspose1xW.h
arm_compute/runtime/GLES_COMPUTE/functions/GCNormalizationLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCNormalizePlanarYUVLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCPixelWiseMultiplication.h
arm_compute/runtime/GLES_COMPUTE/functions/GCPoolingLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCScale.h
arm_compute/runtime/GLES_COMPUTE/functions/GCSoftmaxLayer.h
arm_compute/runtime/GLES_COMPUTE/functions/GCTensorShift.h
arm_compute/runtime/GLES_COMPUTE/functions/GCTranspose.h
docs/00_introduction.dox

index 481fb19201d539d330e2f2b864a255c8641f48ae..bbba8acd7e31137ebd17dd84042f5e29792a6bfb 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -35,6 +35,9 @@ class ITensor;
  *
  * @note The tensor data types for the inputs must be U8.
  * @note The function calculates the absolute difference also when the 2 inputs have different tensor data types.
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCAbsoluteDifference : public IGCSimpleFunction
 {
index 79c7c0cc127ab697bf7ee73543926b05b338e1fc..b09afbb81d3224ddaeaa37cde358c0e7a8f69532 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -35,6 +35,9 @@ class IGCTensor;
 /** Basic function to run @ref GCActivationLayerKernel
  *
  * @note The function simulates an activation layer with the specified activation function.
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCActivationLayer : public IGCSimpleFunction
 {
index 15d957e3ce18fadc2e610b1e8d2ac5448d33d788..9a7527dcd555ef47ac97a90eed3784bcecbab052 100644 (file)
@@ -35,6 +35,9 @@ class IGCTensor;
  *
  * @note The tensor data type for the inputs must be F16.
  * @note The function performs an arithmetic addition between two tensors.
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCArithmeticAddition : public IGCSimpleFunction
 {
index d6bc6eec3d780e294c6ad4ef4254bcd51728ca47..75b4cdc628ff8cd3d66512c814a71a33e8fb9316 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -38,6 +38,8 @@ class IGCTensor;
  * Batch normalization is calculated by:
  * @f[ out_i = \gamma * (\frac{in_i - \mu_{B}}{\sqrt{\sigma^2_{B} + \epsilon}}) + \beta \equiv BN_{\gamma,\beta}(in_i) @f]
  *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCBatchNormalizationLayer : public IFunction
 {
index 9661b368a0d124f05af511c817e0c4823633853c..fe24c07f630222f3e497e64b7f436ac2a438c045 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019 Arm Limited.
+ * Copyright (c) 2019-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -40,6 +40,9 @@ class IGCTensor;
  *
  * @note only axis z is supported
  * -# @ref GCDepthConcatenateLayerKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCConcatenateLayer : public IFunction
 {
index f80ffa2948132529e37e83b25b279656e6715a30..3cff9688ebf80750fbb9e5a0a3d8c4e0c3e352b6 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -44,6 +44,9 @@ class IGCTensor;
 
 /** Function to reshape and transpose the weights. This function calls the following kernels:
  * -# @ref GCWeightsReshapeKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCConvolutionLayerReshapeWeights : public IFunction
 {
@@ -72,6 +75,9 @@ private:
  * -# @ref GCIm2ColKernel
  * -# @ref GCGEMMInterleave4x4Kernel
  * -# @ref GCCol2ImKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCConvolutionLayer : public IFunction
 {
index 3cf4d548d135bf0701c6481692004d74f3faca42..82fe368d7d9576aeda7a9236e1a8973f244c9686 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -40,6 +40,8 @@ class IGCTensor;
  * -# @ref GCDepthwiseConvolutionLayer3x3Kernel
  * -# @ref GCFillBorderKernel (if pad_x or pad_y > 0)
  *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCDepthwiseConvolutionLayer3x3 : public IFunction
 {
index c206ec4822b520547cb0fb87064d7170198ab484..f834802db640a6a8c7726c5e8911fca8a81c3f1e 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -46,6 +46,9 @@ class IGCTensor;
  *
  * @note Supported kernel size: 1x1, 3x3, and 5x5
  * @note This OpenGL ES implementation works with stride_x = 1 and 2
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCDirectConvolutionLayer : public IFunction
 {
index 79af62348661b33a7f9b86adf84cbd23535891b6..4d551f26925e98343fb91726083148c7c49c5db9 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -34,6 +34,9 @@ class IGCTensor;
 /** Basic function to do dropout op. This function calls the following kernels:
  *
  *  -# @ref GCDropoutLayerKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCDropoutLayer : public IFunction
 {
index 766e8114a003ea0f3b66d826ef4e9c16718f724c..1635db51e786de553fe405890711edbfc75af4dc 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -33,7 +33,11 @@ namespace arm_compute
 {
 class ITensor;
 
-/** Basic function to run @ref GCFillBorderKernel */
+/** Basic function to run @ref GCFillBorderKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
+ */
 class GCFillBorder : public IGCSimpleFunction
 {
 public:
index a13c74a6838c8cdf0fc9b24874c0388f6115777a..f839a7db39c978bc79b949592810435f295317a9 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -40,6 +40,9 @@ namespace arm_compute
  *  -# @ref GCTransposeKernel
  *
  * @note  The fully connected layer accepts "weights" tensors only with 2 dimensions.
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCFullyConnectedLayerReshapeWeights : public IGCSimpleFunction
 {
@@ -60,6 +63,9 @@ public:
  *  -# @ref GCGEMMMatrixAccumulateBiasesKernel (if @p biases is not equal to nullptr)
  *
  * @note  The fully connected layer accepts "weights" tensors only with 2 dimensions.
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCFullyConnectedLayer : public IFunction
 {
index 9c1748bc637020a3537480689cf6907aa6f2b163..653da4b981e5ef93ea9a60a00d2cf1168e28bcff 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -44,6 +44,8 @@ class IGCTensor;
  *  -# @ref GCGEMMMatrixMultiplyKernel
  *  -# @ref GCGEMMMatrixAdditionKernel (if c != nullptr and beta != 0.0)
  *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCGEMM : public IFunction
 {
index 67fc86d0670a25acdfeb5c00f47a4f1769544d5d..964c36831669e5cc6f649c1284c0958d44c1194b 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -34,6 +34,8 @@ class ITensor;
  *
  *  -# @ref GCGEMMInterleave4x4Kernel
  *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCGEMMInterleave4x4 : public IGCSimpleFunction
 {
index b3d6a28e0e03daab5a67e5d6f58b7b5b47e84c38..107590cf76bd477cc5f7925ca865ee170bbb47a4 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -32,6 +32,8 @@ namespace arm_compute
  *
  *  -# @ref GCGEMMTranspose1xWKernel
  *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCGEMMTranspose1xW : public IGCSimpleFunction
 {
index 2936402562711abefc51021809210fa9578c0318..f8ee39c3621a58a862f5db277f093bd786ede196 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -44,6 +44,9 @@ class IGCTensor;
  * -# @ref GCPixelWiseMultiplicationKernel
  * -# @ref GCFillBorderKernel
  * -# @ref GCNormalizationLayerKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCNormalizationLayer : public IFunction
 {
index fd69ef77255eaa5f9b37fcfe7d265762e5983540..e097cb9291b50f3648a8363a05dcddd7dde550ae 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -36,6 +36,9 @@ class IGCTensor;
 /** Basic function to run @ref GCNormalizePlanarYUVLayerKernel
  *
  *  @note The function simulates a NormalizePlanarYUV layer.
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCNormalizePlanarYUVLayer : public IFunction
 {
index bbcc6630e67b37b667b09f9af781b336de06c8a3..e09ce374ff7adf774f545b6ba87feb0479d0064c 100644 (file)
@@ -31,7 +31,11 @@ namespace arm_compute
 {
 class IGCTensor;
 
-/** Basic function to run @ref GCPixelWiseMultiplicationKernel. */
+/** Basic function to run @ref GCPixelWiseMultiplicationKernel.
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
+ */
 class GCPixelWiseMultiplication : public IGCSimpleFunction
 {
 public:
index d6a79b5bc133083cde6b4e5b7df4df5bcd922016..dcb7e81b9b3430cee13aa51055cf3852fd8064e4 100644 (file)
@@ -41,6 +41,9 @@ class IGCTensor;
  *
  * -# @ref GCFillBorderKernel (executed if padding size is different from zero)
  * -# @ref GCPoolingLayerKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCPoolingLayer : public IFunction
 {
index 5a610f255fcb7181a373269989aa24062d64dc3b..17cfa565a978bf57a447ba79ca8d539d4a6bfa65 100644 (file)
@@ -33,7 +33,11 @@ namespace arm_compute
 {
 class IGCTensor;
 
-/** Basic function to run @ref GCScaleKernel */
+/** Basic function to run @ref GCScaleKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
+ */
 class GCScale : public IGCSimpleFunction
 {
 public:
index 0279edf63d3d90775e620e713160e1f93c069773..083b07c57c793f7f441f54f894e2b5a251d06c64 100644 (file)
@@ -42,6 +42,9 @@ class IGCTensor;
  * -# @ref GCLogits1DMaxKernel
  * -# @ref GCLogits1DShiftExpSumKernel
  * -# @ref GCLogits1DNormKernel
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCSoftmaxLayer : public IFunction
 {
index 546f6d6e1687a3cbeb0e1da5359f0081d934706f..d25a322f4fa39b26217ec1040a7ad11822255096 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -37,6 +37,9 @@ class IGCTensor;
 /** Basic function to execute shift function for tensor. This function applies to fix alignment issue on OpenGL ES:
  *
  * @note This alignment issue is introduced by limits of compute shader which requires 32/64/128bit alignment for data access on OpenGL ES
+ *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCTensorShift : public IGCSimpleFunction
 {
index a37031bfeea1a7f6e9c8ce61361902e4ed5ff0f1..84e303aa2531d8853184b381854d30e159795943 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Arm Limited.
+ * Copyright (c) 2017-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -34,6 +34,8 @@ class IGCTensor;
  *
  *  -# @ref GCTransposeKernel
  *
+ * @deprecated This function is deprecated and is intended to be removed in 21.05 release
+ *
  */
 class GCTranspose : public IGCSimpleFunction
 {
index 2ecb13fc40ef3e7771c8fe257649430d667c3d2a..6b341fb0f0a4647dc411952713dfe1fba8732ab3 100644 (file)
@@ -351,6 +351,30 @@ v20.11 Public major release
      - NEWarpAffineKernel
      - NEWarpPerspective
      - NEWarpPerspectiveKernel
+ - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
+     - GCAbsoluteDifference
+     - GCActivationLayer
+     - GCArithmeticAddition
+     - GCBatchNormalizationLayer
+     - GCConcatenateLayer
+     - GCConvolutionLayer
+     - GCDepthwiseConvolutionLayer
+     - GCDirectConvolutionLayer
+     - GCDropoutLayer
+     - GCFillBorder
+     - GCFullyConnectedLayer
+     - GCGEMM
+     - GCGEMMInterleave4x4
+     - GCGEMMTranspose1xW
+     - GCNormalizationLayer
+     - GCNormalizePlanarYUVLayer
+     - GCPixelWiseMultiplication
+     - GCPoolingLayer
+     - GCScale
+     - GCSoftmaxLayer
+     - GCTensorShift
+     - GCTranspose
+
 
 v20.08 Public major release
  - Various bug fixes.