docs+chore: Bilingual Documentation System & Community Health Files | 双语文档体系与社区健康文件 by tianhao909 · Pull Request #244 · aliyun/SimAI

tianhao909 · 2026-03-18T05:25:05Z

Summary

This PR builds a comprehensive bilingual (English/Chinese) documentation system for SimAI 1.6, along with GitHub community health files including issue templates, PR template, and CI workflow.

摘要

本 PR 为 SimAI 1.6 构建全面的双语（中英文）文档体系，并添加 GitHub 社区健康文件，包括 Issue 模板、PR 模板和 CI 工作流。

Dependencies / 依赖关系

This PR depends on #243. Please merge PR1 first.
本 PR 依赖 #243，请先合入 PR1。

Changes / 变更内容

Documentation / 文档

SimAI 1.6 Technical Report (EN/ZH): GPU memory inference architecture deep-dive | SimAI 1.6 技术报告（中英文）
User Guides: Installation, quickstart, workload generation, simulation running, result analysis | 用户指南：安装、快速开始、工作负载生成、仿真运行、结果分析
Developer Guides: Contributing guide, architecture overview, adding models, extending NS-3 | 开发者指南：贡献指南、架构概览、添加模型、扩展 NS-3
Component Docs: AICB, Astra-Sim, NS-3, SimCCL, Vidur documentation | 组件文档
Project READMEs: EN/ZH/JA trilingual versions with feature highlights | 项目 README 三语版本
vidur-alibabacloud READMEs: EN/ZH module documentation | 模块文档
Community Files: CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, CHANGELOG in bilingual format | 社区文件双语版本

GitHub Community Health / GitHub 社区健康文件

Bug report issue template (YAML) | Bug 报告模板
Feature request issue template (YAML) | 功能请求模板
Pull request template with bilingual checklist | PR 模板
Lint CI workflow (lint.yml) | 代码检查 CI 工作流
Updated .gitignore with build artifact rules | 更新 .gitignore

Documentation Structure / 文档结构

docs/
├── SimAI_1.6_Tech_Report.md / _CN.md
├── en/
│   ├── getting_started/
│   ├── user_guide/
│   ├── developer_guide/
│   ├── components/
│   ├── technical_reference/
│   ├── benchmarking/
│   └── community/
└── zh/
    └── (mirror structure in Chinese)

Testing / 测试

All markdown files validated for correct formatting
Internal links verified between EN/ZH documentation
GitHub templates tested for proper YAML rendering

Checklist

Bilingual documentation (EN/ZH) / 双语文档
Consistent structure between EN and ZH docs / 中英文文档结构一致
Issue and PR templates in YAML format / Issue 和 PR 模板
No IDE config files included / 不包含 IDE 配置文件
.gitignore cleaned of dangerous global rules / .gitignore 已清理危险规则

Co-authored-by: tianhao909 843101550@qq.com
Co-authored-by: MXtremist 44829997+MXtremist@users.noreply.github.com

Build a comprehensive bilingual (English/Chinese) documentation system covering: - SimAI 1.6 Technical Report (EN/ZH) with GPU memory inference architecture - Complete user guides: installation, quickstart, workload generation, simulation - Developer guides: contributing, architecture overview - Project READMEs in EN/ZH/JA with feature highlights and quickstart - vidur-alibabacloud module documentation (EN/ZH + original Vidur README) - CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, CHANGELOG in bilingual format 构建全面的双语（中英文）文档体系，涵盖： - SimAI 1.6 技术报告（中英文），含 GPU 内存推理架构说明 - 完整用户指南：安装、快速开始、工作负载生成、仿真运行 - 开发者指南：贡献指南、架构概览 - 项目 README 中英日三语版本，含功能亮点与快速开始 - vidur-alibabacloud 模块文档（中英文 + 原始 Vidur README） - CONTRIBUTING、SECURITY、CODE_OF_CONDUCT、CHANGELOG 双语版本 Co-authored-by: tianhao909 <843101550@qq.com> Co-authored-by: MXtremist <44829997+MXtremist@users.noreply.github.com>

