From ee82d349a53d8f70cc2481581849575291872842 Mon Sep 17 00:00:00 2001 From: Michele Di Giorgio Date: Tue, 5 Jan 2021 16:14:28 +0000 Subject: Fix Doxygen references Some references are no longer valid because the kernels/functions have been removed. Change-Id: Iccfaabb678a4b2709442e4eb827800e63ea47b05 Signed-off-by: Michele Di Giorgio Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/4764 Reviewed-by: Michalis Spyrou Comments-Addressed: Arm Jenkins Tested-by: Arm Jenkins --- arm_compute/graph/frontend/Layers.h | 5 ++--- arm_compute/runtime/CL/functions/CLBitwiseAnd.h | 4 ++-- arm_compute/runtime/CL/functions/CLBitwiseNot.h | 4 ++-- arm_compute/runtime/CL/functions/CLBitwiseOr.h | 4 ++-- arm_compute/runtime/CL/functions/CLBitwiseXor.h | 4 ++-- arm_compute/runtime/CL/functions/CLFlattenLayer.h | 4 ++-- arm_compute/runtime/CL/functions/CLGenerateProposalsLayer.h | 4 ++-- .../runtime/NEON/functions/NEGenerateProposalsLayer.h | 4 ++-- docs/00_introduction.dox | 2 +- docs/06_functions_list.dox | 12 ------------ 10 files changed, 17 insertions(+), 30 deletions(-) diff --git a/arm_compute/graph/frontend/Layers.h b/arm_compute/graph/frontend/Layers.h index c4de4013b2..bf68b269da 100644 --- a/arm_compute/graph/frontend/Layers.h +++ b/arm_compute/graph/frontend/Layers.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2020 Arm Limited. + * Copyright (c) 2018-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -1465,8 +1465,7 @@ class YOLOLayer final : public ILayer public: /** Construct a YOLO layer. * - * @param[in] act_info Activation info - * @param[in] num_classes Number of classes to activate + * @param[in] act_info Activation info */ YOLOLayer(ActivationLayerInfo act_info) : _act_info(act_info) diff --git a/arm_compute/runtime/CL/functions/CLBitwiseAnd.h b/arm_compute/runtime/CL/functions/CLBitwiseAnd.h index bf5993f4b0..a703242875 100644 --- a/arm_compute/runtime/CL/functions/CLBitwiseAnd.h +++ b/arm_compute/runtime/CL/functions/CLBitwiseAnd.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2020 Arm Limited. + * Copyright (c) 2016-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -31,7 +31,7 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLBitwiseAndKernel. +/** Basic function to perform bitwise AND by running @ref CLBitwiseKernel. * * @note The tensor data type for the inputs must be U8. * @note The function performs a bitwise AND operation using the two input tensors. diff --git a/arm_compute/runtime/CL/functions/CLBitwiseNot.h b/arm_compute/runtime/CL/functions/CLBitwiseNot.h index 1d8531a176..6f65749d9f 100644 --- a/arm_compute/runtime/CL/functions/CLBitwiseNot.h +++ b/arm_compute/runtime/CL/functions/CLBitwiseNot.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2020 Arm Limited. + * Copyright (c) 2016-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -31,7 +31,7 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLBitwiseNotKernel. +/** Basic function to perform bitwise NOT by running @ref CLBitwiseKernel. * * @note The tensor data type for the inputs must be U8. * @note The function performs a bitwise NOT operation on input tensor. diff --git a/arm_compute/runtime/CL/functions/CLBitwiseOr.h b/arm_compute/runtime/CL/functions/CLBitwiseOr.h index 7876cbf196..3c904fb903 100644 --- a/arm_compute/runtime/CL/functions/CLBitwiseOr.h +++ b/arm_compute/runtime/CL/functions/CLBitwiseOr.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2020 Arm Limited. + * Copyright (c) 2016-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -31,7 +31,7 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLBitwiseOrKernel. +/** Basic function to perform bitwise OR by running @ref CLBitwiseKernel. * * @note The tensor data type for the inputs must be U8. * @note The function performs a bitwise OR operation using the two input tensors. diff --git a/arm_compute/runtime/CL/functions/CLBitwiseXor.h b/arm_compute/runtime/CL/functions/CLBitwiseXor.h index 4f054062cd..a33a64ad71 100644 --- a/arm_compute/runtime/CL/functions/CLBitwiseXor.h +++ b/arm_compute/runtime/CL/functions/CLBitwiseXor.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2020 Arm Limited. + * Copyright (c) 2016-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -31,7 +31,7 @@ namespace arm_compute class CLCompileContext; class ICLTensor; -/** Basic function to run @ref CLBitwiseXorKernel. +/** Basic function to perform bitwise XOR by running @ref CLBitwiseKernel. * * @note The tensor data type for the inputs must be U8. * @note The function performs a bitwise XOR operation using the two input tensors. diff --git a/arm_compute/runtime/CL/functions/CLFlattenLayer.h b/arm_compute/runtime/CL/functions/CLFlattenLayer.h index ffe06aa610..8dedd7458d 100644 --- a/arm_compute/runtime/CL/functions/CLFlattenLayer.h +++ b/arm_compute/runtime/CL/functions/CLFlattenLayer.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2020 Arm Limited. + * Copyright (c) 2017-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -36,7 +36,7 @@ class ITensorInfo; /** Basic function to execute flatten. This function calls the following OpenCL kernel: * -* -# @ref CLFlattenLayerKernel +* -# @ref CLReshapeLayer * */ class CLFlattenLayer : public IFunction diff --git a/arm_compute/runtime/CL/functions/CLGenerateProposalsLayer.h b/arm_compute/runtime/CL/functions/CLGenerateProposalsLayer.h index 0fb9a06c84..cf5fd500a0 100644 --- a/arm_compute/runtime/CL/functions/CLGenerateProposalsLayer.h +++ b/arm_compute/runtime/CL/functions/CLGenerateProposalsLayer.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2020 Arm Limited. + * Copyright (c) 2019-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -50,7 +50,7 @@ class ITensorInfo; /** Basic function to generate proposals for a RPN (Region Proposal Network) * * This function calls the following OpenCL kernels: - * -# @ref CLComputeAllAnchors + * -# @ref CLComputeAllAnchorsKernel * -# @ref CLPermute x 2 * -# @ref CLReshapeLayer x 2 * -# @ref CLBoundingBoxTransform diff --git a/arm_compute/runtime/NEON/functions/NEGenerateProposalsLayer.h b/arm_compute/runtime/NEON/functions/NEGenerateProposalsLayer.h index 40533584b9..90e2307ce8 100644 --- a/arm_compute/runtime/NEON/functions/NEGenerateProposalsLayer.h +++ b/arm_compute/runtime/NEON/functions/NEGenerateProposalsLayer.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2020 Arm Limited. + * Copyright (c) 2019-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -45,7 +45,7 @@ class NEComputeAllAnchorsKernel; /** Basic function to generate proposals for a RPN (Region Proposal Network) * * This function calls the following Neon kernels: - * -# @ref NEComputeAllAnchors + * -# @ref NEComputeAllAnchorsKernel * -# @ref NEPermute x 2 * -# @ref NEReshapeLayer x 2 * -# @ref NEBoundingBoxTransform diff --git a/docs/00_introduction.dox b/docs/00_introduction.dox index db87540f37..5210b325cc 100644 --- a/docs/00_introduction.dox +++ b/docs/00_introduction.dox @@ -1191,7 +1191,7 @@ v17.09 Public major release - CLFlattenLayer - @ref CLFloorKernel / @ref CLFloor - CLGEMMTranspose1xW - - @ref CLGEMMMatrixVectorMultiplyKernel + - CLGEMMMatrixVectorMultiplyKernel - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer diff --git a/docs/06_functions_list.dox b/docs/06_functions_list.dox index c8006c6c3d..61712a29f5 100644 --- a/docs/06_functions_list.dox +++ b/docs/06_functions_list.dox @@ -40,7 +40,6 @@ namespace arm_compute - @ref NEBox3x3 - @ref NECast - @ref NEComplexPixelWiseMultiplication - - @ref NEComputeAllAnchors - @ref NEConvolution3x3 - @ref NEConvolutionRectangle - @ref NEDilate @@ -85,7 +84,6 @@ namespace arm_compute - @ref NEChannelCombine - @ref NEChannelExtract - @ref NEChannelShuffleLayer - - @ref NECol2Im - @ref NEColorConvert - @ref NECopy - @ref NEDepthConvertLayer @@ -93,10 +91,8 @@ namespace arm_compute - @ref NEFloor - @ref NEFullyConnectedLayerReshapeWeights - @ref NEGather - - @ref NEGEMMInterleave4x4 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint - - @ref NEGEMMTranspose1xW - @ref NEHOGDetector - @ref NEMagnitude - @ref NEMeanStdDevNormalizationLayer @@ -111,7 +107,6 @@ namespace arm_compute - @ref NEThreshold - @ref NETile - @ref NETranspose - - @ref NEYOLOLayer - @ref NEArgMinMaxLayer - @ref NEBatchNormalizationLayer - @ref NECannyEdge @@ -153,12 +148,10 @@ namespace arm_compute - @ref NEHOGDescriptor - @ref NEHOGGradient - @ref NEHOGMultiDetection - - @ref NEIm2Col - @ref NEInstanceNormalizationLayer - @ref NEL2NormalizeLayer - @ref NELaplacianPyramid - @ref NELaplacianReconstruct - - @ref NELocallyConnectedLayer - @ref NELSTMLayer - @ref NELSTMLayerQuantized - @ref NEQLSTMLayer @@ -184,7 +177,6 @@ namespace arm_compute - @ref NESplit - @ref NEStackLayer - @ref NEUnstack - - @ref NEUpsampleLayer - @ref NEWinogradConvolutionLayer @section S6_2 OpenCL functions @@ -232,7 +224,6 @@ namespace arm_compute - @ref CLL2NormalizeLayer - @ref CLLaplacianPyramid - @ref CLLaplacianReconstruct - - @ref CLLocallyConnectedLayer - @ref CLLogicalAnd - @ref CLLogicalNot - @ref CLLogicalOr @@ -258,7 +249,6 @@ namespace arm_compute - @ref CLSplit - @ref CLStackLayer - @ref CLUnstack - - @ref CLUpsampleLayer - @ref CLWinogradConvolutionLayer - @ref ICLSimpleFunction - @ref CLAbsoluteDifference @@ -283,7 +273,6 @@ namespace arm_compute - @ref CLColorConvert - @ref CLComparison - @ref CLComparisonStatic - - @ref CLComputeAllAnchors - @ref CLConvertFullyConnectedWeights - @ref CLConvolution3x3 - @ref CLConvolutionRectangle @@ -338,7 +327,6 @@ namespace arm_compute - @ref CLWarpAffine - @ref CLWarpPerspective - @ref CLWinogradInputTransform - - @ref CLYOLOLayer @section S6_3 GLES Compute functions -- cgit v1.2.1