mindspore-Ecosystem
/
mindspore
21
0
Fork 27
Code Issues Pull Requests 6 Projects Releases Wiki Activity

modify directives and titles for chinese python api.

This commit is contained in:
zhangyi 2022-02-15 16:22:46 +08:00
parent 019c27b60d
commit 286d263522
13 changed files with 104 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/api_python/mindspore.communication.rst
View File

@ -16,7 +16,7 @@ mindspore.communication
- BACKEND：使用的通信库，HCCL或者NCCL。
- WORLD_COMM_GROUP：全局通信域。
.. py:method:: mindspore.communication.init(backend_name=None)
.. py:function:: mindspore.communication.init(backend_name=None)
初始化通信服务需要的分布式后端，例如‘HCCL’或‘NCCL’服务。

4
docs/api/api_python/mindspore.dataset.audio.rst
View File

@ -6,7 +6,7 @@ mindspore.dataset.audio
mindspore.dataset.audio.transforms
----------------------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset_audio
mindspore.dataset.audio.transforms.AllpassBiquad
@ -26,7 +26,7 @@ mindspore.dataset.audio.transforms
mindspore.dataset.audio.utils
-----------------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset_audio
mindspore.dataset.audio.utils.ScaleType

16
docs/api/api_python/mindspore.dataset.rst
View File

@ -27,7 +27,7 @@ mindspore.dataset
视觉
-----
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
@ -64,7 +64,7 @@ mindspore.dataset
文本
----
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
@ -90,7 +90,7 @@ mindspore.dataset
音频
------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
@ -103,7 +103,7 @@ mindspore.dataset
标准格式
--------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
@ -115,7 +115,7 @@ mindspore.dataset
用户自定义
----------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
@ -128,7 +128,7 @@ mindspore.dataset
图
---
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
mindspore.dataset.GraphData
@ -137,7 +137,7 @@ mindspore.dataset
采样器
-------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
mindspore.dataset.DistributedSampler
@ -152,7 +152,7 @@ mindspore.dataset
其他
-----
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst

4
docs/api/api_python/mindspore.dataset.text.rst
View File

@ -6,7 +6,7 @@ mindspore.dataset.text
mindspore.dataset.text.transforms
---------------------------------
.. cnmsnoteautosummary::
.. msnoteautosummary::
:toctree: dataset_text
:nosignatures:
:template: classtemplate.rst
@ -34,7 +34,7 @@ mindspore.dataset.text.transforms
mindspore.dataset.text.utils
----------------------------
.. cnmsnoteautosummary::
.. msnoteautosummary::
:toctree: dataset_text
:nosignatures:
:template: classtemplate.rst

4
docs/api/api_python/mindspore.dataset.transforms.rst
View File

@ -6,7 +6,7 @@ mindspore.dataset.transforms
mindspore.dataset.transforms.c_transforms
-----------------------------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset_transforms
:nosignatures:
:template: classtemplate.rst
@ -28,7 +28,7 @@ mindspore.dataset.transforms.c_transforms
mindspore.dataset.transforms.py_transforms
------------------------------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset_transforms
:nosignatures:
:template: classtemplate.rst

6
docs/api/api_python/mindspore.dataset.vision.rst
View File

@ -6,7 +6,7 @@ mindspore.dataset.vision
mindspore.dataset.vision.c_transforms
------------------------------------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset_vision
:nosignatures:
:template: classtemplate.rst
@ -60,7 +60,7 @@ mindspore.dataset.vision.c_transforms
mindspore.dataset.vision.py_transforms
-------------------------------------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset_vision
:nosignatures:
:template: classtemplate.rst
@ -103,7 +103,7 @@ mindspore.dataset.vision.py_transforms
mindspore.dataset.vision.utils
-------------------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: dataset_vision
:nosignatures:
:template: classtemplate.rst

4
docs/api/api_python/mindspore.nn.probability.rst
View File

@ -8,7 +8,7 @@ mindspore.nn.probability
Bijectors
---------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn_probability
mindspore.nn.probability.bijector.Bijector
@ -22,7 +22,7 @@ Bijectors
Distributions
-------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn_probability
mindspore.nn.probability.distribution.Bernoulli

