docs: Add comprehensive bilingual documentation (EN/CN)#43
Open
tianhao909 wants to merge 1 commit into
Open
Conversation
Add professional README.md and README_cn.md with complete project documentation including architecture overview, scheduling policies, configuration reference, and quick start guide. Add docs/ directory with detailed architecture design, quick-start guide, scheduling policies explanation, configuration reference, kernel transformation design, and contributing guidelines - all in both English and Chinese.
There was a problem hiding this comment.
Pull request overview
This PR expands Tally’s end-user and developer documentation by introducing a comprehensive bilingual (EN/CN) README plus a structured docs/ set covering architecture, quick start, scheduling policies, configuration reference, and developer design/contribution guidance.
Changes:
- Replaces the minimal README with a detailed English README and adds a full Chinese counterpart.
- Adds bilingual docs for architecture, quick start, scheduling policies, and configuration reference.
- Adds developer-focused docs under
docs/develop/(design + contributing).
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Expands the project README with architecture, usage, configuration, and benchmark info (EN). |
| README_cn.md | Adds a Chinese translation of the README for bilingual onboarding. |
| docs/architecture.md | Adds a detailed architecture deep dive (EN). |
| docs/architecture_cn.md | Adds a Chinese translation of the architecture doc. |
| docs/quick-start.md | Adds installation/build/run quick start documentation (EN). |
| docs/quick-start_cn.md | Adds a Chinese translation of the quick start doc. |
| docs/scheduling-policies.md | Documents all scheduler policies and selection guidance (EN). |
| docs/scheduling-policies_cn.md | Adds a Chinese translation of scheduling policies doc. |
| docs/configuration.md | Adds an environment-variable and config-file reference (EN). |
| docs/configuration_cn.md | Adds a Chinese translation of the configuration reference. |
| docs/develop/design.md | Adds kernel transformation design notes (EN + CN in one file). |
| docs/develop/contributing.md | Adds contributing guidelines (EN + CN in one file). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The build process: | ||
| 1. Compiles NCCL from `third_party/nccl` | ||
| 2. Runs CMake configuration | ||
| 3. Builds all targets: `tally_server`, `tally_client.so`, `tally_client_local.so`, `tally_cutlass.so` |
Comment on lines
+114
to
+118
| # High-priority inference workload (priority=1) | ||
| TALLY_CLIENT_PRIORITY=1 ./scripts/start_client.sh python inference_server.py | ||
|
|
||
| # Low-priority training workload (priority=0) | ||
| TALLY_CLIENT_PRIORITY=0 ./scripts/start_client.sh python train.py |
| 编译过程： | ||
| 1. 从 `third_party/nccl` 编译 NCCL | ||
| 2. 运行 CMake 配置 | ||
| 3. 构建所有目标：`tally_server`、`tally_client.so`、`tally_client_local.so`、`tally_cutlass.so` |
Comment on lines
+114
to
+118
| # 高优先级推理工作负载（优先级=1） | ||
| TALLY_CLIENT_PRIORITY=1 ./scripts/start_client.sh python inference_server.py | ||
|
|
||
| # 低优先级训练工作负载（优先级=0） | ||
| TALLY_CLIENT_PRIORITY=0 ./scripts/start_client.sh python train.py |
|
|
||
| | Variable | Default | Type | Description | | ||
| | --- | --- | --- | --- | | ||
| | `TALLY_CLIENT_PRIORITY` | `0` | int32 | Client priority (higher = more important) | |
| 这将会： | ||
| 1. 编译 NCCL 依赖 | ||
| 2. 创建 `build/` 目录并使用 CMake 配置 | ||
| 3. 编译 `tally_server`、`tally_client.so` 及相关库 |
Comment on lines
+12
to
+14
| A1[App 1] --> C1[tally_client.so] | ||
| A2[App 2] --> C2[tally_client.so] | ||
| A3[App N] --> C3[tally_client.so] |
|
|
||
| ## Core Components | ||
|
|
||
| ### 1. Client Preload Library (`tally_client.so`) |
Comment on lines
+12
to
+14
| A1[应用 1] --> C1[tally_client.so] | ||
| A2[应用 2] --> C2[tally_client.so] | ||
| A3[应用 N] --> C3[tally_client.so] |
|
|
||
| ## 核心组件 | ||
|
|
||
| ### 1. 客户端预加载库 (`tally_client.so`) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive bilingual (English/Chinese) documentation to the Tally project, significantly improving project accessibility and onboarding experience.
Changes
README
docs/ Directory
docs/architecture.md/docs/architecture_cn.md— Detailed system architecture (client-server, IPC, transformer, scheduler, cache)docs/quick-start.md/docs/quick-start_cn.md— Installation and usage guide (Docker + source build)docs/scheduling-policies.md/docs/scheduling-policies_cn.md— All 5 scheduling policies explaineddocs/configuration.md/docs/configuration_cn.md— Complete environment variable referencedocs/develop/design.md— Kernel transformation design (PTB, slicing, sync-aware)docs/develop/contributing.md— Contributing guidelines (EN + CN)Motivation
The existing README is minimal (~29 lines). This documentation brings Tally to the standard expected of well-maintained open source projects, helping:
Reference
Documentation style inspired by HAMi (CNCF Sandbox project).