modify index of content for chinese python API.

docs/api/api_python/mindspore.nn.probability.rst

@@ -0,0 +1,43 @@
+mindspore.nn.probability
+============================
+
+.. py:class:: mindspore.nn.probability
+
+    用于构造概率网络的高级组件。
+
+Bijectors
+---------
+
+.. cnmsplatformautosummary::
+    :toctree: nn_probability
+
+    mindspore.nn.Metric
+    mindspore.nn.probability.bijector.Bijector
+    mindspore.nn.probability.bijector.Exp
+    mindspore.nn.probability.bijector.GumbelCDF
+    mindspore.nn.probability.bijector.Invert
+    mindspore.nn.probability.bijector.PowerTransform
+    mindspore.nn.probability.bijector.ScalarAffine
+    mindspore.nn.probability.bijector.Softplus
+
+Distributions
+-------------
+
+.. cnmsplatformautosummary::
+    :toctree: nn_probability
+    
+    mindspore.nn.probability.distribution.Bernoulli
+    mindspore.nn.probability.distribution.Beta
+    mindspore.nn.probability.distribution.Categorical
+    mindspore.nn.probability.distribution.Cauchy
+    mindspore.nn.probability.distribution.Distribution
+    mindspore.nn.probability.distribution.Exponential
+    mindspore.nn.probability.distribution.Gamma
+    mindspore.nn.probability.distribution.Geometric
+    mindspore.nn.probability.distribution.Gumbel
+    mindspore.nn.probability.distribution.LogNormal
+    mindspore.nn.probability.distribution.Logistic
+    mindspore.nn.probability.distribution.Normal
+    mindspore.nn.probability.distribution.Poisson
+    mindspore.nn.probability.distribution.TransformedDistribution
+    mindspore.nn.probability.distribution.Uniform

docs/api/api_python/mindspore.nn.rst

@@ -1,6 +1,24 @@
 mindspore.nn
 =============
 
+Cell
+----
+
+.. cnmsplatformautosummary::
+    :toctree: nn
+
+    mindspore.nn.Cell
+
+Dynamic Learning Rate
+---------------------
+
+.. cnmsplatformautosummary::
+    :toctree: nn
+
+    mindspore.nn.CosineDecayLR
+    mindspore.nn.ExponentialDecayLR
+    mindspore.nn.WarmUpLR
+
 Gradient
 ---------
 

docs/api/api_python/mindspore.rst

@@ -35,7 +35,11 @@ Serialization
     :toctree: mindspore
 
     mindspore.build_searched_strategy
+    mindspore.export
+    mindspore.load_checkpoint
+    mindspore.load_param_into_net
     mindspore.merge_sliced_parameter
+    mindspore.save_checkpoint
 
 JIT
 ---

docs/api/api_python/mindspore.train.rst

@@ -0,0 +1,20 @@
+mindspore.train
+===============
+
+.. include:: mindspore.train/mindspore.train.summary.rst
+
+.. include:: mindspore.train/mindspore.train.callback.Callback.rst
+
+.. include:: mindspore.train/mindspore.train.callback.LossMonitor.rst
+
+.. include:: mindspore.train/mindspore.train.callback.TimeMonitor.rst
+
+.. include:: mindspore.train/mindspore.train.callback.ModelCheckpoint.rst
+
+.. include:: mindspore.train/mindspore.train.SummaryCollector.rst
+
+.. include:: mindspore.train/mindspore.train.callback.CheckpointConfig.rst
+
+.. include:: mindspore.train/mindspore.train.callback.RunContext.rst
+
+.. include:: mindspore.train/mindspore.train.callback.LearningRateScheduler.rst

docs/api/api_python/mindspore/mindspore.export.rst

