mirror of
https://github.com/openmlsys/openmlsys-zh.git
synced 2026-03-24 14:00:43 +08:00
chore: update new readme (#491)
* fix: update new readme * chore: update new readme
This commit is contained in:
29
README.md
29
README.md
@@ -76,6 +76,15 @@
|
||||
| [可解释性 AI 系统](chapter_explainable_AI/) | 可解释 AI 方法与落地实践 |
|
||||
| [机器人学习系统](chapter_rl_sys/) | 机器人感知、规划、控制与系统安全 |
|
||||
|
||||
## 更新日志
|
||||
|
||||
| 日期 | 事件 |
|
||||
|------|------|
|
||||
| 2022-01 | 项目初始化,开始中文内容编写 |
|
||||
| 2022-05 | 完成扩展篇各章节(联邦学习、强化学习、可解释 AI) |
|
||||
| 2023-05 | 适配 MindSpore 2.0 |
|
||||
| 2026-03 | 中英文双语构建架构重构;启动英文版 |
|
||||
|
||||
## 构建指南
|
||||
|
||||
### 环境依赖
|
||||
@@ -127,6 +136,26 @@ sh build_html.sh
|
||||
扫码加入微信交流群
|
||||
</p>
|
||||
|
||||
## 引用
|
||||
|
||||
如果本书对您的研究或工作有所帮助,请使用以下格式引用:
|
||||
|
||||
**文本格式:**
|
||||
|
||||
> OpenMLSys Team. *机器学习系统:设计和实现*. 2022. https://openmlsys.github.io/
|
||||
|
||||
**BibTeX:**
|
||||
|
||||
```bibtex
|
||||
@book{openmlsys2022,
|
||||
title = {机器学习系统:设计和实现},
|
||||
author = {OpenMLSys Team},
|
||||
year = {2022},
|
||||
url = {https://openmlsys.github.io/},
|
||||
note = {开源教材,\url{https://github.com/openmlsys/openmlsys-zh}}
|
||||
}
|
||||
```
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 [知识共享 署名-非商业性使用-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh) 授权。
|
||||
|
||||
33
README_EN.md
33
README_EN.md
@@ -27,7 +27,9 @@
|
||||
|
||||
An open-source book explaining the design principles and implementation experience of modern machine learning systems, covering the complete technology stack from programming interfaces and computational graphs to compilers and distributed training.
|
||||
|
||||
**Read Online:** [openmlsys.github.io](https://openmlsys.github.io/)
|
||||
**English version 1 (stable):** [openmlsys.github.io/html-en/](https://openmlsys.github.io/html-en/)
|
||||
|
||||
**English version 2:** Under reconstruction.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -76,6 +78,15 @@ The book is organized into three parts: Fundamentals, Advanced Topics, and Exten
|
||||
| [Explainable AI Systems](chapter_explainable_AI/) | XAI methods and production practices |
|
||||
| [Robot Learning Systems](chapter_rl_sys/) | Robot perception, planning, control, and system safety |
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Event |
|
||||
|------|-------|
|
||||
| 2022-01 | Project initialized; Chinese content writing begins |
|
||||
| 2022-05 | Extension chapters released (Federated Learning, RL Systems, Explainable AI) |
|
||||
| 2023-05 | Codebase adapted to MindSpore 2.0 |
|
||||
| 2026-03 | Bilingual (CN/EN) build architecture refactored; English version launched |
|
||||
|
||||
## Build Guide
|
||||
|
||||
### Prerequisites
|
||||
@@ -123,6 +134,26 @@ Before contributing, please read:
|
||||
|
||||
Join our WeChat group by scanning the QR code in [info/mlsys_group.png](info/mlsys_group.png).
|
||||
|
||||
## Citation
|
||||
|
||||
If this book has been helpful to your research or work, please cite it as:
|
||||
|
||||
**Plain text:**
|
||||
|
||||
> OpenMLSys Team. *Machine Learning Systems: Design and Implementation*. 2022. https://openmlsys.github.io/
|
||||
|
||||
**BibTeX:**
|
||||
|
||||
```bibtex
|
||||
@book{openmlsys2022,
|
||||
title = {Machine Learning Systems: Design and Implementation},
|
||||
author = {OpenMLSys Team},
|
||||
year = {2022},
|
||||
url = {https://openmlsys.github.io/},
|
||||
note = {Open-source textbook, \url{https://github.com/openmlsys/openmlsys-zh}}
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
|
||||
|
||||
Reference in New Issue
Block a user