From 1ebb69de3fb694f612f72c0996ba51bfd2e8a644 Mon Sep 17 00:00:00 2001 From: xumengjuan1 Date: Mon, 7 Mar 2022 15:19:02 +0800 Subject: [PATCH] modify apiformat --- docs/api/api_python/ops/mindspore.ops.ArgMinWithValue.rst | 1 + docs/api/api_python/ops/mindspore.ops.NotEqual.rst | 1 + docs/api/api_python/ops/mindspore.ops.Primitive.rst | 2 +- mindspore/python/mindspore/ops/primitive.py | 1 + 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/api/api_python/ops/mindspore.ops.ArgMinWithValue.rst b/docs/api/api_python/ops/mindspore.ops.ArgMinWithValue.rst index 1768dd9fcf..ae68e156a2 100644 --- a/docs/api/api_python/ops/mindspore.ops.ArgMinWithValue.rst +++ b/docs/api/api_python/ops/mindspore.ops.ArgMinWithValue.rst @@ -26,6 +26,7 @@ **输出：** tuple(Tensor)，表示2个Tensor组成的tuple，包含对应的索引和输入Tensor的最小值。 + - **index** (Tensor) - 输入Tensor最小值的索引。如果 `keep_dims` 为True，则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则，shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。 - **output_x** (Tensor) - 输入Tensor的最小值，其shape与索引相同。 diff --git a/docs/api/api_python/ops/mindspore.ops.NotEqual.rst b/docs/api/api_python/ops/mindspore.ops.NotEqual.rst index ddde473b8a..f999e414eb 100644 --- a/docs/api/api_python/ops/mindspore.ops.NotEqual.rst +++ b/docs/api/api_python/ops/mindspore.ops.NotEqual.rst @@ -28,5 +28,6 @@ mindspore.ops.NotEqual Tensor，输出shape与输入相同，数据类型为bool。 **异常：** + - **TypeError** - `x` 和 `y` 不是以下之一：Tensor、Number、bool。 - **TypeError** - `x` 和 `y` 都不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Primitive.rst b/docs/api/api_python/ops/mindspore.ops.Primitive.rst index 738dad1fa7..a39b8f8453 100644 --- a/docs/api/api_python/ops/mindspore.ops.Primitive.rst +++ b/docs/api/api_python/ops/mindspore.ops.Primitive.rst @@ -83,7 +83,7 @@ mindspore.ops.Primitive - **stage** (int) - 当前stage的ID。 - .. py:method:: shard(in_strategy, out_strategy) + .. py:method:: shard(in_strategy=None, out_strategy=None) 将切分策略添加到Primitive属性中。 diff --git a/mindspore/python/mindspore/ops/primitive.py b/mindspore/python/mindspore/ops/primitive.py index 90ccd824aa..7af70e401e 100644 --- a/mindspore/python/mindspore/ops/primitive.py +++ b/mindspore/python/mindspore/ops/primitive.py @@ -168,6 +168,7 @@ class Primitive(Primitive_): in_strategy (tuple): Describe the split strategy of operator input. Default: None. out_strategy (tuple): Describe the split strategy of operator output, it is only for certain operators, such as MatMul. Default: None. + Examples: >>> from mindspore import ops >>> add = ops.Add()