!43023 shield some api doc in r1.9

Merge pull request !43023 from panfengfeng/code_docs_shield_api_doc_1.9
2022-09-27 09:18:55 +00:00 · 2022-09-27 09:18:55 +00:00 · 80dab8fbbb
parent d92f9106a2 a510c817ad
commit 80dab8fbbb
8 changed files with 44 additions and 70 deletions
--- a/docs/api/api_python/dataset/mindspore.dataset.serialize.rst
+++ b/docs/api/api_python/dataset/mindspore.dataset.serialize.rst
@ -1,5 +1,5 @@
 mindspore.dataset.serialize
-============================
+===========================

 .. py:function:: mindspore.dataset.serialize(dataset, json_filepath='')

@ -16,4 +16,5 @@
        Dict，包含序列化数据集图的字典。

    异常：
+        - **ValueError** - 不支持用户定义的Python函数的序列化。
        - **OSError** - 无法打开文件。
--- a/docs/api/api_python/mindspore.ops.functional.rst
+++ b/docs/api/api_python/mindspore.ops.functional.rst
@ -12,14 +12,10 @@ mindspore.ops.functional
    :nosignatures:
    :template: classtemplate.rst

-    mindspore.ops.adaptive_avg_pool1d
    mindspore.ops.adaptive_avg_pool2d
    mindspore.ops.adaptive_avg_pool3d
-    mindspore.ops.adaptive_max_pool1d
    mindspore.ops.adaptive_max_pool3d
    mindspore.ops.avg_pool2d
-    mindspore.ops.batch_norm
-    mindspore.ops.bias_add
    mindspore.ops.ctc_greedy_decoder
    mindspore.ops.conv2d
    mindspore.ops.deformable_conv2d
@ -45,7 +41,6 @@ mindspore.ops.functional
    :nosignatures:
    :template: classtemplate.rst

-    mindspore.ops.binary_cross_entropy
    mindspore.ops.binary_cross_entropy_with_logits
    mindspore.ops.cross_entropy
    mindspore.ops.nll_loss
@ -94,16 +89,6 @@ mindspore.ops.functional

    mindspore.ops.cdist

-数学运算函数
-^^^^^^^^^^^^^^^^^
-
-.. mscnplatformautosummary::
-    :toctree: ops
-    :nosignatures:
-    :template: classtemplate.rst
-
-    mindspore.ops.bmm
-
 逐元素运算
 ^^^^^^^^^^^^^

@ -113,7 +98,6 @@ mindspore.ops.functional
    :template: classtemplate.rst

    mindspore.ops.abs
-    mindspore.ops.accumulate_n
    mindspore.ops.acos
    mindspore.ops.acosh
    mindspore.ops.add
@ -188,7 +172,6 @@ Reduction函数

    mindspore.ops.amax
    mindspore.ops.amin
-    mindspore.ops.argmax
    mindspore.ops.argmin
    mindspore.ops.cummax
    mindspore.ops.cummin
--- a/docs/api/api_python/mindspore/mindspore.Tensor.rst
+++ b/docs/api/api_python/mindspore/mindspore.Tensor.rst
@ -39,15 +39,6 @@ mindspore.Tensor
    mindspore.Tensor.hardshrink
    mindspore.Tensor.soft_shrink

-数学运算方法
-^^^^^^^^^^^^^^^
-
-.. mscnplatformautosummary::
-    :toctree: Tensor
-    :nosignatures:
-
-    mindspore.Tensor.bmm
-
 逐元素运算
 ^^^^^^^^^^^^^

@ -56,15 +47,8 @@ mindspore.Tensor
    :nosignatures:

    mindspore.Tensor.abs
-    mindspore.Tensor.add
-    mindspore.Tensor.addr
    mindspore.Tensor.addcdiv
    mindspore.Tensor.addcmul
-    mindspore.Tensor.asin
-    mindspore.Tensor.addmv
-    mindspore.Tensor.asinh
-    mindspore.Tensor.atan
-    mindspore.Tensor.atanh
    mindspore.Tensor.atan2
    mindspore.Tensor.bernoulli
    mindspore.Tensor.bitwise_and
--- a/docs/api/api_python/ops/mindspore.ops.Argmax.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Argmax.rst
@ -5,4 +5,22 @@

    返回输入Tensor在指定轴上的最大值索引。