…y, Changelog) Add GitHub community health and CI configuration files: - Bug report and feature request issue templates (YAML format) - Pull request template with bilingual checklist - Lint CI workflow (lint.yml) for code quality checks - Update .gitignore with build artifact rules 添加 GitHub 社区健康文件与 CI 配置： - Bug 报告和功能请求 Issue 模板（YAML 格式） - Pull Request 模板，含双语检查清单 - 代码质量检查 CI 工作流（lint.yml） - 更新 .gitignore 构建产物规则 Co-authored-by: tianhao909 <843101550@qq.com> Co-authored-by: MXtremist <44829997+MXtremist@users.noreply.github.com>

恢复根 .gitignore 中的开发规则 Co-authored-by: tianhao909 <843101550@qq.com> Co-authored-by: MXtremist <44829997+MXtremist@users.noreply.github.com>

Copilot

Pull request overview

This PR introduces a bilingual (EN/ZH) documentation structure for SimAI (including user/developer guides, component docs, and technical references), and adds GitHub community health files (issue templates, PR template) plus a lint workflow.

Changes:

Add comprehensive EN/ZH documentation under docs/en/ and docs/zh/ (user guide, developer guide, components, benchmarking, technical reference).
Add/refresh community health files (SECURITY*, CODE_OF_CONDUCT*, CHANGELOG*, issue templates, PR template) and a GitHub Actions lint workflow.
Update .gitignore rules.

Reviewed changes

