diff options
author | Manuel Bottini <manuel.bottini@arm.com> | 2019-02-07 10:31:57 +0000 |
---|---|---|
committer | Manuel Bottini <manuel.bottini@arm.com> | 2019-02-12 14:01:28 +0000 |
commit | 581c898aa5612e60392e3b785d1ac216ce7a4650 (patch) | |
tree | e616231601bac09f07c4c5db3a23c9229e577dd8 | |
parent | 661c252bdaf272e1d574ba3fdf05868e50a8d858 (diff) | |
download | ComputeLibrary-581c898aa5612e60392e3b785d1ac216ce7a4650.tar.gz |
COMPMID-1934: Doxygen online documentation errors on Firefox
Change-Id: I669d57380d95760399cd7fd28c58d0e636d706dd
Signed-off-by: Manuel Bottini <manuel.bottini@arm.com>
Reviewed-on: https://review.mlplatform.org/647
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Pablo Marquez <pablo.tello@arm.com>
-rw-r--r-- | arm_compute/core/CL/kernels/CLDirectConvolutionLayerOutputStageKernel.h | 5 | ||||
-rw-r--r-- | arm_compute/core/Types.h | 2 | ||||
-rw-r--r-- | arm_compute/core/Utils.h | 8 | ||||
-rw-r--r-- | arm_compute/runtime/CL/functions/CLDeconvolutionLayer.h | 4 | ||||
-rw-r--r-- | arm_compute/runtime/NEON/functions/NEGEMMLowpAssemblyMatrixMultiplyCore.h | 4 | ||||
-rw-r--r-- | docs/05_functions_list.dox | 6 | ||||
-rw-r--r-- | docs/Doxyfile | 2 | ||||
-rw-r--r-- | docs/header.html | 3 | ||||
-rw-r--r-- | src/core/CL/kernels/CLDirectConvolutionOutputStageKernel.cpp | 4 |
9 files changed, 21 insertions, 17 deletions
diff --git a/arm_compute/core/CL/kernels/CLDirectConvolutionLayerOutputStageKernel.h b/arm_compute/core/CL/kernels/CLDirectConvolutionLayerOutputStageKernel.h index d90a2cf4b8..80bc012d9f 100644 --- a/arm_compute/core/CL/kernels/CLDirectConvolutionLayerOutputStageKernel.h +++ b/arm_compute/core/CL/kernels/CLDirectConvolutionLayerOutputStageKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018 ARM Limited. + * Copyright (c) 2018-2019 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -31,7 +31,10 @@ namespace arm_compute class ITensor; /** OpenCL kernel to accumulate the biases, if provided, or downscale in case of quantized input. * + * @deprecated This kernel is deprecated and will be removed in release 19.05 + * * @note We assume bias to be shared + * */ class CLDirectConvolutionLayerOutputStageKernel : public ICLKernel { diff --git a/arm_compute/core/Types.h b/arm_compute/core/Types.h index 9fbd0ef9fb..1ce44ee2e8 100644 --- a/arm_compute/core/Types.h +++ b/arm_compute/core/Types.h @@ -1455,7 +1455,7 @@ public: RELU, /**< Rectifier ( \f$ f(x) = max(0,x) \f$ ) */ BOUNDED_RELU, /**< Upper Bounded Rectifier ( \f$ f(x) = min(a, max(0,x)) \f$ ) */ LU_BOUNDED_RELU, /**< Lower and Upper Bounded Rectifier ( \f$ f(x) = min(a, max(b,x)) \f$ ) */ - LEAKY_RELU, /**< Leaky Rectifier ( \f$ f(x)= log(1+e^x) \f$ ) */ + LEAKY_RELU, /**< Leaky Rectifier ( \f$ f(x) = \begin{cases} \alpha x & \quad \text{if } x \text{ < 0}\\ x & \quad \text{if } x \geq \text{ 0 } \end{cases} \f$ ) */ SOFT_RELU, /**< Soft Rectifier ( \f$ f(x)= log(1+e^x) \f$ ) */ ABS, /**< Absolute ( \f$ f(x)= |x| \f$ ) */ SQUARE, /**< Square ( \f$ f(x)= x^2 \f$ )*/ diff --git a/arm_compute/core/Utils.h b/arm_compute/core/Utils.h index d112259d39..2640264f55 100644 --- a/arm_compute/core/Utils.h +++ b/arm_compute/core/Utils.h @@ -634,10 +634,10 @@ inline uint32_t calculate_matrix_scale(const int16_t *matrix, unsigned int matri /** Adjust tensor shape size if width or height are odd for a given multi-planar format. No modification is done for other formats. * * @note Adding here a few links discussing the issue of odd size and sharing the same solution: - * Android Source: https://android.googlesource.com/platform/frameworks/base/+/refs/heads/master/graphics/java/android/graphics/YuvImage.java - * WebM: https://groups.google.com/a/webmproject.org/forum/#!topic/webm-discuss/LaCKpqiDTXM - * libYUV: https://bugs.chromium.org/p/libyuv/issues/detail?id=198&can=1&q=odd%20width - * YUVPlayer: https://sourceforge.net/p/raw-yuvplayer/bugs/1/ + * <a href="https://android.googlesource.com/platform/frameworks/base/+/refs/heads/master/graphics/java/android/graphics/YuvImage.java">Android Source</a> + * <a href="https://groups.google.com/a/webmproject.org/forum/#!topic/webm-discuss/LaCKpqiDTXM">WebM</a> + * <a href="https://bugs.chromium.org/p/libyuv/issues/detail?id=198&can=1&q=odd%20width">libYUV</a> + * <a href="https://sourceforge.net/p/raw-yuvplayer/bugs/1/">YUVPlayer</a> * * * @param[in, out] shape Tensor shape of 2D size * @param[in] format Format of the tensor diff --git a/arm_compute/runtime/CL/functions/CLDeconvolutionLayer.h b/arm_compute/runtime/CL/functions/CLDeconvolutionLayer.h index 2963156d11..9c115f8b3d 100644 --- a/arm_compute/runtime/CL/functions/CLDeconvolutionLayer.h +++ b/arm_compute/runtime/CL/functions/CLDeconvolutionLayer.h @@ -85,7 +85,7 @@ public: CLDeconvolutionLayer &operator=(CLDeconvolutionLayer &&) = default; /** Set the input, weights, biases and output tensors. * - * @note This method will be deprecated in the next release. + * @deprecated This method is deprecated and will be removed in release 19.05 * * @param[in,out] input Input tensor. 3 lower dimensions represent a single input, and an optional 4th dimension for batch of inputs. Data types supported: QASYMM8/F16/F32. * @param[in] weights The 4d weights with dimensions [width, height, IFM, OFM]. Data type supported: Same as @p input. @@ -101,7 +101,7 @@ public: unsigned int inner_border_right, unsigned int inner_border_top, const WeightsInfo &weights_info = WeightsInfo()); /** Static function to check if given info will lead to a valid configuration of @ref CLDeconvolutionLayer * - * @note This method will be deprecated in the next release. + * @deprecated This method is deprecated and will be removed in release 19.05 * * @param[in] input Input tensor info. 3 lower dimensions represent a single input, and an optional 4th dimension for batch of inputs. Data types supported: QASYMM8/F16/F32. * @param[in] weights The 4d weights info with dimensions [width, height, IFM, OFM]. Data type supported: Same as @p input. diff --git a/arm_compute/runtime/NEON/functions/NEGEMMLowpAssemblyMatrixMultiplyCore.h b/arm_compute/runtime/NEON/functions/NEGEMMLowpAssemblyMatrixMultiplyCore.h index 92d0fb320b..38682843b7 100644 --- a/arm_compute/runtime/NEON/functions/NEGEMMLowpAssemblyMatrixMultiplyCore.h +++ b/arm_compute/runtime/NEON/functions/NEGEMMLowpAssemblyMatrixMultiplyCore.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2018 ARM Limited. + * Copyright (c) 2017-2019 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -49,7 +49,7 @@ public: * * @param[in] a First input tensor (Matrix A). Data type supported: U8, S8. * @param[in] b Second input tensor (Matrix B). Data type supported: same as @p a - * @param[out] output Output tensor. Data type supported: Data type supported: S32 + * @param[out] output Output tensor. Data type supported: Data type supported: U32, S32 */ void configure(const ITensor *a, const ITensor *b, ITensor *output); diff --git a/docs/05_functions_list.dox b/docs/05_functions_list.dox index 9848307b21..777a8a2519 100644 --- a/docs/05_functions_list.dox +++ b/docs/05_functions_list.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2018 ARM Limited. +/// Copyright (c) 2018-2019 ARM Limited. /// /// SPDX-License-Identifier: MIT /// @@ -91,7 +91,7 @@ namespace arm_compute - @ref NEConvertFullyConnectedWeights - @ref NEConvolutionLayer - @ref NEConvolutionLayerReshapeWeights - - @ref NEConvolutionSquare<matrix_size> + - @ref NEConvolutionSquare <matrix_size> - @ref NEDeconvolutionLayer - @ref NEDepthConcatenateLayer - @ref NEDepthwiseConvolutionLayer @@ -153,7 +153,7 @@ namespace arm_compute - @ref CLConcatenateLayer - @ref CLConvolutionLayer - @ref CLConvolutionLayerReshapeWeights - - @ref CLConvolutionSquare<matrix_size> + - @ref CLConvolutionSquare <matrix_size> - @ref CLDeconvolutionLayer - @ref CLDeconvolutionLayerUpsample - @ref CLDepthConcatenateLayer diff --git a/docs/Doxyfile b/docs/Doxyfile index d1eeee07a9..17208d1404 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.9.1 +# Doxyfile 1.8.15 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. diff --git a/docs/header.html b/docs/header.html index 1a4572135c..f28df2c331 100644 --- a/docs/header.html +++ b/docs/header.html @@ -1,4 +1,5 @@ -<!-- HTML header for doxygen 1.8.9.1--> +<!-- HTML header for doxygen 1.8.15--> +<!-- Remember to use version doxygen 1.8.15 +--> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> diff --git a/src/core/CL/kernels/CLDirectConvolutionOutputStageKernel.cpp b/src/core/CL/kernels/CLDirectConvolutionOutputStageKernel.cpp index 5f4dacb269..22149b4ea4 100644 --- a/src/core/CL/kernels/CLDirectConvolutionOutputStageKernel.cpp +++ b/src/core/CL/kernels/CLDirectConvolutionOutputStageKernel.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018 ARM Limited. + * Copyright (c) 2018-2019 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -42,7 +42,7 @@ Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, con { ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input); ARM_COMPUTE_RETURN_ERROR_ON_F16_UNSUPPORTED(input); - ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(input, 1, DataType::QASYMM8, DataType::S32, DataType::F16, + ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(input, 1, DataType::S32, DataType::F16, DataType::F32); if(bias != nullptr) |