-    详情请查看 :func:`mindspore.ops.argmax` 。
+    如果输入Tensor的shape为 :math:`(x_1, ..., x_N)` ，则输出Tensor的shape为 :math:`(x_1, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。
+
+    参数：
+        - **axis** (int) - 指定Argmax计算轴。默认值：-1。
+        - **output_type** (:class:`mindspore.dtype`) - 指定输出数据类型。默认值： `mindspore.dtype.int32` 。
+
+    输入：
+        - **input_x** (Tensor) - Argmax的输入，shape： :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。支持的数据类型如下所示：
+
+          - Ascend：float16和float32。
+          - GPU：float16和float32。
+          - CPU：float16、float32和float64。
+
+    输出：
+        Tensor，输出为指定轴上输入Tensor最大值的索引。
+
+    异常：
+        - **TypeError** - `axis` 不是int。
+        - **TypeError** - `output_type` 既不是int32也不是int64。
--- a/docs/api/api_python_en/Tensor_list.rst
+++ b/docs/api/api_python_en/Tensor_list.rst
@ -44,15 +44,6 @@ Activation Function
    mindspore.Tensor.hardshrink
    mindspore.Tensor.soft_shrink

-Mathematical Methods
-^^^^^^^^^^^^^^^^^^^^
-
-.. msplatformautosummary::
-    :toctree: Tensor
-    :nosignatures:
-
-    mindspore.Tensor.bmm
-
 Element-wise Methods
 ^^^^^^^^^^^^^^^^^^^^

@ -61,15 +52,8 @@ Element-wise Methods
    :nosignatures:

    mindspore.Tensor.abs
-    mindspore.Tensor.add
    mindspore.Tensor.addcdiv
    mindspore.Tensor.addcmul
-    mindspore.Tensor.addr
-    mindspore.Tensor.asin
-    mindspore.Tensor.addmv
-    mindspore.Tensor.asinh
-    mindspore.Tensor.atan
-    mindspore.Tensor.atanh
    mindspore.Tensor.atan2
    mindspore.Tensor.bernoulli
    mindspore.Tensor.bitwise_and
--- a/docs/api/api_python_en/mindspore.ops.functional.rst
+++ b/docs/api/api_python_en/mindspore.ops.functional.rst
@ -12,14 +12,10 @@ Neural Network
    :nosignatures:
    :template: classtemplate.rst

-    mindspore.ops.adaptive_avg_pool1d
    mindspore.ops.adaptive_avg_pool2d
    mindspore.ops.adaptive_avg_pool3d
-    mindspore.ops.adaptive_max_pool1d
    mindspore.ops.adaptive_max_pool3d
    mindspore.ops.avg_pool2d
-    mindspore.ops.batch_norm
-    mindspore.ops.bias_add
    mindspore.ops.conv2d
    mindspore.ops.ctc_greedy_decoder
    mindspore.ops.deformable_conv2d
@ -46,7 +42,6 @@ Loss Functions
    :nosignatures:
    :template: classtemplate.rst

-    mindspore.ops.binary_cross_entropy
    mindspore.ops.binary_cross_entropy_with_logits
    mindspore.ops.cross_entropy
    mindspore.ops.nll_loss
@ -95,16 +90,6 @@ Distance Functions

    mindspore.ops.cdist

-Mathematical Functions
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. msplatformautosummary::
-    :toctree: ops
-    :nosignatures:
-    :template: classtemplate.rst
-
-    mindspore.ops.bmm
-
 Element-by-Element Operations
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

@ -114,7 +99,6 @@ Element-by-Element Operations
    :template: classtemplate.rst

    mindspore.ops.abs
-    mindspore.ops.accumulate_n
    mindspore.ops.acos
    mindspore.ops.acosh
    mindspore.ops.add
@ -188,7 +172,6 @@ Reduction Functions

    mindspore.ops.amax
    mindspore.ops.amin
-    mindspore.ops.argmax
    mindspore.ops.argmin
    mindspore.ops.cummax
    mindspore.ops.cummin
--- a/mindspore/python/mindspore/common/tensor.py
+++ b/mindspore/python/mindspore/common/tensor.py
@ -5570,7 +5570,7 @@ class Tensor(Tensor_):

        Raises:
            ValueError: If length of shape of `input_x` is not equal to length of shape of `mat2` or
-                        length of shape of `input_x` is less than `3`.
+                length of shape of `input_x` is less than `3`.

        Supported Platforms:
            ``Ascend`` ``GPU`` ``CPU``
--- a/mindspore/python/mindspore/ops/operations/array_ops.py
+++ b/mindspore/python/mindspore/ops/operations/array_ops.py
@ -2003,7 +2003,28 @@ class Argmax(PrimitiveWithInfer):
    """
    Returns the indices of the maximum value of a tensor across the axis.

-    Refer to :func:`mindspore.ops.argmax` for more detail.
+    If the shape of input tensor is :math:`(x_1, ..., x_N)`, the shape of the output tensor will be
+    :math:`(x_1, ..., x_{axis-1}, x_{axis+1}, ..., x_N)`.
+
+    Args:
+        axis (int): Axis where the Argmax operation applies to. Default: -1.
+        output_type (:class:`mindspore.dtype`): An optional data type of `mindspore.dtype.int32`.
+            Default: `mindspore.dtype.int32`.
+
+    Inputs:
+        - **input_x** (Tensor) - Input tensor. :math:`(N,*)` where :math:`*` means, any number of additional dimensions.
+          Support data type list as follows:
+
+          - Ascend: Float16, Float32.
+          - GPU: Float16, Float32.
+          - CPU: Float16, Float32, Float64.
+
+    Outputs:
+        Tensor, indices of the max value of input tensor across the axis.
+
+    Raises:
+        TypeError: If `axis` is not an int.
+        TypeError: If `output_type` is neither int32 nor int64.

    Supported Platforms:
        ``Ascend`` ``GPU`` ``CPU``