Copilot reviewed 81 out of 84 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
docs/zh/user_guide/workload_generation.md	ZH guide for training/inference workload generation via AICB/AIOB
docs/zh/user_guide/supported_models.md	ZH supported model matrix and hardware requirements
docs/zh/user_guide/simai_simulation.md	ZH NS-3 simulation mode guide and topology workflow
docs/zh/user_guide/simai_physical.md	ZH physical traffic (RDMA/MPI) mode guide
docs/zh/user_guide/simai_analytical.md	ZH analytical mode guide and busbw usage
docs/zh/user_guide/result_analysis.md	ZH output formats and analysis workflows for all modes
docs/zh/user_guide/inference_simulation.md	ZH multi-request inference simulation guide (PD, schedulers, backends)
docs/zh/user_guide/index.md	ZH user guide landing page
docs/zh/technical_reference/memory_module.md	ZH GPU memory module reference (ParamCounter/KV/Planner)
docs/zh/technical_reference/index.md	ZH technical reference landing page
docs/zh/technical_reference/configuration.md	ZH config reference (SimAI.conf/busbw/topo/model configs)
docs/zh/technical_reference/cli_reference.md	ZH CLI reference for simulators and generators
docs/zh/index.md	ZH docs home page and navigation
docs/zh/getting_started/quickstart.md	ZH quickstart walkthroughs
docs/zh/getting_started/installation.md	ZH installation (Docker/source/conda) instructions
docs/zh/getting_started/index.md	ZH getting started index
docs/zh/developer_guide/index.md	ZH developer guide index
docs/zh/developer_guide/contributing.md	ZH contributing workflow and style guidance
docs/zh/developer_guide/architecture.md	ZH architecture overview and build outputs
docs/zh/components/simccl.md	ZH SimCCL component documentation
docs/zh/components/ns3.md	ZH ns-3-alibabacloud component documentation
docs/zh/components/index.md	ZH components index and composition matrix
docs/zh/components/astra_sim.md	ZH astra-sim engine documentation and topology generation
docs/zh/community/index.md	ZH community page (help, contacts, events, citation)
docs/zh/benchmarking/test_suite.md	ZH 4-scenario inference test suite documentation
docs/zh/benchmarking/index.md	ZH benchmarking index
docs/en/user_guide/workload_generation.md	EN guide for training/inference workload generation via AICB/AIOB
docs/en/user_guide/supported_models.md	EN supported model matrix and hardware requirements
docs/en/user_guide/simai_simulation.md	EN NS-3 simulation mode guide and topology workflow
docs/en/user_guide/simai_physical.md	EN physical traffic (RDMA/MPI) mode guide
docs/en/user_guide/simai_analytical.md	EN analytical mode guide and busbw usage
docs/en/user_guide/result_analysis.md	EN output formats and analysis workflows for all modes
docs/en/user_guide/inference_simulation.md	EN multi-request inference simulation guide (PD, schedulers, backends)
docs/en/user_guide/index.md	EN user guide landing page
docs/en/technical_reference/memory_module.md	EN GPU memory module reference (ParamCounter/KV/Planner)
docs/en/technical_reference/index.md	EN technical reference landing page
docs/en/technical_reference/configuration.md	EN config reference (SimAI.conf/busbw/topo/model configs)
docs/en/technical_reference/cli_reference.md	EN CLI reference for simulators and generators
docs/en/index.md	EN docs home page and navigation
docs/en/getting_started/quickstart.md	EN quickstart walkthroughs
docs/en/getting_started/installation.md	EN installation (Docker/source/conda) instructions
docs/en/getting_started/index.md	EN getting started index
docs/en/developer_guide/index.md	EN developer guide index
docs/en/developer_guide/contributing.md	EN contributing workflow and style guidance
docs/en/developer_guide/architecture.md	EN architecture overview and build outputs
docs/en/developer_guide/adding_models.md	EN guide for adding new model support (Vidur + AICB)
docs/en/components/simccl.md	EN SimCCL component documentation
docs/en/components/ns3.md	EN ns-3-alibabacloud component documentation
docs/en/components/index.md	EN components index and composition matrix
docs/en/components/astra_sim.md	EN astra-sim engine documentation and topology generation
docs/en/community/index.md	EN community page (help, contacts, events, citation)
docs/en/benchmarking/test_suite.md	EN 4-scenario inference test suite documentation
docs/en/benchmarking/index.md	EN benchmarking index
SECURITY_CN.md	Chinese security policy
SECURITY.md	English security policy
README.ja.md	Japanese README updates (events section adjustment)
CODE_OF_CONDUCT_CN.md	Chinese Code of Conduct
CODE_OF_CONDUCT.md	English Code of Conduct
CHANGELOG_CN.md	Chinese changelog (includes 1.6.0 entry)
CHANGELOG.md	English changelog (includes 1.6.0 entry)
.gitignore	Ignore rule updates
.github/workflows/lint.yml	Add lint workflow (Python + Markdown lint)
.github/pull_request_template.md	Add PR template
.github/ISSUE_TEMPLATE/feature_request.yml	Add feature request issue template
.github/ISSUE_TEMPLATE/config.yml	Configure issue template behavior and contact links
.github/ISSUE_TEMPLATE/bug_report.yml	Add bug report issue template

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

docs/en/index.md

