From 00c7601b1f9c3bec1d3b1db844abb513b9012541 Mon Sep 17 00:00:00 2001 From: morgolock Date: Fri, 6 Nov 2020 10:40:12 +0000 Subject: COMPMID-3957: Deprecate CV functions in CL backend. Change-Id: Ic3deac8d6ce128312f49aa1ddf9f508d05d1b7a2 Signed-off-by: morgolock Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/4368 Comments-Addressed: Arm Jenkins Reviewed-by: Sheri Zhang Tested-by: Arm Jenkins --- .../runtime/CL/functions/CLAbsoluteDifference.h | 3 + arm_compute/runtime/CL/functions/CLAccumulate.h | 18 +++- arm_compute/runtime/CL/functions/CLBox3x3.h | 2 + arm_compute/runtime/CL/functions/CLCannyEdge.h | 2 + .../runtime/CL/functions/CLChannelCombine.h | 6 +- .../runtime/CL/functions/CLChannelExtract.h | 6 +- arm_compute/runtime/CL/functions/CLColorConvert.h | 3 + arm_compute/runtime/CL/functions/CLConvolution.h | 7 ++ arm_compute/runtime/CL/functions/CLDerivative.h | 2 + arm_compute/runtime/CL/functions/CLDilate.h | 4 +- .../runtime/CL/functions/CLEqualizeHistogram.h | 2 + arm_compute/runtime/CL/functions/CLErode.h | 4 +- arm_compute/runtime/CL/functions/CLFastCorners.h | 2 + arm_compute/runtime/CL/functions/CLGaussian3x3.h | 2 + arm_compute/runtime/CL/functions/CLGaussian5x5.h | 2 + .../runtime/CL/functions/CLGaussianPyramid.h | 6 +- arm_compute/runtime/CL/functions/CLHOGDescriptor.h | 2 + arm_compute/runtime/CL/functions/CLHOGDetector.h | 2 + arm_compute/runtime/CL/functions/CLHOGGradient.h | 2 + .../runtime/CL/functions/CLHOGMultiDetection.h | 5 +- arm_compute/runtime/CL/functions/CLHarrisCorners.h | 3 + arm_compute/runtime/CL/functions/CLHistogram.h | 2 + arm_compute/runtime/CL/functions/CLIntegralImage.h | 2 + .../runtime/CL/functions/CLLaplacianPyramid.h | 3 + .../runtime/CL/functions/CLLaplacianReconstruct.h | 3 + arm_compute/runtime/CL/functions/CLMagnitude.h | 6 +- arm_compute/runtime/CL/functions/CLMedian3x3.h | 2 + .../runtime/CL/functions/CLMinMaxLocation.h | 3 + .../runtime/CL/functions/CLNonLinearFilter.h | 3 + .../CL/functions/CLNonMaximaSuppression3x3.h | 3 + arm_compute/runtime/CL/functions/CLOpticalFlow.h | 3 + arm_compute/runtime/CL/functions/CLPhase.h | 6 +- arm_compute/runtime/CL/functions/CLRemap.h | 3 + arm_compute/runtime/CL/functions/CLScharr3x3.h | 2 + arm_compute/runtime/CL/functions/CLSobel3x3.h | 2 + arm_compute/runtime/CL/functions/CLSobel5x5.h | 2 + arm_compute/runtime/CL/functions/CLSobel7x7.h | 2 + arm_compute/runtime/CL/functions/CLThreshold.h | 6 +- arm_compute/runtime/CL/functions/CLWarpAffine.h | 6 +- .../runtime/CL/functions/CLWarpPerspective.h | 6 +- docs/00_introduction.dox | 96 +++++++++++++++++++++- 41 files changed, 230 insertions(+), 16 deletions(-) diff --git a/arm_compute/runtime/CL/functions/CLAbsoluteDifference.h b/arm_compute/runtime/CL/functions/CLAbsoluteDifference.h index f2831e2a99..86c8022b4f 100644 --- a/arm_compute/runtime/CL/functions/CLAbsoluteDifference.h +++ b/arm_compute/runtime/CL/functions/CLAbsoluteDifference.h @@ -35,6 +35,9 @@ class ICLTensor; * * @note The tensor data types for the inputs must be U8 or S16. * @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 CLAbsoluteDifference : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLAccumulate.h b/arm_compute/runtime/CL/functions/CLAccumulate.h index 20d3476d2e..f78ce0e149 100644 --- a/arm_compute/runtime/CL/functions/CLAccumulate.h +++ b/arm_compute/runtime/CL/functions/CLAccumulate.h @@ -33,7 +33,11 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLAccumulateKernel */ +/** Basic function to run @ref CLAccumulateKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLAccumulate : public ICLSimpleFunction { public: @@ -52,7 +56,11 @@ public: void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *accum); }; -/** Basic function to run @ref CLAccumulateWeightedKernel */ +/** Basic function to run @ref CLAccumulateWeightedKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLAccumulateWeighted : public ICLSimpleFunction { public: @@ -73,7 +81,11 @@ public: void configure(const CLCompileContext &compile_context, const ICLTensor *input, float alpha, ICLTensor *accum); }; -/** Basic function to run @ref CLAccumulateSquaredKernel */ +/** Basic function to run @ref CLAccumulateSquaredKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLAccumulateSquared : public ICLSimpleFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLBox3x3.h b/arm_compute/runtime/CL/functions/CLBox3x3.h index cff780614c..63c5d3f897 100644 --- a/arm_compute/runtime/CL/functions/CLBox3x3.h +++ b/arm_compute/runtime/CL/functions/CLBox3x3.h @@ -39,6 +39,8 @@ class ICLTensor; * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLBox3x3Kernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLBox3x3 : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLCannyEdge.h b/arm_compute/runtime/CL/functions/CLCannyEdge.h index 9e41c31728..1c48d690a5 100644 --- a/arm_compute/runtime/CL/functions/CLCannyEdge.h +++ b/arm_compute/runtime/CL/functions/CLCannyEdge.h @@ -49,6 +49,8 @@ class ICLTensor; * -# @ref CLEdgeNonMaxSuppressionKernel * -# @ref CLEdgeTraceKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLCannyEdge : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLChannelCombine.h b/arm_compute/runtime/CL/functions/CLChannelCombine.h index 5927662fc2..2a36d3f742 100644 --- a/arm_compute/runtime/CL/functions/CLChannelCombine.h +++ b/arm_compute/runtime/CL/functions/CLChannelCombine.h @@ -33,7 +33,11 @@ class ICLMultiImage; class ICLTensor; using ICLImage = ICLTensor; -/** Basic function to run @ref CLChannelCombineKernel to perform channel combination. */ +/** Basic function to run @ref CLChannelCombineKernel to perform channel combination. + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLChannelCombine : public ICLSimpleFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLChannelExtract.h b/arm_compute/runtime/CL/functions/CLChannelExtract.h index 9ce9bcdd8a..6cd24648ba 100644 --- a/arm_compute/runtime/CL/functions/CLChannelExtract.h +++ b/arm_compute/runtime/CL/functions/CLChannelExtract.h @@ -34,7 +34,11 @@ class ICLMultiImage; class ICLTensor; using ICLImage = ICLTensor; -/** Basic function to run @ref CLChannelExtractKernel to perform channel extraction. */ +/** Basic function to run @ref CLChannelExtractKernel to perform channel extraction. + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLChannelExtract : public ICLSimpleFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLColorConvert.h b/arm_compute/runtime/CL/functions/CLColorConvert.h index 47bcabfb63..f30621e911 100644 --- a/arm_compute/runtime/CL/functions/CLColorConvert.h +++ b/arm_compute/runtime/CL/functions/CLColorConvert.h @@ -36,6 +36,9 @@ using ICLImage = ICLTensor; /** Basic function to run @ref CLColorConvertKernel * * @note The function performs color convert between images. + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLColorConvert : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLConvolution.h b/arm_compute/runtime/CL/functions/CLConvolution.h index 4a1631a702..44346767f3 100644 --- a/arm_compute/runtime/CL/functions/CLConvolution.h +++ b/arm_compute/runtime/CL/functions/CLConvolution.h @@ -50,6 +50,8 @@ class ICLTensor; * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLConvolution3x3Kernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLConvolution3x3 : public ICLSimpleFunction { @@ -83,6 +85,8 @@ public: * -# @ref CLConvolutionKernel or
* @ref CLSeparableConvolutionHorKernel and @ref CLSeparableConvolutionVertKernel (if convolution matrix is separable) * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ template class CLConvolutionSquare : public IFunction @@ -148,6 +152,9 @@ using CLConvolution9x9 = CLConvolutionSquare<9>; * -# @ref CLConvolutionRectangleKernel or
* * @note Convolution rectangle should have dimensions of 3, 5, 7, 9 + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLConvolutionRectangle : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLDerivative.h b/arm_compute/runtime/CL/functions/CLDerivative.h index 4a91d5d50b..8918dac0ea 100644 --- a/arm_compute/runtime/CL/functions/CLDerivative.h +++ b/arm_compute/runtime/CL/functions/CLDerivative.h @@ -39,6 +39,8 @@ class ICLTensor; * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLDerivativeKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLDerivative : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLDilate.h b/arm_compute/runtime/CL/functions/CLDilate.h index bf72cd3b26..e15621b5a4 100644 --- a/arm_compute/runtime/CL/functions/CLDilate.h +++ b/arm_compute/runtime/CL/functions/CLDilate.h @@ -38,7 +38,9 @@ class ICLTensor; * * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLDilateKernel -* + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLDilate : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLEqualizeHistogram.h b/arm_compute/runtime/CL/functions/CLEqualizeHistogram.h index 17352d1a9b..41479e3f22 100644 --- a/arm_compute/runtime/CL/functions/CLEqualizeHistogram.h +++ b/arm_compute/runtime/CL/functions/CLEqualizeHistogram.h @@ -45,6 +45,8 @@ using ICLImage = ICLTensor; * -# @ref CLHistogramKernel * -# @ref CLTableLookupKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLEqualizeHistogram : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLErode.h b/arm_compute/runtime/CL/functions/CLErode.h index 9d799bc91e..bd66ed983b 100644 --- a/arm_compute/runtime/CL/functions/CLErode.h +++ b/arm_compute/runtime/CL/functions/CLErode.h @@ -38,7 +38,9 @@ class ICLTensor; * * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLErodeKernel -* + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLErode : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLFastCorners.h b/arm_compute/runtime/CL/functions/CLFastCorners.h index e110582c50..608fdf8002 100644 --- a/arm_compute/runtime/CL/functions/CLFastCorners.h +++ b/arm_compute/runtime/CL/functions/CLFastCorners.h @@ -50,6 +50,8 @@ using ICLImage = ICLTensor; * -# @ref CLNonMaximaSuppression3x3Kernel (executed if nonmax_suppression == true) * -# @ref CLCopyToArrayKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLFastCorners : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLGaussian3x3.h b/arm_compute/runtime/CL/functions/CLGaussian3x3.h index 286a17618b..20ce2b4bea 100644 --- a/arm_compute/runtime/CL/functions/CLGaussian3x3.h +++ b/arm_compute/runtime/CL/functions/CLGaussian3x3.h @@ -39,6 +39,8 @@ class ICLTensor; * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLGaussian3x3Kernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLGaussian3x3 : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLGaussian5x5.h b/arm_compute/runtime/CL/functions/CLGaussian5x5.h index cf5b79eaac..d08cef21c3 100644 --- a/arm_compute/runtime/CL/functions/CLGaussian5x5.h +++ b/arm_compute/runtime/CL/functions/CLGaussian5x5.h @@ -47,6 +47,8 @@ class ICLTensor; * -# @ref CLGaussian5x5HorKernel * -# @ref CLGaussian5x5VertKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLGaussian5x5 : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLGaussianPyramid.h b/arm_compute/runtime/CL/functions/CLGaussianPyramid.h index b18e5f98f0..70be6738a6 100644 --- a/arm_compute/runtime/CL/functions/CLGaussianPyramid.h +++ b/arm_compute/runtime/CL/functions/CLGaussianPyramid.h @@ -42,7 +42,11 @@ class CLGaussianPyramidHorKernel; class CLGaussianPyramidVertKernel; class CLScaleKernel; -/** Common interface for all Gaussian pyramid functions */ +/** Common interface for all Gaussian pyramid functions + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLGaussianPyramid : public IFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLHOGDescriptor.h b/arm_compute/runtime/CL/functions/CLHOGDescriptor.h index fa37b3c84e..87bcd7f49e 100644 --- a/arm_compute/runtime/CL/functions/CLHOGDescriptor.h +++ b/arm_compute/runtime/CL/functions/CLHOGDescriptor.h @@ -44,6 +44,8 @@ class CLHOGBlockNormalizationKernel; * -# @ref CLHOGOrientationBinningKernel * -# @ref CLHOGBlockNormalizationKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLHOGDescriptor : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLHOGDetector.h b/arm_compute/runtime/CL/functions/CLHOGDetector.h index edc5b652d3..539a521797 100644 --- a/arm_compute/runtime/CL/functions/CLHOGDetector.h +++ b/arm_compute/runtime/CL/functions/CLHOGDetector.h @@ -42,6 +42,8 @@ class ICLHOG; * * -# @ref CLHOGDetectorKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLHOGDetector : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLHOGGradient.h b/arm_compute/runtime/CL/functions/CLHOGGradient.h index 39d26fb110..569490f333 100644 --- a/arm_compute/runtime/CL/functions/CLHOGGradient.h +++ b/arm_compute/runtime/CL/functions/CLHOGGradient.h @@ -44,6 +44,8 @@ class ITensorInfo; * -# @ref CLDerivative * -# @ref CLMagnitudePhaseKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLHOGGradient : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLHOGMultiDetection.h b/arm_compute/runtime/CL/functions/CLHOGMultiDetection.h index 2a2c9a0a5c..b9a51653f2 100644 --- a/arm_compute/runtime/CL/functions/CLHOGMultiDetection.h +++ b/arm_compute/runtime/CL/functions/CLHOGMultiDetection.h @@ -54,6 +54,9 @@ class CLHOGBlockNormalizationKernel; -# Normalization type -# L2 hysteresis threshold if the normalization type is L2HYS_NORM * + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLHOGMultiDetection : public IFunction { @@ -132,4 +135,4 @@ private: }; } -#endif /* ARM_COMPUTE_CLHOGMULTIDETECTION_H */ \ No newline at end of file +#endif /* ARM_COMPUTE_CLHOGMULTIDETECTION_H */ diff --git a/arm_compute/runtime/CL/functions/CLHarrisCorners.h b/arm_compute/runtime/CL/functions/CLHarrisCorners.h index c9c67f5a28..fc25c218ad 100644 --- a/arm_compute/runtime/CL/functions/CLHarrisCorners.h +++ b/arm_compute/runtime/CL/functions/CLHarrisCorners.h @@ -56,6 +56,9 @@ using ICLImage = ICLTensor; * -# @ref CLNonMaximaSuppression3x3 * -# @ref CPPCornerCandidatesKernel * -# @ref CPPSortEuclideanDistanceKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLHarrisCorners : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLHistogram.h b/arm_compute/runtime/CL/functions/CLHistogram.h index 164bd0a28a..b45a79e10e 100644 --- a/arm_compute/runtime/CL/functions/CLHistogram.h +++ b/arm_compute/runtime/CL/functions/CLHistogram.h @@ -37,6 +37,8 @@ class ICLTensor; * -# @ref CLHistogramKernel * -# @ref CLHistogramBorderKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLHistogram : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLIntegralImage.h b/arm_compute/runtime/CL/functions/CLIntegralImage.h index 0ecdbde8fe..b6c98dc9ab 100644 --- a/arm_compute/runtime/CL/functions/CLIntegralImage.h +++ b/arm_compute/runtime/CL/functions/CLIntegralImage.h @@ -40,6 +40,8 @@ class ICLTensor; * -# @ref CLIntegralImageHorKernel * -# @ref CLIntegralImageVertKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLIntegralImage : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLLaplacianPyramid.h b/arm_compute/runtime/CL/functions/CLLaplacianPyramid.h index e1a8b25cfb..875b714edd 100644 --- a/arm_compute/runtime/CL/functions/CLLaplacianPyramid.h +++ b/arm_compute/runtime/CL/functions/CLLaplacianPyramid.h @@ -50,6 +50,9 @@ class ICLTensor; * difference between the two tensors is the corresponding level L(i) of the Laplacian pyramid. * L(i) = I(i) - Gaussian5x5(I(i)) * Level 0 has always the same first two dimensions as the input tensor. + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLLaplacianPyramid : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLLaplacianReconstruct.h b/arm_compute/runtime/CL/functions/CLLaplacianReconstruct.h index 4ccc1a43e2..c780b56dd8 100644 --- a/arm_compute/runtime/CL/functions/CLLaplacianReconstruct.h +++ b/arm_compute/runtime/CL/functions/CLLaplacianReconstruct.h @@ -56,6 +56,9 @@ using ICLImage = ICLTensor; * I(i-1) = upsample(I(i) + L(i)) * * output = I(0) + L(0) + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLLaplacianReconstruct : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLMagnitude.h b/arm_compute/runtime/CL/functions/CLMagnitude.h index 6ac141641c..4ed1414613 100644 --- a/arm_compute/runtime/CL/functions/CLMagnitude.h +++ b/arm_compute/runtime/CL/functions/CLMagnitude.h @@ -32,7 +32,11 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLMagnitudePhaseKernel. */ +/** Basic function to run @ref CLMagnitudePhaseKernel. + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLMagnitude : public ICLSimpleFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLMedian3x3.h b/arm_compute/runtime/CL/functions/CLMedian3x3.h index 6c0458203e..1fe318e851 100644 --- a/arm_compute/runtime/CL/functions/CLMedian3x3.h +++ b/arm_compute/runtime/CL/functions/CLMedian3x3.h @@ -39,6 +39,8 @@ class ICLTensor; * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLMedian3x3Kernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLMedian3x3 : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLMinMaxLocation.h b/arm_compute/runtime/CL/functions/CLMinMaxLocation.h index 4e3f28b006..77c381f64d 100644 --- a/arm_compute/runtime/CL/functions/CLMinMaxLocation.h +++ b/arm_compute/runtime/CL/functions/CLMinMaxLocation.h @@ -41,6 +41,9 @@ using ICLImage = ICLTensor; * * -# @ref CLMinMaxKernel * -# @ref CLMinMaxLocationKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLMinMaxLocation : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLNonLinearFilter.h b/arm_compute/runtime/CL/functions/CLNonLinearFilter.h index 1b466bf662..3d0947db05 100644 --- a/arm_compute/runtime/CL/functions/CLNonLinearFilter.h +++ b/arm_compute/runtime/CL/functions/CLNonLinearFilter.h @@ -40,6 +40,9 @@ class ICLTensor; * -# @ref CLNonLinearFilterKernel * * @note Supported mask dimensions squares of sizes 3, 5 + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLNonLinearFilter : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLNonMaximaSuppression3x3.h b/arm_compute/runtime/CL/functions/CLNonMaximaSuppression3x3.h index c767a042ff..60dad42814 100644 --- a/arm_compute/runtime/CL/functions/CLNonMaximaSuppression3x3.h +++ b/arm_compute/runtime/CL/functions/CLNonMaximaSuppression3x3.h @@ -36,6 +36,9 @@ class ICLTensor; * * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLNonMaximaSuppression3x3Kernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLNonMaximaSuppression3x3 : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLOpticalFlow.h b/arm_compute/runtime/CL/functions/CLOpticalFlow.h index 0e34374aa5..5c555f5709 100644 --- a/arm_compute/runtime/CL/functions/CLOpticalFlow.h +++ b/arm_compute/runtime/CL/functions/CLOpticalFlow.h @@ -60,6 +60,9 @@ using CLOldValueArray = CLArray; * -# @ref CLLKTrackerStage0Kernel * -# @ref CLLKTrackerStage1Kernel * -# @ref CLLKTrackerFinalizeKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLOpticalFlow : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLPhase.h b/arm_compute/runtime/CL/functions/CLPhase.h index 34b8e72175..7c76c234fe 100644 --- a/arm_compute/runtime/CL/functions/CLPhase.h +++ b/arm_compute/runtime/CL/functions/CLPhase.h @@ -32,7 +32,11 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to execute an @ref CLMagnitudePhaseKernel. */ +/** Basic function to execute an @ref CLMagnitudePhaseKernel. + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLPhase : public ICLSimpleFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLRemap.h b/arm_compute/runtime/CL/functions/CLRemap.h index bf5d348b3b..87d5f9fec7 100644 --- a/arm_compute/runtime/CL/functions/CLRemap.h +++ b/arm_compute/runtime/CL/functions/CLRemap.h @@ -38,6 +38,9 @@ class ICLTensor; * * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLRemapKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLRemap : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLScharr3x3.h b/arm_compute/runtime/CL/functions/CLScharr3x3.h index 19c860f39b..4c747af19e 100644 --- a/arm_compute/runtime/CL/functions/CLScharr3x3.h +++ b/arm_compute/runtime/CL/functions/CLScharr3x3.h @@ -39,6 +39,8 @@ class ICLTensor; * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLScharr3x3Kernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLScharr3x3 : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLSobel3x3.h b/arm_compute/runtime/CL/functions/CLSobel3x3.h index 492900da11..1e5745374e 100644 --- a/arm_compute/runtime/CL/functions/CLSobel3x3.h +++ b/arm_compute/runtime/CL/functions/CLSobel3x3.h @@ -39,6 +39,8 @@ class ICLTensor; * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) * -# @ref CLSobel3x3Kernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLSobel3x3 : public ICLSimpleFunction { diff --git a/arm_compute/runtime/CL/functions/CLSobel5x5.h b/arm_compute/runtime/CL/functions/CLSobel5x5.h index a00fdd72b8..e791d8a9e7 100644 --- a/arm_compute/runtime/CL/functions/CLSobel5x5.h +++ b/arm_compute/runtime/CL/functions/CLSobel5x5.h @@ -47,6 +47,8 @@ class ICLTensor; * -# @ref CLSobel5x5HorKernel * -# @ref CLSobel5x5VertKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLSobel5x5 : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLSobel7x7.h b/arm_compute/runtime/CL/functions/CLSobel7x7.h index 01a863b11b..65e8de55b4 100644 --- a/arm_compute/runtime/CL/functions/CLSobel7x7.h +++ b/arm_compute/runtime/CL/functions/CLSobel7x7.h @@ -47,6 +47,8 @@ class ICLTensor; * -# @ref CLSobel7x7HorKernel * -# @ref CLSobel7x7VertKernel * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * */ class CLSobel7x7 : public IFunction { diff --git a/arm_compute/runtime/CL/functions/CLThreshold.h b/arm_compute/runtime/CL/functions/CLThreshold.h index 2c9213bd01..c536232e71 100644 --- a/arm_compute/runtime/CL/functions/CLThreshold.h +++ b/arm_compute/runtime/CL/functions/CLThreshold.h @@ -36,7 +36,11 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLThresholdKernel */ +/** Basic function to run @ref CLThresholdKernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLThreshold : public ICLSimpleFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLWarpAffine.h b/arm_compute/runtime/CL/functions/CLWarpAffine.h index 153e9bfdfc..2f73097fcf 100644 --- a/arm_compute/runtime/CL/functions/CLWarpAffine.h +++ b/arm_compute/runtime/CL/functions/CLWarpAffine.h @@ -34,7 +34,11 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLWarpAffineKernel for AFFINE transformation */ +/** Basic function to run @ref CLWarpAffineKernel for AFFINE transformation + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLWarpAffine : public ICLSimpleFunction { public: diff --git a/arm_compute/runtime/CL/functions/CLWarpPerspective.h b/arm_compute/runtime/CL/functions/CLWarpPerspective.h index 5c8b5425a4..4e2c81e71c 100644 --- a/arm_compute/runtime/CL/functions/CLWarpPerspective.h +++ b/arm_compute/runtime/CL/functions/CLWarpPerspective.h @@ -34,7 +34,11 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLWarpPerspectiveKernel for PERSPECTIVE transformation */ +/** Basic function to run @ref CLWarpPerspectiveKernel for PERSPECTIVE transformation + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + * +*/ class CLWarpPerspective : public ICLSimpleFunction { public: diff --git a/docs/00_introduction.dox b/docs/00_introduction.dox index ca09e1ea8d..c1c9af467d 100644 --- a/docs/00_introduction.dox +++ b/docs/00_introduction.dox @@ -123,10 +123,102 @@ v20.11 Public major release - @ref NEReductionOperationKernel - @ref NEGEMMLowpMatrixAReductionKernel - @ref NEGEMMLowpMatrixBReductionKernel - - Deprecated OpenCL kernels / functions: + - Deprecated OpenCL kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together): - CLLocallyConnectedLayer - CLLocallyConnectedMatrixMultiplyKernel - - Deprecated NEON kernels / functions: + - CLAbsoluteDifference + - CLAbsoluteDifferenceKernel + - CLAccumulate + - CLAccumulateKernel + - CLAccumulateSquared + - CLAccumulateSquaredKernel + - CLAccumulateWeighted + - CLAccumulateWeightedKernel + - CLAccumulateWeightedFP16Kernel + - CLBox3x3 + - CLBox3x3Kernel + - CLBox3x3FP16Kernel + - CLCannyEdge + - CLChannelCombine + - CLChannelCombineKernel + - CLChannelExtract + - CLChannelExtractKernel + - CLColorConvert + - CLColorConvertKernel + - CLConvolution3x3 + - CLConvolutionRectangle + - CLConvolutionRectangleKernel + - CLConvolutionSquare + - CLConvolutionKernel + - CLDerivative + - CLDerivativeKernel + - CLDilate + - CLDilateKernel + - CLEqualizeHistogram + - CLErode + - CLErodeKernel + - CLFastCorners + - CLFastCornersKernel + - CLGaussian3x3 + - CLGaussian3x3Kernel + - CLGaussian5x5 + - CLGaussian5x5HorKernel + - CLGaussian5x5VertKernel + - CLGaussianPyramid + - CLGaussianPyramidHalf + - CLGaussianPyramidOrb + - CLHarrisCorners + - CLHarrisScoreKernel + - CLHarrisScoreFP16Kernel + - CLHistogram + - CLHistogramKernel + - CLHOGOrientationBinningKernel + - CLHOGBlockNormalizationKernel + - CLHOGDetectorKernel + - CLHOGNonMaximaSuppressionKernel + - CLHOGDescriptor + - CLHOGDetector + - CLHOGGradient + - CLHOGMultiDetection + - CLHOGOrientationBinningKernel + - CLHOGBlockNormalizationKernel + - CLHOGDetectorKernel + - CLIntegralImage + - CLIntegralImageKernel + - CLLaplacianReconstruct + - CLLaplacianPyramid + - CLMagnitude + - CLMagnitudePhaseKernel + - CLMedian3x3 + - CLMedian3x3Kernel + - CLMinMaxLocation + - CLMinMaxLocationKernel + - CLNonLinearFilter + - CLNonLinearFilterKernel + - CLNonMaximaSuppression3x3 + - CLNonMaximaSuppression3x3FP16Kernel + - CLNonMaximaSuppression3x3Kernel + - CLOpticalFlow + - CLPhase + - CLRemap + - CLRemapKernel + - CLScharr3x3 + - CLScharr3x3Kernel + - CLSobel3x3 + - CLSobel3x3Kernel + - CLSobel5x5 + - CLSobel5x5HorKernel + - CLSobel5x5VertKernel + - CLSobel7x7 + - CLSobel7x7HorKernel + - CLSobel7x7VertKernel + - CLThreshold + - CLThresholdKernel + - CLWarpAffine + - CLWarpAffineKernel + - CLWarpPerspective + - CLWarpPerspectiveKernel + - Deprecated NEON kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together): - NELocallyConnectedLayer - NELocallyConnectedMatrixMultiplyKernel - NEAbsoluteDifference -- cgit v1.2.1