52
docs/api/api_python/mindspore.nn.rst
View File

@ -10,7 +10,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
基本构成单元
------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -21,7 +21,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
容器
-----------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
mindspore.nn.CellList
@ -30,7 +30,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
卷积层
--------------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
mindspore.nn.Conv1d
@ -43,7 +43,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
梯度
-----
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
mindspore.nn.Jvp
@ -52,7 +52,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
循环层
--------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -67,7 +67,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
稀疏层
-------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -81,7 +81,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
非线性激活函数
--------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -108,7 +108,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
工具
-----
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -128,10 +128,10 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
mindspore.nn.Triu
mindspore.nn.Unfold
图像函数
--------
图像
-----
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -145,7 +145,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
归一化层
---------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -165,7 +165,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
池化层
--------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -176,10 +176,10 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
mindspore.nn.MaxPool2d
量化函数
-------------------
量化
-----
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -199,7 +199,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
损失函数
--------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -222,7 +222,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
优化器
-------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -244,10 +244,10 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
mindspore.nn.SGD
mindspore.nn.thor
封装函数
Wrapper
---------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -267,10 +267,10 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
mindspore.nn.WithGradCell
mindspore.nn.WithLossCell
数学函数
--------
数学运算
----------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -282,7 +282,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比，新增、删除和支
评估指标
--------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
@ -335,7 +335,7 @@ LearningRateSchedule类
net = Net()
optim = nn.Momentum(net.trainable_params(), learning_rate=cosine_decay_lr, momentum=0.9)
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: nn
mindspore.nn.CosineDecayLR
@ -365,7 +365,7 @@ Dynamic LR函数
net = Net()
optim = nn.Momentum(net.trainable_params(), learning_rate=lr, momentum=0.9)
.. cnmsautosummary::
.. mscnautosummary::
:toctree: nn
mindspore.nn.cosine_decay_lr

8
docs/api/api_python/mindspore.numpy.rst
View File

@ -6,7 +6,7 @@ mindspore.numpy
Array Generation
----------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst
@ -57,7 +57,7 @@ Array Generation
Array Operation
---------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst
@ -110,7 +110,7 @@ Array Operation
Logic
-----
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst
@ -142,7 +142,7 @@ Logic
Math
----
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst

65
docs/api/api_python/mindspore.ops.rst
View File

@ -3,40 +3,8 @@ mindspore.ops
.. include:: operations.rst
组合算子
---------
组合算子是预定义的算子组合。
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.batch_dot
mindspore.ops.clip_by_global_norm
mindspore.ops.clip_by_value
mindspore.ops.core
mindspore.ops.count_nonzero
mindspore.ops.cummin
mindspore.ops.dot
mindspore.ops.gamma
mindspore.ops.GradOperation
mindspore.ops.HyperMap
mindspore.ops.laplace
mindspore.ops.Map
mindspore.ops.matmul
mindspore.ops.multinomial
mindspore.ops.MultitypeFuncGraph
mindspore.ops.normal
mindspore.ops.poisson
mindspore.ops.repeat_elements
mindspore.ops.sequence_mask
mindspore.ops.tensor_dot
mindspore.ops.uniform
functional算子
---------------
functional
-----------
functional算子是经过初始化后的Primitive，可以直接作为函数使用。functional算子的使用示例如下：
@ -353,21 +321,42 @@ functional算子是经过初始化后的Primitive，可以直接作为函数使
* - mindspore.ops.zeros_like
- Refer to :class:`mindspore.ops.ZerosLike`.
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.batch_dot
mindspore.ops.clip_by_global_norm
mindspore.ops.clip_by_value
mindspore.ops.core
mindspore.ops.count_nonzero
mindspore.ops.cummin
mindspore.ops.dot
mindspore.ops.gamma
mindspore.ops.grad
mindspore.ops.GradOperation
mindspore.ops.HyperMap
mindspore.ops.jvp
mindspore.ops.laplace
mindspore.ops.Map
mindspore.ops.matmul
mindspore.ops.multinomial
mindspore.ops.MultitypeFuncGraph
mindspore.ops.narrow
mindspore.ops.normal
mindspore.ops.poisson
mindspore.ops.repeat_elements
mindspore.ops.select
mindspore.ops.sequence_mask
mindspore.ops.tensor_dot
mindspore.ops.uniform
mindspore.ops.vjp
原语
-----
.. autosummary::
.. mscnautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -381,7 +370,7 @@ functional算子是经过初始化后的Primitive，可以直接作为函数使
函数实现注册
----------------
.. autosummary::
.. mscnautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -391,7 +380,7 @@ functional算子是经过初始化后的Primitive，可以直接作为函数使
算子信息注册
----------------
.. autosummary::
.. mscnautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst

