diff --git a/docs/api/api_python/mindspore.parallel.rst b/docs/api/api_python/mindspore.parallel.rst index 9633721fd21..a7562fe3819 100644 --- a/docs/api/api_python/mindspore.parallel.rst +++ b/docs/api/api_python/mindspore.parallel.rst @@ -3,7 +3,7 @@ 并行相关功能的接口。 -.. py:function:: set_algo_parameters(**kwargs) +.. py:function:: mindspore.parallel.set_algo_parameters(**kwargs) 设置并行策略搜索算法中的参数。有关典型用法，请参见mindspore/tests/ut/python/parallel/test_auto_parallel_resnet.py。 @@ -24,7 +24,7 @@ - **ValueError** - 无法识别传入的关键字。 -.. py:function:: reset_algo_parameters() +.. py:function:: mindspore.parallel.reset_algo_parameters() 重置算法参数属性。 @@ -41,7 +41,7 @@ - tensor_slice_align_size：16 -.. py:function:: get_algo_parameters(attr_key) +.. py:function:: mindspore.parallel.get_algo_parameters(attr_key) 获取算法参数配置属性。 diff --git a/docs/api/api_python/mindspore/mindspore.ms_function.rst b/docs/api/api_python/mindspore/mindspore.ms_function.rst index d0fcde0d4a2..7db1a3e2d07 100644 --- a/docs/api/api_python/mindspore/mindspore.ms_function.rst +++ b/docs/api/api_python/mindspore/mindspore.ms_function.rst @@ -21,6 +21,3 @@ mindspore.ms_function 函数，如果 `fn` 不是None，则返回一个已经将输入 `fn` 编译成图的可执行函数；如果 `fn` 为None，则返回一个装饰器。当这个装饰器使用单个 `fn` 参数进行调用时，等价于 `fn` 不是None的场景。 - **异常：** - - - **TypeError** – 如果指定了 `input_signature`，但是实际输入的shape和dtype与 `input_signature` 的不相同。 diff --git a/docs/api/api_python/mindspore/mindspore.pytype_to_dtype.rst b/docs/api/api_python/mindspore/mindspore.pytype_to_dtype.rst index ea0933edc85..d5b43d585b2 100644 --- a/docs/api/api_python/mindspore/mindspore.pytype_to_dtype.rst +++ b/docs/api/api_python/mindspore/mindspore.pytype_to_dtype.rst @@ -9,6 +9,6 @@ mindspore.pytype_to_dtype - **obj** (type) – Python数据对象。 - **返回:** + **返回：** MindSpore的数据类型。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/mindspore.set_seed.rst b/docs/api/api_python/mindspore/mindspore.set_seed.rst index 8909056970b..a13bad7db30 100644 --- a/docs/api/api_python/mindspore/mindspore.set_seed.rst +++ b/docs/api/api_python/mindspore/mindspore.set_seed.rst @@ -14,7 +14,7 @@ mindspore.set_seed - **seed** (int) – 设置的全局种子。 - **异常:** + **异常：** - **ValueError** – 种子值非法 (小于0)。 - **TypeError** – 种子值非整型数。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_index_add.rst b/docs/api/api_python/ops/mindspore.ops.func_index_add.rst index 1264f5bea83..c9085e458e6 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_index_add.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_index_add.rst @@ -9,20 +9,20 @@ mindspore.ops.index_add **参数：** - **x** (Parameter) - 被加Parameter。 - - **indices** (Tensor) - 指定Tensor y加到`x`的指定axis轴的指定indices位置。 - - **y** (Tensor) - 与`x`相加的Tensor。 - - **axis** (int) - 指定Tensor y加到`x`的指定axis轴。 + - **indices** (Tensor) - 指定Tensor y加到 `x` 的指定axis轴的指定indices位置。 + - **y** (Tensor) - 与 `x` 加的Tensor。 + - **axis** (int) - 指定Tensor y加到 `x` 的指定axis轴。 - **use_lock** (bool) - 计算时使用锁。默认值：True。 - **check_index_bound** (bool) - indices边界检查。默认值：True。 **返回：** - 相加后的Tensor。shape和数据类型与输入 `x`相同。 + 相加后的Tensor。shape和数据类型与输入 `x` 相同。 **异常：** - - **TypeError** - `indices`或者`y`的类型不是Tensor。 - - **ValueError** - `axis`的值超出`x` shape的维度范围。 - - **ValueError** - `x` shape的维度和`y` shape的维度不一致。 - - **ValueError** - `indices` shape的维度不是一维或者`indices` shape的大小与`y` shape在`axis`轴上的大小不一致。 - - **ValueError** - 除`axis`轴外，`x` shape和`y` shape的大小不一致。 + - **TypeError** - `indices` 或者 `y` 的类型不是Tensor。 + - **ValueError** - `axis` 的值超出 `x` shape的维度范围。 + - **ValueError** - `x` shape的维度和 `y` shape的维度不一致。 + - **ValueError** - `indices` shape的维度不是一维或者 `indices` shape的大小与 `y` shape在 `axis` 轴上的大小不一致。 + - **ValueError** - 除 `axis` 轴外，`x` shape和 `y` shape的大小不一致。 diff --git a/docs/api/api_python/train/mindspore.train.summary.SummaryRecord.rst b/docs/api/api_python/train/mindspore.train.summary.SummaryRecord.rst index 13c9f1f1d31..6e544d4eba4 100644 --- a/docs/api/api_python/train/mindspore.train.summary.SummaryRecord.rst +++ b/docs/api/api_python/train/mindspore.train.summary.SummaryRecord.rst @@ -52,7 +52,7 @@ - LANDSCAPE: 代表添加的数据为地形图。 - **name** (str) - 数据名称。 - - **value** (Union[Tensor, GraphProto, TrainLineage, EvaluationLineage, DatasetGraph, UserDefinedInfo，LossLandscape])：待存储的值。 + - **value** (Union[Tensor, GraphProto, TrainLineage, EvaluationLineage, DatasetGraph, UserDefinedInfo，LossLandscape]) - 待存储的值。 - 当plugin为"graph"时，参数值的数据类型应为"GraphProto"对象。具体详情，请参见 `mindspore/ccsrc/anf_ir.proto `_ 。 - 当plugin为"scalar"、"image"、"tensor"或"histogram"时，参数值的数据类型应为"Tensor"对象。