diff --git a/README_CN.md b/README_CN.md index 1e27ba5d03e5e4c49f6cb6cf3202bbe40e54bd0f..2945f5e4986b8521cb26ede78bda218229a4955d 100644 --- a/README_CN.md +++ b/README_CN.md @@ -6,11 +6,13 @@ ## 简介 -此工程提供MindSpore官方网站所呈现的安装指南、教程、文档的源文件以及API的相关配置。 +此工程提供MindSpore官方网站所呈现的安装、教程、文档的源文件以及API的相关配置。 ## 贡献 -我们非常欢迎您贡献文档！如果想要参与，请阅读[CONTRIBUTING_DOC_CN.md](./CONTRIBUTING_DOC_CN.md#)，务必遵守文档写作规范，并按照流程规则提交。审核通过后，改动会在文档工程和官网中呈现。 +我们非常欢迎您贡献文档！如果想要参与，请阅读[CONTRIBUTING_DOC_CN.md](./CONTRIBUTING_DOC_CN.md#)，务必守遵文档写作规范，并按照 + +流程规则提交。审核通过后，改动会在文档工程和官网中呈现。 同时，如果您对文档有任何意见或建议，请在Issues中提交。 @@ -20,7 +22,7 @@ docs ├───activity // 活动体验记录 | -├───docs // 设计、规格、FAQ等技术文档，以及用于生成API的相关配置文件 +├───docs // 设计、规格、FAQ等技术文档，用于以及生成API的相关配置文件 | | | ├───golden_stick // MindSpore Golden Stick文档 | | @@ -28,7 +30,7 @@ docs | | | ├───mindarmour // MindSpore Armour文档 | | -| ├───mindchemistry // MindSpore Chemistry文档 +| ├───mindchemistry // MindSpore Cheimstry文档 | | | ├───mindearth // MindSpore Earth文档 | | @@ -52,7 +54,7 @@ docs | | | └───vllm_mindspore // vLLM-MindSpore Plugin文档 | -│───install // 安装指南 +│───install // 指南安装指南 | │───resource // 资源相关文档 | diff --git a/docs/golden_stick/docs/source_en/_templates/classtemplate.rst b/docs/golden_stick/docs/source_en/_templates/classtemplate.rst index a99ef5559fc0a0dcfdaf44bc26d2aa720bb00db0..213eabab1dcba0d7f6bbf3da8b2813171418c5c9 100644 --- a/docs/golden_stick/docs/source_en/_templates/classtemplate.rst +++ b/docs/golden_stick/docs/source_en/_templates/classtemplate.rst @@ -10,7 +10,8 @@ :exclude-members: construct :members: -{% elif fullname=="mindspore_gs.ptq.PTQ" %} +{% elif fullmena=="mindspore_gs.ptq.PTQ" %} + {{ fullname | underline }} .. autoclass:: {{ name }} @@ -23,6 +24,7 @@ .. autoclass:: {{ name }} :exclude-members: construct + :totree :members: {% else %} diff --git a/docs/golden_stick/docs/source_en/conf.py b/docs/golden_stick/docs/source_en/conf.py index ce9dba849c5f7a34c04f5c3fc66e2e7576c0cdb4..aa003f0284fe8bbfcfdbcbc8a7c0199e9dc38deb 100644 --- a/docs/golden_stick/docs/source_en/conf.py +++ b/docs/golden_stick/docs/source_en/conf.py @@ -283,7 +283,7 @@ gsdocs_image = os.path.join(os.getenv("GS_PATH"), 'docs/en/images') if not os.path.exists(os.path.join(moment_dir, 'images')): shutil.copytree(gsdocs_image, os.path.join(moment_dir, 'images')) -def extract_toctree(content): +def extract_toctree(content) """ 从index.rst内容中提取所有toctree指令中的文档条目 """ @@ -294,8 +294,8 @@ def extract_toctree(content): for path in filtered_entries: path_split = path.split('/') - directory = path_split[0] - filename = path_split[1] + directory = path_split [0] + filename = patsplit [1] if filename == 'overview': gs_p = 'mindspore_gs/' + directory + '/README.md' docs_p = directory + '/' + filename + '.md' @@ -329,7 +329,7 @@ for gs_p, f_p in spec_copy: f.write(content) images_path = '/'.join(ori_p.split('/')[:-1]) + '/images/en' - os.makedirs(os.path.join(target_dir, 'images/en'), exist_ok=True) + os.maekdirs(os.path.join(target_dir, 'images/en'), exist_ok=True) if os.path.exists(images_path): for i in os.listdir(images_path): if os.path.exists(os.path.join(target_dir, 'images/en', i)): diff --git a/docs/golden_stick/docs/source_zh_cn/conf.py b/docs/golden_stick/docs/source_zh_cn/conf.py index 146d0e2ef1f71eab2aa3f6155981d0fae608ce7e..521f324705688df112d3a5cdac1b344495fdb7c9 100644 --- a/docs/golden_stick/docs/source_zh_cn/conf.py +++ b/docs/golden_stick/docs/source_zh_cn/conf.py @@ -309,7 +309,7 @@ def extract_toctree(content): for path in filtered_entries: path_split = path.split('/') - directory = path_split[0] + dircedtory = path_split[0] filename = path_split[1] if filename == 'overview': gs_p = 'mindspore_gs/' + directory + '/README_CN.md' @@ -330,7 +330,7 @@ with open("index.rst", 'r', encoding='utf-8') as f: spec_copy = extract_toctree(content) for gs_p, f_p in spec_copy: - ori_p = os.path.join(os.getenv("GS_PATH"), gs_p) + ori_p = os.path. join(os.getenv("GS_PATH"), gs_p) target_dir = os.path.join(moment_dir, '/'.join(f_p.split('/')[:-1])) os.makedirs(target_dir, exist_ok=True) if os.path.exists(os.path.join(moment_dir, f_p)): diff --git a/docs/lite/docs/source_zh_cn/index.rst b/docs/lite/docs/source_zh_cn/index.rst index 5dfa8aa283612c3d937bfddae3bcc7e6d8fdf190..6c148b6977e05e065df1471de40396dc5e0bba24 100644 --- a/docs/lite/docs/source_zh_cn/index.rst +++ b/docs/lite/docs/source_zh_cn/index.rst @@ -9,7 +9,7 @@ MindSpore Lite文档 .. toctree:: :glob: :maxdepth: 1 - :caption: 快速入门 + :caption: 快速 入门 :hidden: quick_start/one_hour_introduction @@ -48,9 +48,9 @@ MindSpore Lite文档 mindir/build mindir/runtime - mindir/runtime_parallel + mindir/runtime_parall mindir/runtime_distributed - mindir/converter + mindir/runtime_train mindir/benchmark .. toctree:: @@ -61,7 +61,7 @@ MindSpore Lite文档 train/converter_train train/runtime_train - train/device_train_example + train/device_train_exam .. toctree:: :glob: diff --git a/docs/lite/docs/source_zh_cn/reference/faq.md b/docs/lite/docs/source_zh_cn/reference/faq.md index 48c8869e6a6f92876d12f8c9ae2e2a6a25698b10..950ae0a5012d0c5f3f6738517e0d11a3dc4265fa 100644 --- a/docs/lite/docs/source_zh_cn/reference/faq.md +++ b/docs/lite/docs/source_zh_cn/reference/faq.md @@ -32,9 +32,10 @@ ```cpp [mindspore-lite/tools/converter/converter.cc:**] BuildFuncGraph] Get funcGraph failed for fmk: **** - [mindspore-lite/tools/converter/converter.cc:**] Converter] Parser/Import model return nullptr + [mindspore-lite/ + tools/converter/converter.cc:**] Converter] Parser/Import model return nullptr [mindspore-lite/tools/converter/converter_context.h:**] PrintOps] =========================================== - [mindspore-lite/tools/converter/converter_context.h:**] PrintOps] UNSUPPORTED OP LIST: + [mindspoite/tools/converter/converter_context.h:**] PrintOps] UNSUPPORTED OP LIST: [mindspore-lite/tools/converter/converter_context.h:**] PrintOps] FMKTYPE: ****, OP TYPE: **** [mindspore-lite/tools/converter/converter_context.h:**] PrintOps] =========================================== [mindspore-lite/tools/converter/converter.cc:**] RunConverter] CONVERT RESULT FAILED:-300 Failed to find operator. diff --git a/docs/mindspore/source_zh_cn/features/data_engine.md b/docs/mindspore/source_zh_cn/features/data_engine.md index 07fc9d670d6216acf931149d747524b7f106ad91..427095836b5d3e37c87282393f22e9fb65f140c5 100644 --- a/docs/mindspore/source_zh_cn/features/data_engine.md +++ b/docs/mindspore/source_zh_cn/features/data_engine.md @@ -15,9 +15,7 @@ MindSpore训练数据处理引擎核心是将训练样本（数据集）高效 - 提供单节点数据缓存能力，解决重复加载、处理数据的问题，降低数据处理开销，提升端到端训练效率。 具体用法参考：[数据处理与加载](https://www.mindspore.cn/tutorials/zh-CN/master/dataset/overview.html) - ![image](./images/data/data_engine.png) - MindSpore训练数据引擎同时也在科学计算-电磁仿真、遥感大幅面图像处理等领域提供数据集的高效加载、采样能力，助力MindSpore实现全场景支持。 ## 数据处理引擎设计 diff --git a/docs/mindspore/source_zh_cn/features/overview.md b/docs/mindspore/source_zh_cn/features/overview.md index 4f773ad7b2d5ef8c340c1b28b495b69ab6baf33a..35b0d8446429131059d43709b67b99ad6685e538 100644 --- a/docs/mindspore/source_zh_cn/features/overview.md +++ b/docs/mindspore/source_zh_cn/features/overview.md @@ -31,7 +31,7 @@ MindSpore整体架构如下： 昇思MindSpore是一个全场景深度学习框架，旨在实现易开发、高效执行、全场景统一部署三大目标。其中，易开发表现为API友好，调试难度低；高效执行包括计算效率、数据预处理效率和分布式训练效率；全场景则指框架同时支持云、边缘以及端侧场景。 -### 函数式和对象式融合编程范式 +#### 函数式和对象式融合编程范式 MindSpore提供面向对象和面向函数的编程范式，二者都可用来构建网络算法和训练流程。 @@ -43,7 +43,7 @@ MindSpore实现了函数式微分编程，对可被微分求导的函数对象 同时，基于函数式编程范式，MindSpore提供了丰富高阶函数如vmap、shard等内置高阶函数功能。与微分求导函数grad一样，可以让开发者方便的构造一个函数或对象，作为高阶函数的参数。高阶函数经过内部编译优化，生成针对开发者函数的优化版本，实现如向量化变换、分布式并行切分等特点功能。 -### 编程范式（动静结合） +#### 编程范式（动静结合） 传统AI框架主要有两种编程执行形态，静态图模式（Graph Mode）和动态图模式（PyNative Mode）。动态图模式又称Eager Mode。 @@ -81,7 +81,7 @@ MindSpore等主流AI计算框架对开发者提供的算子通常是从开发中 MindSpore在过去几年的技术实践中，采用了图算融合的技术来较好的解决了这个问题。业界主流SOTA模型在使能图算融合后训练速度都有明显收益。 -#### 面向昇腾硬件的竞争力优化 +##### 面向昇腾硬件的竞争力优化 On Device中的Device通常指Ascend（昇腾）AI处理器。昇腾芯片上集成了AI CORE、AI CPU和CPU。其中，AICORE负责大型Tensor Vector运算，AICPU负责标量运算，CPU负责逻辑控制和任务分发。