28
docs/api/api_python/mindspore.rst
View File

@ -4,7 +4,7 @@ mindspore
张量
------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.Tensor
@ -14,7 +14,7 @@ mindspore
参数
---------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.Parameter
@ -23,7 +23,7 @@ mindspore
数据类型
--------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.dtype
@ -36,7 +36,7 @@ mindspore
种子
----
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.set_seed
@ -45,7 +45,7 @@ mindspore
模型
-----
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.Model
@ -53,7 +53,7 @@ mindspore
MindData数据集处理
-------------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.DatasetHelper
@ -62,7 +62,7 @@ MindData数据集处理
损失函数管理
------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.LossScaleManager
@ -72,7 +72,7 @@ MindData数据集处理
序列化
-------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.save_checkpoint
@ -89,7 +89,7 @@ MindData数据集处理
即时编译
--------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.ms_function
@ -97,7 +97,7 @@ MindData数据集处理
日志
----
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.get_level
@ -106,7 +106,7 @@ MindData数据集处理
自动混合精度
------------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.build_train_network
@ -114,7 +114,7 @@ MindData数据集处理
安装验证
--------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
mindspore.run_check
@ -122,7 +122,7 @@ MindData数据集处理
调试
------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
:nosignatures:
:template: classtemplate.rst
@ -132,7 +132,7 @@ MindData数据集处理
内存回收
----------
.. cnmsautosummary::
.. mscnautosummary::
:toctree: mindspore
:nosignatures:
:template: classtemplate.rst

6
docs/api/api_python/mindspore.scipy.rst
View File

@ -6,7 +6,7 @@ mindspore.scipy
mindspore.scipy.linalg
----------------------
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: scipy
:nosignatures:
:template: classtemplate_inherited.rst
@ -22,7 +22,7 @@ mindspore.scipy.optimize
.. automodule:: mindspore.scipy.optimize
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: scipy
:nosignatures:
:template: classtemplate_inherited.rst
@ -35,7 +35,7 @@ mindspore.scipy.sparse.linalg
.. automodule:: mindspore.scipy.sparse.linalg
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: scipy
:nosignatures:
:template: classtemplate_inherited.rst

20
docs/api/api_python/operations.rst
View File

@ -6,7 +6,7 @@ operations
operations中的Primitive算子在使用前需要实例化。
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -111,7 +111,7 @@ operations中的Primitive算子在使用前需要实例化。
数学算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -220,7 +220,7 @@ operations中的Primitive算子在使用前需要实例化。
数组算子
^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -328,7 +328,7 @@ distributed_training_ascend.html#id12>`_ 。
针对GPU设备，用户需要准备host文件和mpi，详见 `GPU指导文档 \
<https://www.mindspore.cn/tutorials/zh-CN/master/intermediate/distributed_training/distributed_training_gpu.html#id6>`_ 。
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -345,7 +345,7 @@ distributed_training_ascend.html#id12>`_ 。
调试算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -362,7 +362,7 @@ distributed_training_ascend.html#id12>`_ 。
随机算子
^^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -382,7 +382,7 @@ distributed_training_ascend.html#id12>`_ 。
图像算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -392,7 +392,7 @@ distributed_training_ascend.html#id12>`_ 。
稀疏算子
^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -403,7 +403,7 @@ distributed_training_ascend.html#id12>`_ 。
自定义算子
^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
@ -413,7 +413,7 @@ distributed_training_ascend.html#id12>`_ 。
其他算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst