diff --git a/README.md b/README.md index 23d3bbb..d8a9395 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,23 @@ ## 📖 Table of Contents | 目录 -
+
+English -| English | 中文 | -|---------|------| -| [Installation](#installation) | [安装](#安装) | -| [Quick Start](#quick-start) | [快速开始](#快速开始) | -| [Documentation](#documentation) | [文档](#文档) | -| [License](#license) | [许可证](#许可证) | +- [Installation](#installation) +- [Quick Start](#quick-start) +- [Documentation](#documentation) -
+ + +
+中文 + +- [安装](#安装) +- [快速开始](#快速开始) +- [文档](#文档) + +
--- @@ -73,11 +80,6 @@ python demo/generate_ar.py - [bilibili](https://www.bilibili.com/video/BV1z5RPYHEkd) - -### License - -GPL-3.0 - --- @@ -125,23 +127,25 @@ python demo/generate_ar.py - [bilibili](https://www.bilibili.com/video/BV1z5RPYHEkd) -### 许可证 - -GPL-3.0 --- -## 📚 Documentation | 文档 -| Document | 说明 | -|----------|------| -| [参数说明](assets/docs/params.md) | Training & inference parameters | -| [设计文档](assets/docs/design.md) | Framework design | -| [数据流程](assets/docs/dataflow.md) | Data processing pipeline | -| [模型介绍](assets/docs/introduction.md) | Model architecture | +### Document | 文档 + +| Document | Description | +|----------|-------------| +| *Parameter Guide*
[参数说明](./assets/docs/params.md) | *Training & inference parameters*
训练与推理参数配置 | +| *Design Document*
[设计文档](./assets/docs/design.md) | *Framework architecture & module design*
系统架构与模块设计 | +| *Data Flow*
[数据流程](./assets/docs/dataflow.md) | *Data processing pipeline details*
数据处理管道详解 | +| *Model Introduction*
[模型介绍](./assets/docs/introduction.md) | *Model architecture & technical details*
模型架构与技术细节 | ### Download | 下载 - [HuggingFace](https://huggingface.co/ViperEk/KHAOSZ) -- `python demo/download.py` \ No newline at end of file +- `python demo/download.py` + +### Lincence | 许可证 + +- [GPL-3.0](LICENSE) \ No newline at end of file