diff --git a/CONTRIBUTING_DOC.md b/CONTRIBUTING_DOC.md index 8f72da0147dab2e92d2b0d73958f326e7c26b333..6c283862aeb81f5c3566fe00eec4d9041e789394 100644 --- a/CONTRIBUTING_DOC.md +++ b/CONTRIBUTING_DOC.md @@ -105,14 +105,14 @@ If you want to add an API, check whether the API has been added to an existing m If the API belongs to the following modules, the API list of the MindSpore docs repository needs to be updated. Please add APIs in alphabetical order. - - `mindspore.dataset`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.rst) - - `mindspore.dataset.text`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.text.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.text.rst) - - `mindspore.dataset.transforms`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.transforms.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.transforms.rst) - - `mindspore.dataset.vision`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.vision.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.vision.rst) - - `mindspore.nn`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.nn.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.rst) - - `mindspore.nn.probability`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.nn.probability.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.probability.rst) - - `mindspore.ops`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.ops.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.ops.rst) - - `mindspore.ops.operations`: [中文](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/operations.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/operations.rst) + - `mindspore.dataset`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.rst) + - `mindspore.dataset.text`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.text.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.text.rst) + - `mindspore.dataset.transforms`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.transforms.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.transforms.rst) + - `mindspore.dataset.vision`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.vision.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.vision.rst) + - `mindspore.nn`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.nn.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.rst) + - `mindspore.nn.probability`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.nn.probability.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.probability.rst) + - `mindspore.ops`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.ops.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.ops.rst) + - `mindspore.ops.operations`: [中文](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/operations.rst) | [English](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/operations.rst) - If the API does not belong to the existing module, add an API project file of the MindSpore docs repository. Please add modules to the [directory structure](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/index.rst) in alphabetical order. To add the API of the `mindspore.context` module, you need to create the [mindspore.context.rst](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.context.rst) file in the `docs/docs/api_python/source_en/mindspore` directory and add the file to the directory structure. diff --git a/CONTRIBUTING_DOC_CN.md b/CONTRIBUTING_DOC_CN.md index e7d135c96aa0ec590ce60848ee2947feaea7dd99..34fd6b9ad2512687f751114c249b5a2a7a0023dd 100644 --- a/CONTRIBUTING_DOC_CN.md +++ b/CONTRIBUTING_DOC_CN.md @@ -91,7 +91,7 @@ MindSpore docs仓提供了[API注释写作要求](https://gitee.com/mindspore/do 如果不清楚所在文件,可点击“source”,并参考跳转的链接地址中`_modules`后的内容,找到该文件。 -以Tensor为例,点击“source”后得到地址,源文件地址即为。 +以Tensor为例,点击“source”后得到地址,源文件地址即为。 ![API Source](./resource/_static/api_source.png) @@ -105,16 +105,16 @@ MindSpore docs仓提供了[API注释写作要求](https://gitee.com/mindspore/do 如果属于以下模块,还需更新MindSpore docs仓的接口列表,请按字母序添加API。 - - `mindspore.dataset`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.rst) - - `mindspore.dataset.text`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.text.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.text.rst) - - `mindspore.dataset.transforms`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.transforms.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.transforms.rst) - - `mindspore.dataset.vision`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.dataset.vision.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.vision.rst) - - `mindspore.nn`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.nn.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.rst) - - `mindspore.nn.probability`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.nn.probability.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.probability.rst) - - `mindspore.ops`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.ops.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.ops.rst) - - `mindspore.ops.operations`:[中文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/operations.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/operations.rst) + - `mindspore.dataset`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.rst) + - `mindspore.dataset.text`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.text.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.text.rst) + - `mindspore.dataset.transforms`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.transforms.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.transforms.rst) + - `mindspore.dataset.vision`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.dataset.vision.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.dataset.vision.rst) + - `mindspore.nn`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.nn.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.rst) + - `mindspore.nn.probability`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.nn.probability.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.nn.probability.rst) + - `mindspore.ops`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.ops.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/mindspore.ops.rst) + - `mindspore.ops.operations`:[中文页面列表](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/operations.rst) | [英文页面列表](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_en/api_python/operations.rst) -- 如果不属于已有模块,需新增MindSpore docs仓的接口工程文件,并按字母序添加模块到[目录结构](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/index.rst)中。如需新增`mindspore.context`模块接口,需在`docs/docs/api_python/source_zh_cn/mindspore`目录下新增[mindspore.context.rst](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/api_python/mindspore.context.rst)文件,并将其添加到目录结构中。同时,在`docs/docs/api_python/source_en/mindspore`目录下做相应修改,即可生成英文页面内容。 +- 如果不属于已有模块,需新增MindSpore docs仓的接口工程文件,并按字母序添加模块到[目录结构](https://gitee.com/mindspore/docs/blob/master/docs/mindspore/api/source_zh_cn/index.rst)中。如需新增`mindspore.context`模块接口,需在`docs/docs/api_python/source_zh_cn/mindspore`目录下新增[mindspore.context.rst](https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/mindspore.context.rst)文件,并将其添加到目录结构中。同时,在`docs/docs/api_python/source_en/mindspore`目录下做相应修改,即可生成英文页面内容。 ```rst .. toctree::