@@ -1,39 +1,39 @@
-mindspore.export
-=================
-
-.. py:class:: mindspore.export(net, *inputs, file_name, file_format="AIR", **kwargs)
-
-    将MindSpore网络模型导出为指定格式的文件。
-
-    .. note::
-        - 当导出文件格式为AIR、ONNX时，单个Tensor的大小不能超过2GB。
-        - 当file_name 没有后缀时，系统会根据file_format 自动添加后缀。
-
-    **参数：**
-
-    - **net** (Cell) – MindSpore网络结构。
-    - **inputs** (Tensor) – 网络的输入，如果网络有多个输入，需要将张量组成元组。
-    - **file_name** (str) – 导出模型的文件名称。
-    - **file_format** (str) – MindSpore目前支持导出"AIR"，"ONNX"和"MINDIR"格式的模型。
-
-      - **AIR** - Ascend Intermediate Representation。一种Ascend模型的中间表示格式。推荐的输出文件后缀是".air"。
-      - **ONNX** - Open Neural Network eXchange。一种针对机器学习所设计的开放式的文件格式。推荐的输出文件后缀是“.onnx”。
-      - **MINDIR** - MindSpore Native Intermediate Representation for Anf。一种MindSpore模型的中间表示格式。推荐的输出文件后缀是".mindir"。
-
-    - **kwargs** (dict) – 配置选项字典。
-
-      - **quant_mode** (str) - 如果网络是量化感知训练网络，那么quant_mode需要设置为"QUANT"，否则 `quant_mode` 需要设置为"NONQUANT"。
-      - **mean** (float) - 预处理后输入数据的平均值，用于量化网络的第一层。默认值：127.5。
-      - **std_dev** (float) - 预处理后输入数据的方差，用于量化网络的第一层。默认值：127.5。
-      - **enc_key** (str) - 用于加密的字节类型密钥，有效长度为16、24或者32。
-      - **enc_mode** (str) - 指定加密模式，当设置 `enc_key` 时，选项有："AES-GCM"，"AES-CBC"。默认值："AES-GCM"。
-      - **dataset** (Dataset) - 指定数据集的预处理方法，用于将数据集的预处理导入MindIR。
-
-    **样例：**
-
-    >>> import numpy as np
-    >>> from mindspore import export, Tensor
-    >>>
-    >>> net = LeNet()
-    >>> input = Tensor(np.ones([1, 1, 32, 32]).astype(np.float32))
-    >>> export(net, Tensor(input), file_name='lenet', file_format='MINDIR')
+mindspore.export
+=================
+
+.. py:class:: mindspore.export(net, *inputs, file_name, file_format="AIR", **kwargs)
+
+    将MindSpore网络模型导出为指定格式的文件。
+
+    .. note::
+        - 当导出文件格式为AIR、ONNX时，单个Tensor的大小不能超过2GB。
+        - 当file_name 没有后缀时，系统会根据file_format 自动添加后缀。
+
+    **参数：**
+
+    - **net** (Cell) – MindSpore网络结构。
+    - **inputs** (Tensor) – 网络的输入，如果网络有多个输入，需要将张量组成元组。
+    - **file_name** (str) – 导出模型的文件名称。
+    - **file_format** (str) – MindSpore目前支持导出"AIR"，"ONNX"和"MINDIR"格式的模型。
+
+      - **AIR** - Ascend Intermediate Representation。一种Ascend模型的中间表示格式。推荐的输出文件后缀是".air"。
+      - **ONNX** - Open Neural Network eXchange。一种针对机器学习所设计的开放式的文件格式。推荐的输出文件后缀是“.onnx”。
+      - **MINDIR** - MindSpore Native Intermediate Representation for Anf。一种MindSpore模型的中间表示格式。推荐的输出文件后缀是".mindir"。
+
+    - **kwargs** (dict) – 配置选项字典。
+
+      - **quant_mode** (str) - 如果网络是量化感知训练网络，那么quant_mode需要设置为"QUANT"，否则 `quant_mode` 需要设置为"NONQUANT"。
+      - **mean** (float) - 预处理后输入数据的平均值，用于量化网络的第一层。默认值：127.5。
+      - **std_dev** (float) - 预处理后输入数据的方差，用于量化网络的第一层。默认值：127.5。
+      - **enc_key** (str) - 用于加密的字节类型密钥，有效长度为16、24或者32。
+      - **enc_mode** (str) - 指定加密模式，当设置 `enc_key` 时，选项有："AES-GCM"，"AES-CBC"。默认值："AES-GCM"。
+      - **dataset** (Dataset) - 指定数据集的预处理方法，用于将数据集的预处理导入MindIR。
+
+    **样例：**
+
+    >>> import numpy as np
+    >>> from mindspore import export, Tensor
+    >>>
+    >>> net = LeNet()
+    >>> input = Tensor(np.ones([1, 1, 32, 32]).astype(np.float32))
+    >>> export(net, Tensor(input), file_name='lenet', file_format='MINDIR')