+- [GitHub Repository](https://github.com/aliyun/SimAI)
+- [NSDI'25 Paper (PDF)](https://ennanzhai.github.io/pub/nsdi25spring-simai.pdf)
+- [Slides](../../docs/SimAI_Intro_Online.pdf)
+- [Technical Report (1.6)](../SimAI_1.6_Tech_Report.md)


docs/zh/index.md

+- [GitHub 仓库](https://github.com/aliyun/SimAI)
+- [NSDI'25 论文 (PDF)](https://ennanzhai.github.io/pub/nsdi25spring-simai.pdf)
+- [演示文稿](../../docs/SimAI_Intro_Online.pdf)
+- [技术报告 (1.6)](../SimAI_1.6_Tech_Report.md)
+- [贡献指南](../../CONTRIBUTING.md)


docs/en/developer_guide/architecture.md

+|------|--------|----------|
+| Analytical | `SimAI_analytical` | `bin/` |
+| Simulation | `SimAI_simulator` | `bin/` |
+| Physical | `SimAI_physical` | `bin/` |


docs/zh/developer_guide/architecture.md

+| Analytical | `SimAI_analytical` | `bin/` |
+| Simulation | `SimAI_simulator` | `bin/` |
+| Physical | `SimAI_physical` | `bin/` |


docs/zh/user_guide/simai_simulation.md

+
+## 示例：RING vs NVLS 对比
+
+请参阅 [Tutorial](../../docs/Tutorial.md#ring-vs-nvls) 了解 RING 和 NVLS 算法在不同消息大小下的完整对比。


docs/en/community/index.md

+
+**Resources:**
+- [Paper (PDF)](https://ennanzhai.github.io/pub/nsdi25spring-simai.pdf)
+- [Slides](../../docs/SimAI_Intro_Online.pdf)


docs/zh/community/index.md

+**相关资源：**
+- [论文 (PDF)](https://ennanzhai.github.io/pub/nsdi25spring-simai.pdf)
+- [幻灯片](../../docs/SimAI_Intro_Online.pdf)
+- [视频回放](https://n.dingtalk.com/dingding/live-room/index.html?roomId=OF5BkBUXVxmgsK7x&liveUuid=305736cd-aa70-498b-8003-2b471a53decd)


docs/en/user_guide/simai_physical.md

+
+**Component Combination**: [AICB](../../components/aicb.md) + [SimCCL](../../components/simccl.md) + [astra-sim-alibabacloud](../../components/astra_sim.md) (physical mode)
+


docs/en/user_guide/simai_simulation.md

+
+## Example: RING vs NVLS Comparison
+
+See the [Tutorial](../../docs/Tutorial.md#ring-vs-nvls) for a complete comparison of RING and NVLS algorithms across different message sizes.


tianhao909 · 2026-03-19T02:23:16Z

涉及到行为准则、安全政策的相关文档，需要看看有没有必要保留，删除也可以的，

套模板的，感觉没啥太大功能作用，可能还加了一些我们也不太确定的条款约束？

tianhao909 and others added 3 commits March 18, 2026 05:22

chore: restore root .gitignore with development rules

e2ffdfc

恢复根 .gitignore 中的开发规则 Co-authored-by: tianhao909 <843101550@qq.com> Co-authored-by: MXtremist <44829997+MXtremist@users.noreply.github.com>

tianhao909 requested a review from Copilot March 18, 2026 13:04

Copilot started reviewing on behalf of tianhao909 March 18, 2026 13:05 View session

Copilot AI reviewed Mar 18, 2026

View reviewed changes

tianhao909 mentioned this pull request Mar 19, 2026

ncclFlowModel 输出文件为空 & 已知 Bug 长期未修复 #247

Open

This was referenced Mar 31, 2026

关于 communication_time_predictor.py 中 ncclFlowModel_EndToEnd.csv 的生成来源与SimAI对应实现的疑问 #258

Open

有用vidur运行推理的demo示例么 #259

Open

DeepSeek推理仿真问题 #262

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs+chore: Bilingual Documentation System & Community Health Files | 双语文档体系与社区健康文件#244

docs+chore: Bilingual Documentation System & Community Health Files | 双语文档体系与社区健康文件#244
tianhao909 wants to merge 3 commits intoaliyun:masterfrom
tianhao909:pr2-docs-community

tianhao909 commented Mar 18, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

tianhao909 commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		## 示例：RING vs NVLS 对比

		请参阅 [Tutorial](../../docs/Tutorial.md#ring-vs-nvls) 了解 RING 和 NVLS 算法在不同消息大小下的完整对比。


		Component Combination: [AICB](../../components/aicb.md) + [SimCCL](../../components/simccl.md) + [astra-sim-alibabacloud](../../components/astra_sim.md) (physical mode)


		## Example: RING vs NVLS Comparison

		See the [Tutorial](../../docs/Tutorial.md#ring-vs-nvls) for a complete comparison of RING and NVLS algorithms across different message sizes.

Conversation

tianhao909 commented Mar 18, 2026

Summary

摘要

Dependencies / 依赖关系

Changes / 变更内容

Documentation / 文档

GitHub Community Health / GitHub 社区健康文件

Documentation Structure / 文档结构

Testing / 测试

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

tianhao909 commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants