From 2c44c7b029d8a7234e920f4c53d32ada657ee35c Mon Sep 17 00:00:00 2001 From: yingchen Date: Sat, 9 Oct 2021 10:31:33 +0800 Subject: [PATCH] update api cn format --- .../mindspore/api/api_cn/mindspore.Tensor.rst | 22 +- .../api/api_cn/mindspore.get_py_obj_dtype.rst | 6 +- .../api/api_cn/mindspore.get_seed.rst | 6 +- .../api/api_cn/mindspore.issubclass_.rst | 14 +- .../api/api_cn/mindspore.load_checkpoint.rst | 41 ++-- .../api_cn/mindspore.load_param_into_net.rst | 38 ++-- docs/mindspore/api/api_cn/mindspore.model.rst | 16 +- .../api/api_cn/mindspore.nn.cell.rst | 10 +- .../api/api_cn/mindspore.nn.conv2d.rst | 2 +- .../api_cn/mindspore.nn.conv2dtranspose.rst | 2 +- .../mindspore/api/api_cn/mindspore.nn.elu.rst | 2 +- .../api/api_cn/mindspore.nn.embedding.rst | 2 +- .../api/api_cn/mindspore.nn.gelu.rst | 2 +- .../api/api_cn/mindspore.nn.leakyrelu.rst | 4 +- .../api_cn/mindspore.ops.GradOperation.rst | 2 +- .../api/api_cn/mindspore.ops.HyperMap.rst | 4 +- .../api/api_cn/mindspore.pytype_to_dtype.rst | 6 +- .../api/api_cn/mindspore.run_check.rst | 2 +- .../api/api_cn/mindspore.save_checkpoint.rst | 34 +-- .../api/api_cn/mindspore.set_seed.rst | 210 +++++++++--------- 20 files changed, 209 insertions(+), 216 deletions(-) diff --git a/docs/mindspore/api/api_cn/mindspore.Tensor.rst b/docs/mindspore/api/api_cn/mindspore.Tensor.rst index 2bb316858a9..f89b1f464d1 100644 --- a/docs/mindspore/api/api_cn/mindspore.Tensor.rst +++ b/docs/mindspore/api/api_cn/mindspore.Tensor.rst @@ -7,18 +7,18 @@ mindspore.Tensor MindSpore中的张量继承于C++中的张量对象。部分函数由C++编写，部分函数由Python编写。 - 参数： + **参数：** - - **input_data**(Union[Tensor, float, int, bool, tuple, list, numpy.ndarray]) – 输入的张量数据。 - - **dtype**(mindspore.dtype) – 张量的数据类型需为*mindSpore.dtype*中的None，bool或者数值型。这个参数是用于定义输出张量的数据类型。如果该参数为None，则输出张量的数据类型和*input_data*一致，默认参数：None。 - - **shape**(Union[tuple, list, int]) – 该参数为输出张量的形式，可由一列整数、一个元组、或一个整数表示。如果输入张量的形式已被定义，则无需设置该参数。 - - **init**(Initializer) – 'init'数据的相关信息。'init'被用于在并行模式中延迟初始化，通常来说，不推荐在其他条件下使用该接口初始化参数，只有当调用*Tensor.init_data* API用以转换张量数据时，才会使用'init'接口来初始化参数。 + - **input_data** (Union[Tensor, float, int, bool, tuple, list, numpy.ndarray]) – 输入的张量数据。 + - **dtype** (mindspore.dtype) – 张量的数据类型需为 *mindSpore.dtype* 中的None，bool或者数值型。这个参数是用于定义输出张量的数据类型。如果该参数为None，则输出张量的数据类型和 *input_data* 一致，默认参数：None。 + - **shape** (Union[tuple, list, int]) – 该参数为输出张量的形式，可由一列整数、一个元组、或一个整数表示。如果输入张量的形式已被定义，则无需设置该参数。 + - **init** (Initializer) – `init` 数据的相关信息。`init` 被用于在并行模式中延迟初始化，通常来说，不推荐在其他条件下使用该接口初始化参数，只有当调用 *Tensor.init_data* API用以转换张量数据时，才会使用 `init` 接口来初始化参数。 - 输出： + **输出：** - 张量。如果*dtype*和数据形式未被设置，将会返回与输入张量相同的*dtype*和形式；否则，输出张量的*dtype*和形式将是用户指定的设置。 + 张量。如果 *dtype* 和数据形式未被设置，将会返回与输入张量相同的 *dtype* 和形式；否则，输出张量的 *dtype* 和形式将是用户指定的设置。 - 样例： + **样例：** .. code-block:: @@ -51,15 +51,15 @@ mindspore.Tensor 按元素返回绝对值。 - 返回： + **返回：** 张量，值为按元素返回的绝对值。 - 支持平台： + **支持平台：** ``Ascend`` ``GPU`` ``CPU`` - 样例： + **样例：** .. code-block:: diff --git a/docs/mindspore/api/api_cn/mindspore.get_py_obj_dtype.rst b/docs/mindspore/api/api_cn/mindspore.get_py_obj_dtype.rst index 6b5c355f852..9bb862a6c75 100644 --- a/docs/mindspore/api/api_cn/mindspore.get_py_obj_dtype.rst +++ b/docs/mindspore/api/api_cn/mindspore.get_py_obj_dtype.rst @@ -5,10 +5,10 @@ mindspore.get_py_obj_dtype 将python数据类型转换为MindSpore数据类型。 - 参数： + **参数：** - **obj**(type) – python数据对象，或在python环境中定义的变量。 + **obj** (type) – Python数据对象，或在Python环境中定义的变量。 - 返回： + **返回：** MindSpore的数据类型。 \ No newline at end of file diff --git a/docs/mindspore/api/api_cn/mindspore.get_seed.rst b/docs/mindspore/api/api_cn/mindspore.get_seed.rst index d34cab56256..7bc7af07b06 100644 --- a/docs/mindspore/api/api_cn/mindspore.get_seed.rst +++ b/docs/mindspore/api/api_cn/mindspore.get_seed.rst @@ -3,8 +3,8 @@ mindspore.get_seed .. py:class:: mindspore.get_seed() - 获取随机种子。 + 获取随机种子。 - 返回： + **返回：** - 整型数。随机种子。 + 整型数。随机种子。 diff --git a/docs/mindspore/api/api_cn/mindspore.issubclass_.rst b/docs/mindspore/api/api_cn/mindspore.issubclass_.rst index 1e2584a942f..4895254223a 100644 --- a/docs/mindspore/api/api_cn/mindspore.issubclass_.rst +++ b/docs/mindspore/api/api_cn/mindspore.issubclass_.rst @@ -1,15 +1,15 @@ -mindspore.issubclass_ -====================== +mindspore.issubclass\_ +======================= .. py:method:: mindspore.issubclass_(type_, dtype) - 判断*type_*是否为*dtype*的子类。 + 判断 *type_* 是否为 *dtype* 的子类。 - 参数： + **参数：** - - **type_**(mindspore.dtype) – MindSpore中的目标dtype。 - - **dtype**(mindspore.dtype) – dtype的比较对象。 + - **type_** (mindspore.dtype) – MindSpore中的目标dtype。 + - **dtype** (mindspore.dtype) – dtype的比较对象。 - 返回： + **返回：** 布尔值，True或False。 \ No newline at end of file diff --git a/docs/mindspore/api/api_cn/mindspore.load_checkpoint.rst b/docs/mindspore/api/api_cn/mindspore.load_checkpoint.rst index f3a1f01dd0f..f6e555d1175 100644 --- a/docs/mindspore/api/api_cn/mindspore.load_checkpoint.rst +++ b/docs/mindspore/api/api_cn/mindspore.load_checkpoint.rst @@ -3,39 +3,36 @@ mindspore.load_checkpoint .. py:class:: mindspore.load_checkpoint(ckpt_file_name, net=None, strict_load=False, filter_prefix=None, dec_key=None, dec_mode="AES-GCM") - 加载指定checkpoint文件的数据。 + 加载指定checkpoint文件的数据。 - 参数： + **参数：** - - **ckpt_file_name**(str) – checkpoint的文件名称。 + - **ckpt_file_name** (str) – checkpoint的文件名称。 - - **net**(Cell) – MindSpore网络结构。默认值：None。 + - **net** (Cell) – MindSpore网络结构。默认值：None。 - - **strict_load**(bool) – 是否将参数严格加载到网络中。如果是False, 它将根据相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。 + - **strict_load** (bool) – 是否将参数严格加载到网络中。如果是False, 它将根据相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。 - - **filter_prefix**(Union[str, list[str], tuple[str]]) – 以filter_prefix开头的参数将不会被加载。默认值：None。 + - **filter_prefix** (Union[str, list[str], tuple[str]]) – 以filter_prefix开头的参数将不会被加载。默认值：None。 - - **dec_key**(Union[None, bytes]) – 用于解密的字节类型密钥，如果值为None，则不需要解密。默认值：None。 + - **dec_key** (Union[None, bytes]) – 用于解密的字节类型密钥，如果值为None，则不需要解密。默认值：None。 - - **dec_mode**(str) – 该参数仅当dec_key不为None时有效。指定解密模式，目前支持“AES-GCM”和“AES-CBC”。默认值：“AES-GCM”。 + - **dec_mode** (str) – 该参数仅当dec_key不为None时有效。指定解密模式，目前支持“AES-GCM”和“AES-CBC”。默认值：“AES-GCM”。 - 返回： + **返回：** - 字典，键是参数名称，值是Parameter类型的参数。 + 字典，key是参数名称，值是Parameter类型的参数。 - 抛出异常： + **异常：** - **ValueError** – checkpoint文件不正确。 - - 样例： - - .. code-block:: - - >>> from mindspore import load_checkpoint - >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" - >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") - >>> print(param_dict["conv2.weight"]) - Parameter (name=conv2.weight, shape=(16, 6, 5, 5), dtype=Float32, requires_grad=True) + **ValueError** – checkpoint文件不正确。 + **样例：** + .. code-block:: + >>> from mindspore import load_checkpoint + >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" + >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") + >>> print(param_dict["conv2.weight"]) + Parameter (name=conv2.weight, shape=(16, 6, 5, 5), dtype=Float32, requires_grad=True) diff --git a/docs/mindspore/api/api_cn/mindspore.load_param_into_net.rst b/docs/mindspore/api/api_cn/mindspore.load_param_into_net.rst index 846173aa808..d59e9aad91e 100644 --- a/docs/mindspore/api/api_cn/mindspore.load_param_into_net.rst +++ b/docs/mindspore/api/api_cn/mindspore.load_param_into_net.rst @@ -3,33 +3,33 @@ mindspore.load_param_into_net .. py:class:: mindspore.load_param_into_net(net, parameter_dict, strict_load=False) - 将参数加载到网络中。 + 将参数加载到网络中。 - 参数： + **参数：** - - **net**(Cell) – MindSpore网络结构。 + - **net** (Cell) – MindSpore网络结构。 - - **parameter_dict**(dict) – 加载由checkpoint文件生成的字典。 + - **parameter_dict** (dict) – 加载由checkpoint文件生成的字典。 - - **strict_load**(bool) – 是否将参数严格加载到网络中。如果是False, 它将以相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。 + - **strict_load** (bool) – 是否将参数严格加载到网络中。如果是False, 它将以相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。 - 返回： + **返回：** - 列表，未被加载到网络中的参数。 + 列表，未被加载到网络中的参数。 - 抛出异常： + **异常：** - TypeError – 如果参数不是Cell或者parameter_dict不是Parameter类型的字典。 + TypeError – 如果参数不是Cell或者parameter_dict不是Parameter类型的字典。 - 样例： + **样例：** - .. code-block:: + .. code-block:: - >>> from mindspore import load_checkpoint, load_param_into_net - >>> - >>> net = Net() - >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" - >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") - >>> param_not_load = load_param_into_net(net, param_dict) - >>> print(param_not_load) - ['conv1.weight'] + >>> from mindspore import load_checkpoint, load_param_into_net + >>> + >>> net = Net() + >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" + >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") + >>> param_not_load = load_param_into_net(net, param_dict) + >>> print(param_not_load) + ['conv1.weight'] diff --git a/docs/mindspore/api/api_cn/mindspore.model.rst b/docs/mindspore/api/api_cn/mindspore.model.rst index 2620f217f57..b505d959885 100644 --- a/docs/mindspore/api/api_cn/mindspore.model.rst +++ b/docs/mindspore/api/api_cn/mindspore.model.rst @@ -10,7 +10,7 @@ mindspore.Model - **network** (`Cell`) – 一个训练或测试的神经网络模型。 - **loss_fn** (`Cell`) - 损失函数，如果损失函数是None， `network` 需要包含损失函数逻辑以及梯度计算，如果有并行计算逻辑也需加入。默认值：None。 - **optimizer** (`Cell`) - 更新网络权重的优化器。默认值：None。 - - **metrics** (`Union[dict, set]`) - 在训练和测试时的模型评价指标。例如: {‘accuracy’, ‘recall’}。默认值：None。 + - **metrics** (`Union[dict, set]`) - 在训练和测试时的模型评价指标。例如: {`accuracy`, `recall`}。默认值：None。 - **eval_network** (`Cell`) - 指定用于评估的模型。如果没有定义， *network* 和 *loss_fn* 将会被封装成 *eval_network* 。默认值：None。 - **eval_indexes** (`list`) - 在定义 *eval_network* 时，如果 *eval_indexes* 为None， *eval_network* 的所有输出将传给 *metrics* 中，否则 *eval_indexes* 必须包含三个元素，为损失值、预测值和标签在输出中的位置。损失值将传给损失评价函数，而预测值和标签在输出中的位置传给其他评价函数。默认值：None。 - **amp_level** (`str`) - 在 *mindspore.amp.build_train_network* 中的可选参数 *level* ， *level* 为混合精度的等级，该参数支持 [“O0”, “O2”, “O3”, “auto”]。默认值：“O0”。 @@ -66,7 +66,7 @@ mindspore.Model .. warning:: 这是一个实验性的原型，可能会被改变和/或删除。 - .. note:: 预构建计算图目前仅支持*GRAPH_MODE*和*Ascend*，如果已经使用了该接口去构建计算图，那么‘model.train’会直接执行计算图。仅支持数据下沉模式。 + .. note:: 预构建计算图目前仅支持 *GRAPH_MODE* 和 *Ascend* ，如果已经使用了该接口去构建计算图，那么 `model.train` 会直接执行计算图。仅支持数据下沉模式。 **参数** ： @@ -138,13 +138,13 @@ mindspore.Model **参数** ： - - **predict_data** (`Tensor`) – 单个或多个张量的预测数据 + - **predict_data** (`Tensor`) – 单个或多个张量的预测数据。 **返回** ： Dict，用于加载分布式checkpoint的参数布局字典。 - **抛出异常** : + **异常** : - **RuntimeError** – 如果 *get_context* 不是图模式（GRAPH_MODE）。 @@ -278,10 +278,4 @@ mindspore.Model .. py:property:: train_network - 获得该模型的训练网络。 - - - - - - + 获得该模型的训练网络。 \ No newline at end of file diff --git a/docs/mindspore/api/api_cn/mindspore.nn.cell.rst b/docs/mindspore/api/api_cn/mindspore.nn.cell.rst index 67cbd53ee8d..6d93d7529f6 100644 --- a/docs/mindspore/api/api_cn/mindspore.nn.cell.rst +++ b/docs/mindspore/api/api_cn/mindspore.nn.cell.rst @@ -173,7 +173,7 @@ mindspore.nn.Cell 属于流水线并行当前stage的参数。 - **抛出异常**： + **异常**： **RuntimeError** – 如果有不属于任何阶段的参数存在。 @@ -202,7 +202,7 @@ mindspore.nn.Cell - **child_name** (`str`) – 子网络名称。 - **child_cell** (`Cell`) – 要插入的子网络。 - **抛出异常**： + **异常**： - **KeyError** – 如果子网络的名称不正确或与其他子网络名称重复。 - **TypeError** – 如果子网络Cell类型不正确。 @@ -219,7 +219,7 @@ mindspore.nn.Cell - **param** (`Parameter`) – 要插入到单元格的参数。 - **check_name** (`bool`) – 明确名称输入是否兼容。默认值：True。 - **抛出异常**： + **异常**： - **KeyError** – 如果参数名称为空或包含点。 - **TypeError** – 如果用户没有先调用init()。 @@ -339,7 +339,7 @@ mindspore.nn.Cell Cell类型，网络本身。 - **抛出异常**： + **异常**： **ValueError** – 如果 `acc_type` 不在算法库内。 @@ -443,7 +443,7 @@ mindspore.nn.Cell Cell类型，网络本身。 - **抛出异常**： + **异常**： **ValueError** – 如果 `dst_type` 不是float32，也不是float16。 diff --git a/docs/mindspore/api/api_cn/mindspore.nn.conv2d.rst b/docs/mindspore/api/api_cn/mindspore.nn.conv2d.rst index fc9581f407f..842bec305a1 100644 --- a/docs/mindspore/api/api_cn/mindspore.nn.conv2d.rst +++ b/docs/mindspore/api/api_cn/mindspore.nn.conv2d.rst @@ -47,7 +47,7 @@ mindspore.nn.Conv2d Shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 或者 :math:`(N, H_{out}, W_{out}, C_{out})` 的张量。 - **抛出异常** ： + **异常** ： - **TypeError** - 如果 `in_channels`，`out_channels` 或者 `group` 不是整数。 - **TypeError** - 如果 `kernel_size`，`stride`，`padding` 或者 `dilation` 既不是整数也不是元组。 diff --git a/docs/mindspore/api/api_cn/mindspore.nn.conv2dtranspose.rst b/docs/mindspore/api/api_cn/mindspore.nn.conv2dtranspose.rst index e0dce83b41a..c0894a0a803 100644 --- a/docs/mindspore/api/api_cn/mindspore.nn.conv2dtranspose.rst +++ b/docs/mindspore/api/api_cn/mindspore.nn.conv2dtranspose.rst @@ -43,7 +43,7 @@ mindspore.nn.Conv2dTranspose Shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 的张量。 - **抛出异常** ： + **异常** ： - **TypeError** - 如果 `in_channels`，`out_channels` 或者 `group` 不是整数。 - **TypeError** - 如果 `kernel_size`，`stride`，`padding` 或者 `dilation` 既不是整数也不是元组。 diff --git a/docs/mindspore/api/api_cn/mindspore.nn.elu.rst b/docs/mindspore/api/api_cn/mindspore.nn.elu.rst index 08efbb194ba..c6321d2dd13 100644 --- a/docs/mindspore/api/api_cn/mindspore.nn.elu.rst +++ b/docs/mindspore/api/api_cn/mindspore.nn.elu.rst @@ -29,7 +29,7 @@ mindspore.nn.ELU 张量，跟x保持相同的数据类型和形状。 - **抛出异常** ： + **异常** ： - TypeError – 如果 `alpha` 不是浮点数。 diff --git a/docs/mindspore/api/api_cn/mindspore.nn.embedding.rst b/docs/mindspore/api/api_cn/mindspore.nn.embedding.rst index 6d58e5114e0..5fb9b51e91b 100644 --- a/docs/mindspore/api/api_cn/mindspore.nn.embedding.rst +++ b/docs/mindspore/api/api_cn/mindspore.nn.embedding.rst @@ -26,7 +26,7 @@ mindspore.nn.Embedding 张量的形状 :math:`(\text{batch_size}, \text{x_length}, \text{embedding_size})` 。 - **抛出异常** ： + **异常** ： - TypeError – 如果 `vocab_size` 或者 `embedding_size` 不是整型值。 diff --git a/docs/mindspore/api/api_cn/mindspore.nn.gelu.rst b/docs/mindspore/api/api_cn/mindspore.nn.gelu.rst index da41dfcd590..a076d84a1bc 100644 --- a/docs/mindspore/api/api_cn/mindspore.nn.gelu.rst +++ b/docs/mindspore/api/api_cn/mindspore.nn.gelu.rst @@ -25,7 +25,7 @@ mindspore.nn.GELU 张量，跟x保持相同的数据类型和形状。 - **抛出异常** ： + **异常** ： - TypeError – 如果 `x` 的数据类型既不是float16也不是float32。 diff --git a/docs/mindspore/api/api_cn/mindspore.nn.leakyrelu.rst b/docs/mindspore/api/api_cn/mindspore.nn.leakyrelu.rst index f50d2ce42ad..f986d3b0312 100644 --- a/docs/mindspore/api/api_cn/mindspore.nn.leakyrelu.rst +++ b/docs/mindspore/api/api_cn/mindspore.nn.leakyrelu.rst @@ -20,13 +20,13 @@ mindspore.nn.LeakyReLU **输入** ： - - **x** （Tensor） - LeakyReLU的输入。形状是 `(N,*)` ，*表示任意数量的附加维度。 + - **x** （Tensor） - LeakyReLU的输入。形状是 `(N,*)` ，`*` 表示任意数量的附加维度。 **输出** ： 张量，跟x保持相同的数据类型和形状。 - **抛出异常** ： + **异常** ： - TypeError – 如果 `alpha` 不是浮点数或整型值。 diff --git a/docs/mindspore/api/api_cn/mindspore.ops.GradOperation.rst b/docs/mindspore/api/api_cn/mindspore.ops.GradOperation.rst index 072425aa898..f5c2849f107 100644 --- a/docs/mindspore/api/api_cn/mindspore.ops.GradOperation.rst +++ b/docs/mindspore/api/api_cn/mindspore.ops.GradOperation.rst @@ -63,7 +63,7 @@ mindspore.ops.GradOperation 将一个函数作为参数，并返回梯度函数的高阶函数。 - **抛出异常** ： + **异常** ： **TypeError** - 如果 *get_all* ，*get_by_list* 或者 *sens_params* 不是布尔值。 diff --git a/docs/mindspore/api/api_cn/mindspore.ops.HyperMap.rst b/docs/mindspore/api/api_cn/mindspore.ops.HyperMap.rst index c971c270a44..cc535664f3e 100644 --- a/docs/mindspore/api/api_cn/mindspore.ops.HyperMap.rst +++ b/docs/mindspore/api/api_cn/mindspore.ops.HyperMap.rst @@ -1,5 +1,5 @@ mindspore.ops.HyperMap -============================ +======================= .. py:class:: mindspore.ops.HyperMap(ops=None, reverse=False) @@ -21,7 +21,7 @@ mindspore.ops.HyperMap 序列或嵌套序列，执行函数如 `operation(args[0][i], args[1][i])` 之后输出的序列。 - **抛出异常** ： + **异常** ： **TypeError** - 如果 *ops* 不是 `MultitypeFuncGraph` 或 `None` 。 diff --git a/docs/mindspore/api/api_cn/mindspore.pytype_to_dtype.rst b/docs/mindspore/api/api_cn/mindspore.pytype_to_dtype.rst index 944683d0df1..a067d9d679b 100644 --- a/docs/mindspore/api/api_cn/mindspore.pytype_to_dtype.rst +++ b/docs/mindspore/api/api_cn/mindspore.pytype_to_dtype.rst @@ -5,10 +5,10 @@ mindspore.pytype_to_dtype 将Python数据类型转换为MindSpore数据类型。 - 参数： + **参数：** - **obj**(type) – python数据对象。 + **obj** (type) – python数据对象。 - 返回: + **返回:** MindSpore的数据类型。 \ No newline at end of file diff --git a/docs/mindspore/api/api_cn/mindspore.run_check.rst b/docs/mindspore/api/api_cn/mindspore.run_check.rst index ac30352234a..733a22fe916 100644 --- a/docs/mindspore/api/api_cn/mindspore.run_check.rst +++ b/docs/mindspore/api/api_cn/mindspore.run_check.rst @@ -5,7 +5,7 @@ mindspore.run_check 提供了便捷的API用以查询MindSpore的安装是否成功。 - 样例: + **样例:** .. code-block:: diff --git a/docs/mindspore/api/api_cn/mindspore.save_checkpoint.rst b/docs/mindspore/api/api_cn/mindspore.save_checkpoint.rst index c01f5ba478a..cab31b787f2 100644 --- a/docs/mindspore/api/api_cn/mindspore.save_checkpoint.rst +++ b/docs/mindspore/api/api_cn/mindspore.save_checkpoint.rst @@ -3,33 +3,33 @@ mindspore.save_checkpoint .. py:class:: mindspore.save_checkpoint(save_obj, ckpt_file_name, integrated_save=True, async_save=False, append_dict=None, enc_key=None, enc_mode="AES-GCM") - 将网络权重保存到指定的checkpoint文件中。 + 将网络权重保存到指定的checkpoint文件中。 - 参数： + **参数：** - - **save_obj**(Union[Cell, list]) – cell对象或者数据列表（列表的每个元素为字典类型，比如[{“name”: param_name, “data”: param_data},…]，*param_name*的类型必须是str，*param_data*的类型必须是Parameter或者Tensor）。 + - **save_obj** (Union[Cell, list]) – cell对象或者数据列表（列表的每个元素为字典类型，比如[{“name”: param_name, “data”: param_data},…]，*param_name* 的类型必须是str，*param_data* 的类型必须是Parameter或者Tensor）。 - - **ckpt_file_name**(str) – checkpoint文件名称。如果文件名称已存在，该文件将被覆盖。 + - **ckpt_file_name** (str) – checkpoint文件名称。如果文件名称已存在，该文件将被覆盖。 - - **integrated_save**(bool) – 在并行场景下是否合并保存拆分的Tensor。默认值：True。 + - **integrated_save** (bool) – 在并行场景下是否合并保存拆分的Tensor。默认值：True。 - - **async_save**(bool) – 异步执行是否将checkpoint保存到文件中。默认值：False。 + - **async_save** (bool) – 异步执行是否将checkpoint保存到文件中。默认值：False。 - - **append_dict**(dict) – 需要保存的其他信息。dict的键必须为str类型，dict的值类型必须是float或者bool类型。默认值：None。 + - **append_dict** (dict) – 需要保存的其他信息。dict的键必须为str类型，dict的值类型必须是float或者bool类型。默认值：None。 - - **enc_key**(Union[None, bytes]) – 用于加密的字节类型密钥。如果值为None，那么不需要加密。默认值：None。 + - **enc_key** (Union[None, bytes]) – 用于加密的字节类型密钥。如果值为None，那么不需要加密。默认值：None。 - - **enc_mode**(str) – 该参数在*enc_key*不为None时有效，指定加密模式，目前仅支持“AES-GCM”和“AES-CBC”。 默认值：“AES-GCM”。 + - **enc_mode** (str) – 该参数在 *enc_key* 不为None时有效，指定加密模式，目前仅支持“AES-GCM”和“AES-CBC”。 默认值：“AES-GCM”。 - 抛出异常： + **异常：** - **TypeError** – 如果参数*save_obj*类型不为nn.Cell或者list，且如果参数*integrated_save*及*async_save*非bool类型。 + **TypeError** – 如果参数 *save_obj* 类型不为nn.Cell或者list，且如果参数 *integrated_save* 及 *async_save* 非bool类型。 - 样例： + **样例：** - .. code-block:: + .. code-block:: - >>> from mindspore import save_checkpoint - >>> - >>> net = Net() - >>> save_checkpoint(net, "lenet.ckpt") \ No newline at end of file + >>> from mindspore import save_checkpoint + >>> + >>> net = Net() + >>> save_checkpoint(net, "lenet.ckpt") \ No newline at end of file diff --git a/docs/mindspore/api/api_cn/mindspore.set_seed.rst b/docs/mindspore/api/api_cn/mindspore.set_seed.rst index ed56f6fd759..8d5ea822348 100644 --- a/docs/mindspore/api/api_cn/mindspore.set_seed.rst +++ b/docs/mindspore/api/api_cn/mindspore.set_seed.rst @@ -3,107 +3,109 @@ mindspore.set_seed .. py:class:: mindspore.set_seed(seed) - 设置全局种子。 - - .. note:: - - 全局种子可用于numpy.random，mindspore.common.Initializer，mindspore.ops.composite.random_ops以及mindspore.nn.probability.distribution。 - 如果没有设置全局种子，这些包将会各自使用自己的种子，numpy.random和mindspore.common.Initializer将会随机选择种子值，mindspore.ops.composite.random_ops和mindspore.nn.probability.distribution将会使用零作为种子值。 - numpy.random.seed()设置的种子仅能被numpy.random使用，而这个API设置的种子也可被numpy.random使用，因此推荐使用这个API设置所有的种子。 - - 参数： - - **seed**(int) – 设置的全局种子。 - - 抛出异常: - - - **ValueError** – 种子值非法 (小于0)。 - - - **TypeError** – 种子值非整型数。 - - - 样例: - - .. code-block:: - - >>> import numpy as np - >>> import mindspore.ops as ops - >>> from mindspore import Tensor, set_seed, Parameter - >>> from mindspore.common.initializer import initializer - - >>> # 注意：（1）请确保代码在PYNATIVE模式下运行； - >>> # （2）由于复合级别的算子需要参数为张量类型，如以下示例， - >>> # 当使用ops.uniform这个算子，minval和maxval用以下方法初始化: - >>> minval = Tensor(1.0, ms.float32) - >>> maxval = Tensor(2.0, ms.float32) - - >>> # 1.如果没有设置全局种子，numpy.random以及initializer将会选择随机种子： - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A2 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W1 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W2 - >>> # 重新运行程序将得到不同的结果： - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A3 - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A4 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W3 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W4 - - >>> # 2. 如果设置了全局种子，numpy.random以及initializer将会使用这个种子： - >>> set_seed(1234) - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A2 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W1 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W2 - >>> # 重新运行程序将得到相同的结果： - >>> set_seed(1234) - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A2 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W1 - >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W2 - - >>> # 3. 如果全局种子或者算子种子均未设置，mindspore.ops.composite.random_ops以及 - >>> # mindspore.nn.probability.distribution将会选择一个随机种子： - >>> c1 = ops.uniform((1, 4), minval, maxval) # C1 - >>> c2 = ops.uniform((1, 4), minval, maxval) # C2 - >>> # 重新运行程序将得到不同的结果： - >>> c1 = ops.uniform((1, 4), minval, maxval) # C3 - >>> c2 = ops.uniform((1, 4), minval, maxval) # C4 - - >>> # 4. 如果设置了全局种子，但未设置算子种子，mindspore.ops.composite.random_ops以及 - >>> # mindspore.nn.probability.distribution将会根据全局种子及默认算子种子计算出一个种子。 - >>> # 每次调用默认算子种子都会改变，因此每次调用会得到不同的结果。 - >>> set_seed(1234) - >>> c1 = ops.uniform((1, 4), minval, maxval) # C1 - >>> c2 = ops.uniform((1, 4), minval, maxval) # C2 - >>> # 重新运行程序将得到相同的结果： - >>> set_seed(1234) - >>> c1 = ops.uniform((1, 4), minval, maxval) # C1 - >>> c2 = ops.uniform((1, 4), minval, maxval) # C2 - - >>> # 5. 如果设置了全局种子以及算子种子，mindspore.ops.composite.random_ops以及 - >>> # mindspore.nn.probability.distribution将根据全局种子及算子种子计数器计算出一个种子。 - >>> # 每次调用将会更改算子种子计数器, 因此每次调用会得到不同的结果。 - >>> set_seed(1234) - >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 - >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 - >>> # 重新运行程序将得到相同的结果： - >>> set_seed(1234) - >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 - >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 - - >>> # 6. 如果算子种子设置了但是全局种子没有设置，0将作为全局种子，那么 - >>> # mindspore.ops.composite.random_ops以及mindspore.nn.probability.distribution运行方式同5。 - >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 - >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 - >>> # 重新运行程序将得到相同的结果： - >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 - >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 - - >>> # 7. 在程序中重新调用set_seed()将会重置mindspore.ops.composite.random_ops - >>> # 和mindspore.nn.probability.distribution的numpy种子以及算子种子计数器。 - >>> set_seed(1234) - >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 - >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 - >>> set_seed(1234) - >>> np_2 = np.random.normal(0, 1, [1]).astype(np.float32) # still get A1 - >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # still get C1 + 设置全局种子。 + + .. note:: + + 全局种子可用于numpy.random，mindspore.common.Initializer，mindspore.ops.composite.random_ops以及mindspore.nn.probability.distribution。 + + 如果没有设置全局种子，这些包将会各自使用自己的种子，numpy.random和mindspore.common.Initializer将会随机选择种子值，mindspore.ops.composite.random_ops和mindspore.nn.probability.distribution将会使用零作为种子值。 + + numpy.random.seed()设置的种子仅能被numpy.random使用，而这个API设置的种子也可被numpy.random使用，因此推荐使用这个API设置所有的种子。 + + **参数：** + + **seed** (int) – 设置的全局种子。 + + **异常:** + + - **ValueError** – 种子值非法 (小于0)。 + + - **TypeError** – 种子值非整型数。 + + + **样例:** + + .. code-block:: + + >>> import numpy as np + >>> import mindspore.ops as ops + >>> from mindspore import Tensor, set_seed, Parameter + >>> from mindspore.common.initializer import initializer + + >>> # 注意：（1）请确保代码在PYNATIVE模式下运行； + >>> # （2）由于复合级别的算子需要参数为张量类型，如以下示例， + >>> # 当使用ops.uniform这个算子，minval和maxval用以下方法初始化: + >>> minval = Tensor(1.0, ms.float32) + >>> maxval = Tensor(2.0, ms.float32) + + >>> # 1.如果没有设置全局种子，numpy.random以及initializer将会选择随机种子： + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A2 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W1 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W2 + >>> # 重新运行程序将得到不同的结果： + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A3 + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A4 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W3 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W4 + + >>> # 2. 如果设置了全局种子，numpy.random以及initializer将会使用这个种子： + >>> set_seed(1234) + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A2 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W1 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W2 + >>> # 重新运行程序将得到相同的结果： + >>> set_seed(1234) + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A2 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W1 + >>> w1 = Parameter(initializer("uniform", [2, 2], ms.float32), name="w1") # W2 + + >>> # 3. 如果全局种子或者算子种子均未设置，mindspore.ops.composite.random_ops以及 + >>> # mindspore.nn.probability.distribution将会选择一个随机种子： + >>> c1 = ops.uniform((1, 4), minval, maxval) # C1 + >>> c2 = ops.uniform((1, 4), minval, maxval) # C2 + >>> # 重新运行程序将得到不同的结果： + >>> c1 = ops.uniform((1, 4), minval, maxval) # C3 + >>> c2 = ops.uniform((1, 4), minval, maxval) # C4 + + >>> # 4. 如果设置了全局种子，但未设置算子种子，mindspore.ops.composite.random_ops以及 + >>> # mindspore.nn.probability.distribution将会根据全局种子及默认算子种子计算出一个种子。 + >>> # 每次调用默认算子种子都会改变，因此每次调用会得到不同的结果。 + >>> set_seed(1234) + >>> c1 = ops.uniform((1, 4), minval, maxval) # C1 + >>> c2 = ops.uniform((1, 4), minval, maxval) # C2 + >>> # 重新运行程序将得到相同的结果： + >>> set_seed(1234) + >>> c1 = ops.uniform((1, 4), minval, maxval) # C1 + >>> c2 = ops.uniform((1, 4), minval, maxval) # C2 + + >>> # 5. 如果设置了全局种子以及算子种子，mindspore.ops.composite.random_ops以及 + >>> # mindspore.nn.probability.distribution将根据全局种子及算子种子计数器计算出一个种子。 + >>> # 每次调用将会更改算子种子计数器, 因此每次调用会得到不同的结果。 + >>> set_seed(1234) + >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 + >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 + >>> # 重新运行程序将得到相同的结果： + >>> set_seed(1234) + >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 + >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 + + >>> # 6. 如果算子种子设置了但是全局种子没有设置，0将作为全局种子，那么 + >>> # mindspore.ops.composite.random_ops以及mindspore.nn.probability.distribution运行方式同5。 + >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 + >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 + >>> # 重新运行程序将得到相同的结果： + >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 + >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # C2 + + >>> # 7. 在程序中重新调用set_seed()将会重置mindspore.ops.composite.random_ops + >>> # 和mindspore.nn.probability.distribution的numpy种子以及算子种子计数器。 + >>> set_seed(1234) + >>> np_1 = np.random.normal(0, 1, [1]).astype(np.float32) # A1 + >>> c1 = ops.uniform((1, 4), minval, maxval, seed=2) # C1 + >>> set_seed(1234) + >>> np_2 = np.random.normal(0, 1, [1]).astype(np.float32) # still get A1 + >>> c2 = ops.uniform((1, 4), minval, maxval, seed=2) # still get C1 -- Gitee