diff --git a/CODEOWNERS b/CODEOWNERS index 101ccfce8b3a270bc25e404adf33370b7f9b1928..ccadea600c6c829610e3087509304c9f16f51207 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -11,6 +11,7 @@ # The maintainers of install. /install/ @nicholas_yhr @hanshize +/resource/release/ @nicholas_yhr @hanshize # The maintainers of tutorials. /tutorials/source_zh_cn/beginner/ @zwiori @gemini524 diff --git a/OWNERS b/OWNERS deleted file mode 100644 index a72292d75137a630993bbc78c2c1f855057beaed..0000000000000000000000000000000000000000 --- a/OWNERS +++ /dev/null @@ -1,6 +0,0 @@ -approvers: -- gemini524 -- Hanshize -- rudy_tan -- tjulyj33 -- xuzhenyoumi diff --git a/README.md b/README.md index 3f913c37315472a1758b40a215d085d88855e04b..cee9190b243735f717461e69369c40ce5a7e9d54 100644 --- a/README.md +++ b/README.md @@ -22,67 +22,59 @@ docs | ├───docs // Technical documents about design, specification and so on. Configuration files for API generation. | | -| ├───devtoolkit // MindSpore Dev Toolkit Documents -| | -| ├───federated // MindSpore Federated Documents -| | | ├───golden_stick // MindSpore Golden Stick Documents | | -| ├───graphlearning // MindSpore Graph Learning Documents -| | -| ├───hub // MindSpore Hub Documents -| | | ├───lite // MindSpore Lite Documents | | -| ├───mindarmour // MindArmour Documents +| ├───mindarmour // MindSpore Armour Documents | | -| ├───mindearth // MindEarth Documents +| ├───mindchemistry // MindSpore Chemistry Documents | | -| ├───mindflow // MindFlow Documents +| ├───mindearth // MindSpore Earth Documents | | -| ├───mindelec // MindElec Documents +| ├───mindelec // MindSpore Elec Documents | | -| ├───mindinsight // MindInsight Documents +| ├───mindflow // MindSpore Flow Documents | | -| ├───mindpandas // MindPandas Documents +| ├───mindformers // MindSpore Transformers Documents | | -| ├───mindquantum // MindQuantum Documents +| ├───mindquantum // MindSpore Quantum Documents | | | ├───mindscience // MindScience Documents | | -| ├───mindsponge // MindSPONGE Documents +| ├───mindsponge // MindSpore SPONGE Documents | | | ├───mindspore // MindSpore Documents | | -| ├───mindformers // MindSpore Transformers Documents -| | -| ├───probability // MindSpore Probability Documents -| | -| ├───recommender // MindSpore Recommender Documents -| | -| ├───reinforcement // MindSpore Reinforcement Documents -| | | ├───sample_code // Document corresponding sample code | | | ├───sciai // MindSpore SciAI Documents | | -| ├───serving // MindSpore Serving Documents -| | -| └───xai // MindSpore XAI Documents +| └───vllm_mindspore // vLLM-MindSpore Plugin Documents | │───install // Installation instruction | -│───templates // Document templates and examples -| │───resource // Resource related documents | +│───templates // Document templates and examples +| │───tools // Automation tool | │───tutorials // MindSpore tutorial related documents | -│───CONTRIBUTING_DOC.md // Contributing Documents +│───CODEOWNERS // Maintainer list +| +│───CONTRIBUTING_DOC.md // English version of contribution document +| +│───CONTRIBUTING_DOC_CN.md // Chinese version of contribution document +| +│───LICENSE // LICENSE document | -└───README.md // Docs repository description +│───NOTICE // NOTICE document +| +│───README.md // English version of docs repository description +| +└───README_CN.md // Chinese version of docs repository description ``` ## Document Construction @@ -92,7 +84,7 @@ MindSpore tutorials and API documentation can be generated by the [Sphinx](https 1. Use `pip` to install MindSpore module, which API documentation needs to built base on the installation, refe to [install](https://www.mindspore.cn/install). ```bash - pip install mindspore-*.*.*-cp37-cp37m-linux_x86_64.whl + pip install mindspore-*.*.*-cp39-cp39m-linux_x86_64.whl ``` 2. Download code of the MindSpore Docs repository. @@ -129,16 +121,16 @@ MindSpore tutorials and API documentation can be generated by the [Sphinx](https ### Note -1. When APIs for different repositories such as MindSpore, MindInsight, and MindQuantum are built, the following configuration list is given for use because some resource files corresponding to different repositories are used, and the corresponding repositories need to be cloned and the environment variables are configured: +1. When APIs for different repositories such as MindSpore are built, the following configuration list is given for use because some resource files corresponding to different repositories are used, and the corresponding repositories need to be cloned and the environment variables are configured: | Generation of the corresponding APIs | Environment variables | Repository links | Repository names | | ---- | ---- | ---- | ---- | | MindSpore | MS_PATH | | mindspore | | MindSpore Lite | MSL_PATH | | mindspore_lite | - | MindQuantum | MQ_PATH | | mindquantum | - | Golden Stick | GS_PATH | | golden_stick | + | MindSpore Transformers | MFM_PATH | | mindformers | + | MindSpore Golden Stick | GS_PATH | | golden_stick | + | MindSpore Quantum | MQ_PATH | | mindquantum | | MindScience | MSC_PATH | | mindscience | - | MindFormers | MFM_PATH | | mindformers | The code to clone the repositories and set the environment variables is as follows: @@ -154,9 +146,19 @@ MindSpore tutorials and API documentation can be generated by the [Sphinx](https export LITE_PACKAGE_PATH = local_path_of_the_Lite_package ``` + The release package needs to include both the device-side and cloud-side, and be stored in the following way: + + ```txt + LITE_PACKAGE_PATH + ├───mindspore-lite-*.*.*-linux-x64.tar.gz + | + └───cloud_fusion + | + └───mindspore-lite-*.*.*-linux-x64.tar.gz + ``` + 3. When [MindSpore Tutorials](https://gitee.com/mindspore/docs/tree/master/tutorials), [MindSpore Docs](https://gitee.com/mindspore/docs/tree/master/docs/mindspore), and [MindQuantum Docs](https://gitee.com/mindspore/docs/tree/master/docs/mindquantum/docs) are built, [pandoc](https://pandoc.org/) needs to be installed. For downloading and installing pandoc, refer to . ## License - [Apache License 2.0](LICENSE) -- [Creative Commons License version 4.0](LICENSE-CC-BY-4.0) diff --git a/README_CN.md b/README_CN.md index f06a8b504ab77994ecd2fc427a2100e264cd5776..1e27ba5d03e5e4c49f6cb6cf3202bbe40e54bd0f 100644 --- a/README_CN.md +++ b/README_CN.md @@ -22,67 +22,59 @@ docs | ├───docs // 设计、规格、FAQ等技术文档，以及用于生成API的相关配置文件 | | -| ├───devtoolkit // MindSpore Dev Toolkit文档 -| | -| ├───federated // MindSpore Federated文档 -| | | ├───golden_stick // MindSpore Golden Stick文档 | | -| ├───graphlearning // MindSpore Graph Learning文档 -| | -| ├───hub // MindSpore Hub文档 -| | | ├───lite // MindSpore Lite文档 | | -| ├───mindarmour // MindArmour文档 +| ├───mindarmour // MindSpore Armour文档 | | -| ├───mindearth // MindEarth文档 +| ├───mindchemistry // MindSpore Chemistry文档 | | -| ├───mindflow // MindFlow文档 +| ├───mindearth // MindSpore Earth文档 | | -| ├───mindelec // MindElec文档 +| ├───mindelec // MindSpore Elec文档 | | -| ├───mindinsight // MindInsight文档 +| ├───mindflow // MindSpore Flow文档 | | -| ├───mindpandas // MindPandas文档 +| ├───mindformers // MindSpore Transformers文档 | | -| ├───mindquantum // MindQuantum文档 +| ├───mindquantum // MindSpore Quantum文档 | | | ├───mindscience // MindScience文档 | | -| ├───mindsponge // MindSPONGE文档 +| ├───mindsponge // MindSpore SPONGE文档 | | | ├───mindspore // MindSpore文档 | | -| ├───mindformers // mindformers文档 -| | -| ├───probability // MindSpore Probability文档 -| | -| ├───recommender // MindSpore Recommender文档 -| | -| ├───reinforcement // MindSpore Reinforcement文档 -| | | ├───sample_code // 文档对应样例代码 | | | ├───sciai // MindSpore SciAI文档 | | -| ├───serving // MindSpore Serving文档 -| | -| └───xai // MindSpore XAI文档 +| └───vllm_mindspore // vLLM-MindSpore Plugin文档 | │───install // 安装指南 | -│───templates // 文档模板和样例 -| │───resource // 资源相关文档 | +│───templates // 文档模板和样例 +| │───tools // 自动化工具 | │───tutorials // MindSpore教程相关文档 | -│───CONTRIBUTING_DOC_CN.md // 贡献文档 +│───CODEOWNERS // Maintainer列表 +| +│───CONTRIBUTING_DOC.md // 贡献文档英文版 +| +│───CONTRIBUTING_DOC_CN.md // 贡献文档中文版 +| +│───LICENSE // LICENSE文档 | -└───README_CN.md // Docs仓说明 +│───NOTICE // NOTICE文档 +| +│───README.md // Docs仓说明英文版 +| +└───README_CN.md // Docs仓说明中文版 ``` ## 文档构建 @@ -92,7 +84,7 @@ MindSpore的教程和API文档均可由[Sphinx](https://www.sphinx-doc.org/en/ma 1. 使用pip安裝MindSpore模块，API文档需要根据安装后的MindSpore模块生成，参考[安装](https://www.mindspore.cn/install)。 ```bash - pip install mindspore-*.*.*-cp37-cp37m-linux_x86_64.whl + pip install mindspore-*.*.*-cp39-cp39m-linux_x86_64.whl ``` 2. 下载MindSpore Docs仓代码。 @@ -129,16 +121,16 @@ MindSpore的教程和API文档均可由[Sphinx](https://www.sphinx-doc.org/en/ma ### 注意事项 -1. 构建MindSpore、MindInsight、MindQuantum等不同仓的API时，由于会使用到对应不同仓的一些资源文件，需要先克隆对应仓，并配置环境变量，给出以下配置列表供使用： +1. 构建MindSpore等不同仓的API时，由于会使用到对应不同仓的一些资源文件，需要先克隆对应仓，并配置环境变量，给出以下配置列表供使用： | 对应API的生成 | 环境变量 | 仓库链接 | 仓库名 | | ---- | ---- | ---- | ---- | | MindSpore | MS_PATH | | mindspore | | MindSpore Lite | MSL_PATH | | mindspore_lite | - | MindQuantum | MQ_PATH | | mindquantum | - | Golden Stick | GS_PATH | | golden_stick | + | MindSpore Transformers | MFM_PATH | | mindformers | + | MindSpore Golden Stick | GS_PATH | | golden_stick | + | MindSpore Quantum | MQ_PATH | | mindquantum | | MindScience | MSC_PATH | | mindscience | - | MindFormers | MFM_PATH | | mindformers | 克隆仓库以及设置环境变量的代码如下： @@ -154,9 +146,19 @@ MindSpore的教程和API文档均可由[Sphinx](https://www.sphinx-doc.org/en/ma export LITE_PACKAGE_PATH = 本地的Lite包路径 ``` + 其中，发布包需要同时包含端侧和云侧，并按以下方式存放： + + ```txt + LITE_PACKAGE_PATH + ├───mindspore-lite-*.*.*-linux-x64.tar.gz + | + └───cloud_fusion + | + └───mindspore-lite-*.*.*-linux-x64.tar.gz + ``` + 3. 构建[MindSpore教程](https://gitee.com/mindspore/docs/tree/master/tutorials)、[MindSpore文档](https://gitee.com/mindspore/docs/tree/master/docs/mindspore)和[MindQuantum文档](https://gitee.com/mindspore/docs/tree/master/docs/mindquantum/docs)时还需安装[pandoc](https://pandoc.org/)，下载和安装pandoc请参考。 ## 版权 - [Apache License 2.0](LICENSE) -- [Creative Commons License version 4.0](LICENSE-CC-BY-4.0) diff --git a/activity/ActivityRecord.md b/activity/ActivityRecord.md deleted file mode 100644 index 9a81090f490717d27efa60b98f786f99a95969f9..0000000000000000000000000000000000000000 --- a/activity/ActivityRecord.md +++ /dev/null @@ -1,33 +0,0 @@ -# MindSpore活动体验 - -MindSpore团队将持续推出体验项目，以便于用户的快速入门和进阶。本表仅用于记录MindSpore活动体验，用户在项目学习完成后，从这里分享体验，踩坑避雷或是记录打卡。我们将第一时间合入您的pr，并展现给所有人。 - -
- - 感谢您的体验！期待您的贡献！ - -
- -目前上线的体验项目如下： - -[《1小时入门AI开发工程师》](https://www.mindspore.cn/news/newschildren?id=354) - -
- ->以防冲突，请尽量选择不同序号填写内容，并在提交PR后关注评论信息。 - -## MindSpore活动体验记录表 - -| 序号 | 体验项目 | 参与链接 | 体验意见 | 体验者 | 联系方式 | 完成时间 | -| :-----------: | :-----------: | :-----------: | :-----------: | :---------------: | :----------------: | :------------: | -| 示例 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103016-1-1.html | 活动简单易懂，对新手小白特别友好，除去网络因素，真正做到了1小时即可入门！| 琦玉 | 1261354409@qq.com | 2021-01-21| -| 1 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103124-1-1.html | 1、需按照文档安装python,如果cmd查看版本没问题，无需再配置环境变量2、安装MindSpore可能会报错，原因是网络问题，建议全程网络好一点3、将训练好的模型部署到手机，app安装文件夹可以通过手机的内存设备按时间排序快速查找4、整个过程没有太大问题，最终测试成功还是蛮开心的| 张晓波 | 1920969038@qq.com | 2021-01-22| -| 2 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103091-1-1.html | 千万记得把python更新到3.7.5，刚开始忘记了，后来一直报错。还有就是用流量下载pip的内容，超大坑！！| 刘佩 | 547278563@qq.com | 2021-01-25| -| 3 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103090-1-1.html | 文档很详细！| DevFeng | 523339263@qq.com | 2021-01-25| -| 4 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103162-1-1.html | 根据文档可以顺利完成，Python版本不一致可配置双版本环境，不必卸载旧版，只需要把原来的版本python.exe重命名即可;提示pip版本可升级时忽略即可，不需要update| 黄雅杰 | 344399145@qq.com | 2021-01-25| -| 5 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103385-1-1.html |活动教程整体还是很容易理解才很好操作，教程的平台采用Windows也照顾到了很多初学者可能不怎么会用Linux。教程中如果能加上提醒Linux环境的用户可以在python train.py后面加上--dataset_path指定一下数据目录的话就完美很多了（不然的话会报路径错误）当然更完美一点的话可以写一下linux下如何编译convert（可以是一个链接），不然的话还需要找个windows平台进行转换模型.总体来说通过猫狗识别实现1小时入门AI这个教程还是蛮有意思的。 | 丁一超 | JeffDing890430@163.com | 2021-01-24 | -| 6 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103213-1-1.html | 1小时即可入门,简单便捷，感谢版主| 多米诺的古牌 | 845053993@qq.com | 2021-01-25| -| 7 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103123-1-1.html | 学练结合的方式很好，学到了很多东西，超赞，而且很方便！| 贾淳 | chunjcsx20@vip.qq.com | 2021-01-22| -| 8 | 1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103095-1-1.html | 文档很好，非常给力。 | 刘炳成 | xjtlbc@163.com | 2021-01-22 | -| 9 |1小时入门AI开发工程师 | https://bbs.huaweicloud.com/forum/thread-103299-1-1.html | 体验很有趣，可以把AI模型部署到手机上，让AI走进生活中，给自己的猫猫进行识别！而且是用华为自己的MindSpore来做的，MindSpore加油！| JinhengZhang | 931136898@qq.com | 2021-01-23| -| 10 |1小时入门AI开发工程师 |https://bbs.huaweicloud.com/forum/thread-103198-1-1.html | 受限于硬件环境和创作条件，没能 1 小时体验完毕，除去其他干扰，可能半小时能完成，当然知识点很丰富，值得深入学习！| 胡琦 | huqi@gpdi.com | 2021-01-23| \ No newline at end of file diff --git a/activity/sample_code/README.md b/activity/sample_code/README.md deleted file mode 100644 index 8042e43459b78faa65367581be0dc9c0360584aa..0000000000000000000000000000000000000000 --- a/activity/sample_code/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# Title -- For example, xxx dataset conversion - -## Installing Third-party Dependencies - -pip install PIL -pip install pandas -... - -## Dataset Source - -Dataset link: - -## Dataset placement - -```text -└─XXX Datasets - ├─test - │ xxx - │ xxx - │ - └─train - xxx - xxx -``` - -## Running Mode - -python xxx.py \ No newline at end of file