docs/api/api_python/mindspore/mindspore.load_checkpoint.rst

@@ -1,31 +1,31 @@
-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文件。
-
-    **参数：**
-
-    - **ckpt_file_name** (str) – checkpoint的文件名称。
-    - **net** (Cell) – 加载checkpoint参数的网络。默认值：None。
-    - **strict_load** (bool) – 是否将严格加载参数到网络中。如果是False, 它将根据相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行强制精度转换，比如将float32转换为float16。默认值：False。
-    - **filter_prefix** (Union[str, list[str], tuple[str]]) – 以 `filter_prefix` 开头的参数将不会被加载。默认值：None。
-    - **dec_key** (Union[None, bytes]) – 用于解密的字节类型密钥，如果值为None，则不需要解密。默认值：None。
-    - **dec_mode** (str) – 该参数仅当 `dec_key` 不为None时有效。指定解密模式，目前支持“AES-GCM”和“AES-CBC”。默认值：“AES-GCM”。
-
-    **返回：**
-
-    字典，key是参数名称，value是Parameter类型。
-
-    **异常：**
-
-    **ValueError** – checkpoint文件格式正确。
-
-    **样例：**
-
-    >>> 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)
+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文件。
+
+    **参数：**
+
+    - **ckpt_file_name** (str) – checkpoint的文件名称。
+    - **net** (Cell) – 加载checkpoint参数的网络。默认值：None。
+    - **strict_load** (bool) – 是否将严格加载参数到网络中。如果是False, 它将根据相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行强制精度转换，比如将float32转换为float16。默认值：False。
+    - **filter_prefix** (Union[str, list[str], tuple[str]]) – 以 `filter_prefix` 开头的参数将不会被加载。默认值：None。
+    - **dec_key** (Union[None, bytes]) – 用于解密的字节类型密钥，如果值为None，则不需要解密。默认值：None。
+    - **dec_mode** (str) – 该参数仅当 `dec_key` 不为None时有效。指定解密模式，目前支持“AES-GCM”和“AES-CBC”。默认值：“AES-GCM”。
+
+    **返回：**
+
+    字典，key是参数名称，value是Parameter类型。
+
+    **异常：**
+
+    **ValueError** – checkpoint文件格式正确。
+
+    **样例：**
+
+    >>> 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)

docs/api/api_python/mindspore/mindspore.load_param_into_net.rst

@@ -1,31 +1,31 @@
-mindspore.load_param_into_net
-=============================
-
-.. py:class:: mindspore.load_param_into_net(net, parameter_dict, strict_load=False)
-
-    将参数加载到网络中。
-
-    **参数：**
-
-    - **net** (Cell) – 将要加载参数的网络。
-    - **parameter_dict** (dict) – 加载checkpoint文件得到的字典。
-    - **strict_load** (bool) – 是否将参数严格加载到网络中。如果是False, 它将以相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。
-
-    **返回：**
-
-    List，网络中没有被加载的参数。
-
-    **异常：**
-
-    **TypeError** – 如果参数不是Cell或者 `parameter_dict` 不是Parameter类型的字典。
-
-    **样例：**
-
-    >>> 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']
+mindspore.load_param_into_net
+=============================
+
+.. py:class:: mindspore.load_param_into_net(net, parameter_dict, strict_load=False)
+
+    将参数加载到网络中。
+
+    **参数：**
+
+    - **net** (Cell) – 将要加载参数的网络。
+    - **parameter_dict** (dict) – 加载checkpoint文件得到的字典。
+    - **strict_load** (bool) – 是否将参数严格加载到网络中。如果是False, 它将以相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。
+
+    **返回：**
+
+    List，网络中没有被加载的参数。
+
+    **异常：**
+
+    **TypeError** – 如果参数不是Cell或者 `parameter_dict` 不是Parameter类型的字典。
+
+    **样例：**
+
+    >>> 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']

