shishi 63ab41b65a docs: consolidate project docs (dedup, relocate, expand 910C client guide)
Project-level documentation was scattered and duplicated across README.md,
BENCHMARK_WORKFLOW.md, and docs/EXPERIMENT_GUIDE.md (directory layout +
scripts/common component table repeated 3x). Reorganize into a clear
single-source-of-truth structure.

Changes:
- README.md: drop the 6 stale changelog entries at the top (latest was
  07-21; history lives in git log). Replace the duplicated directory-
  layout + scripts/common sections with a one-line link to
  docs/EXPERIMENT_GUIDE.md. (151 -> 99 lines)
- BENCHMARK_WORKFLOW.md -> docs/BENCHMARK_WORKFLOW.md: relocate into docs/.
  Replace its duplicated Directory Layout and Quick Start/Adding sections
  with links to EXPERIMENT_GUIDE / README / NEW_PLATFORM_GUIDE; keep the
  unique parts (Rules, Naming Conventions, Final JSON Schema, Checklist).
  (394 -> 224 lines)
- docs/EXPERIMENT_GUIDE.md: now the single authority for directory layout
  + component table + experiment conventions. Add a cross-link from the
  results.json field list to BENCHMARK_WORKFLOW's full JSON Schema and
  Naming Conventions.
- docs/H200_QUICKSTART.md: deleted (outdated, repeatedly references
  removed legacy scripts; H200 usage is covered by ADAPTIVE_CONCURRENCY_USAGE
  and experiment READMEs).
- docs/DSV4_INFERENCE_COMPARISON_REPORT.md -> experiments/h200/
  dsv4_h200_vllm_mtp_vs_default/results/20260708-160349/: this is an
  experiment report, not a project doc; relocate next to its sibling
  report.md.
- envs/ASCEND_910C_ENV_SETUP.md §8: expand the vague "pip install sglang"
  note into a full sglang client image build guide -- pin sglang 0.5.2
  (not latest; >=0.5.16 deprecates bench_serving and breaks the parser),
  --no-deps minimal install loop, docker commit to a local image, with
  the exact commands used to build local/vllm-ascend:0.23-a3-dsv4-sglang.
- experiments/h200/dsv4_h200_vllm_tp2_custom_bench/README.md: fix the
  now-broken link to BENCHMARK_WORKFLOW.md (../../ -> ../../../docs/).
- .gitignore: ignore *.bak.glm52orig scratch backups.

Also includes the add16 adaptive_results produced by the dsv4 TP=4/DP=2
runs on 910c.1.
2026-07-29 11:52:42 +08:00
..

envs 目录说明

本目录用于存放环境搭建相关的文档和指南,不包括具体的虚拟环境或容器镜像文件。

目录结构

envs/
├── README.md                          # 本说明文件
├── UV_ENV_SETUP.md                    # uv 虚拟环境搭建规范
├── SM120_DSV4_DEPLOYMENT_GUIDE.md     # SM120 (RTX 6000D) 部署 DSV4 指南
└── <future guides>                    # 其他平台/环境的部署文档

使用规范

  1. 文档放这里:与建立环境、部署模型、修复平台兼容性相关的文档,应放到 envs/ 目录下。
  2. 环境不放这里:具体的 uv venv、conda env、Docker 镜像构建产物等,不应提交到 git。请在对应环境的 .gitignore 中排除。
  3. 命名规范{平台}_{模型或框架}_DEPLOYMENT_GUIDE.md{框架}_{平台}_FIX.md
  4. 内容要求
    • 环境信息GPU、CUDA、驱动版本
    • 问题现象与错误日志
    • 根因分析
    • 解决步骤(含具体命令或代码修改)
    • 验证结果

现有文档

文档 说明
UV_ENV_SETUP.md uv 虚拟环境搭建规范,含 vLLM 和 SGLang 的标准安装命令
SM120_DSV4_DEPLOYMENT_GUIDE.md RTX 6000D (SM120) 上部署 DeepSeek-V4-Flash 的完整指南,含 vLLM 和 SGLang 的适配步骤
ASCEND_910C_ENV_SETUP.md 昇腾 910C NPU 上搭建 vLLM-Ascend 环境与部署指南含权限、镜像加载、NPU 监控适配

排除的环境目录(已加入 .gitignore

以下子目录包含具体的虚拟环境文件,不应提交:

  • modelscope-hub/
  • modelscope-upload/
  • sglang/
  • sglang-src/
  • vllm/
  • charts/matplotlib 绘图环境,用于生成性能报告图表)