docs/api/api_python/mindspore/mindspore.save_checkpoint.rst

@@ -1,27 +1,27 @@
-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文件中。
-
-    **参数：**
-
-    - **save_obj** (Union[Cell, list]) – Cell对象或者数据列表（列表的每个元素为字典类型，比如[{"name": param_name, “data”: param_data},…]，`param_name` 的类型必须是str，`param_data` 的类型必须是Parameter或者Tensor）。
-    - **ckpt_file_name** (str) – checkpoint文件名称。如果文件已存在，将会覆盖原有文件。
-    - **integrated_save** (bool) – 在并行场景下是否合并保存拆分的Tensor。默认值：True。
-    - **async_save** (bool) – 是否异步执行保存checkpoint文件。默认值：False。
-    - **append_dict** (dict) – 需要保存的其他信息。dict的键必须为str类型，dict的值类型必须是float或者bool类型。默认值：None。
-    - **enc_key** (Union[None, bytes]) – 用于加密的字节类型密钥。如果值为None，那么不需要加密。默认值：None。
-    - **enc_mode** (str) – 该参数在 `enc_key` 不为None时有效，指定加密模式，目前仅支持"AES-GCM"和"AES-CBC"。 默认值：“AES-GCM”。
-
-    **异常：**
-
-    **TypeError** – 如果参数 `save_obj` 类型不为nn.Cell或者list，且如果参数 `integrated_save` 及 `async_save` 非bool类型。
-
-    **样例：**
-
-    >>> from mindspore import save_checkpoint
-    >>>
-    >>> net = Net()
+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文件中。
+
+    **参数：**
+
+    - **save_obj** (Union[Cell, list]) – Cell对象或者数据列表（列表的每个元素为字典类型，比如[{"name": param_name, “data”: param_data},…]，`param_name` 的类型必须是str，`param_data` 的类型必须是Parameter或者Tensor）。
+    - **ckpt_file_name** (str) – checkpoint文件名称。如果文件已存在，将会覆盖原有文件。
+    - **integrated_save** (bool) – 在并行场景下是否合并保存拆分的Tensor。默认值：True。
+    - **async_save** (bool) – 是否异步执行保存checkpoint文件。默认值：False。
+    - **append_dict** (dict) – 需要保存的其他信息。dict的键必须为str类型，dict的值类型必须是float或者bool类型。默认值：None。
+    - **enc_key** (Union[None, bytes]) – 用于加密的字节类型密钥。如果值为None，那么不需要加密。默认值：None。
+    - **enc_mode** (str) – 该参数在 `enc_key` 不为None时有效，指定加密模式，目前仅支持"AES-GCM"和"AES-CBC"。 默认值：“AES-GCM”。
+
+    **异常：**
+
+    **TypeError** – 如果参数 `save_obj` 类型不为nn.Cell或者list，且如果参数 `integrated_save` 及 `async_save` 非bool类型。
+
+    **样例：**
+
+    >>> from mindspore import save_checkpoint
+    >>>
+    >>> net = Net()
     >>> save_checkpoint(net, "lenet.ckpt")

docs/api/api_python/nn/probability/mindspore.nn.probability.rst

@@ -1,6 +0,0 @@
-mindspore.nn.probability
-============================
-
-.. py:class:: mindspore.nn.probability
-
-    用于构造概率网络的高级组件。