From e31129539197ce630003a46e0959e12c643e3a1f Mon Sep 17 00:00:00 2001 From: root <15750543867@163.com> Date: Tue, 19 May 2026 15:23:15 +0800 Subject: [PATCH 1/2] [fix] align verl and VeOmni navigation with generated doc layout --- conf.py | 15 ++++--- index.rst | 4 +- sources/VeOmni/index.rst | 4 +- sources/verl/index.rst | 95 +++++++++++++++++++++++++--------------- 4 files changed, 73 insertions(+), 45 deletions(-) diff --git a/conf.py b/conf.py index 0ca0138a..d7045264 100644 --- a/conf.py +++ b/conf.py @@ -207,12 +207,15 @@ def generate_api_doc(): 'verl': { 'display_name': 'verl', 'sidebar_mapping': { - 'quick_start': '🚀 快速入门', - 'features': '📚 特性指南', - 'profiling': '⚡ 调优指南', - 'examples': '📊 应用与调优实践', - 'faq': '🔆 故障排查(FAQ)', - 'contribution_guide': '🔧 开源开发' + 'get_start': '🚀 快速开始', + 'feature_support': '📚 特性支持', + 'dev_guide/model_dev': '🧬 模型开发', + 'dev_guide/precision_analysis': '🎯 精度调试', + 'dev_guide/performance': '⚡ 性能调优', + 'model_support/examples': '📋 最佳实践', + 'model_support': '📊 模型支持', + 'faq': '🔆 常见问题', + 'contribution_guide': '🔧 开源开发', } }, 'vllm-ascend': { diff --git a/index.rst b/index.rst index d44fa9e4..c0812bab 100644 --- a/index.rst +++ b/index.rst @@ -207,14 +207,14 @@

VeOmni

Scaling Any Modality Model Training with Model-Centric Distributed Recipe Zoo。

-
官方链接|安装指南|快速上手
+
官方链接|安装指南|快速上手

verl

用于 LLM 的强化学习训练库，适配昇腾并行计算方案。

-
官方链接|安装指南|快速上手
+
官方链接|安装指南|快速上手
diff --git a/sources/VeOmni/index.rst b/sources/VeOmni/index.rst index f2d2d588..17d59b22 100644 --- a/sources/VeOmni/index.rst +++ b/sources/VeOmni/index.rst @@ -4,5 +4,7 @@ VeOmni .. toctree:: :maxdepth: 3 - ../_generated/sources/VeOmni/get_started/installation/install_ascend + ../_generated/sources/VeOmni/get_started/installation/install + ../_generated/sources/VeOmni/get_started/installation/install_ascend_arm + ../_generated/sources/VeOmni/get_started/installation/install_ascend_x86 ../_generated/sources/VeOmni/hardware_support/get_started_npu diff --git a/sources/verl/index.rst b/sources/verl/index.rst index 4226ed9b..92e14c1c 100644 --- a/sources/verl/index.rst +++ b/sources/verl/index.rst @@ -7,9 +7,6 @@ verl /* 样式隔离：仅作用于首页入口 */ #verl-portal { --v-primary: #0066cc; - --v-secondary: #00a86b; - --v-accent: #ff6b35; - --v-purple: #9d4edd; --v-text-main: #1a1a1a; --v-text-sub: #666666; --v-border: #e1e4e8; @@ -35,7 +32,6 @@ verl font-weight: 600; transition: all 0.3s ease; border: 2px solid white; } .verl-btn-primary { background: white; color: var(--v-primary) !important; } - .verl-btn-secondary { background: transparent; color: white !important; } .verl-btn:hover { transform: translateY(-2px); box-shadow: 0 8px 16px rgba(0,0,0,0.2); } /* 快速开始卡片 */ @@ -87,32 +83,32 @@ verl

🚀 verl

灵活、高效的大语言模型强化学习训练框架

- 📖 GitHub 仓库 + 📖 GitHub 仓库

🚀 快速开始

- -
📚
-

快速入门

-

昇腾环境搭建与基础训练示例

+ +
📦
+

安装指南

+

昇腾 NPU 自定义环境安装

 - -
🔧
-

特性指南

-

昇腾后端特性与一致性说明

+ +
🚀
+

快速上手

+

环境搭建与基础训练示例

 - -
⚙️
-

应用实践

-

性能分析与最佳实践案例

+ +
🔧
+

特性支持

+

昇腾后端特性与 NPU 能力说明
👨‍💻

开源开发

-

CI 流程与贡献指南

+

CI 流程与社区贡献指南
@@ -130,47 +126,74 @@ verl ---- +.. 以下 toctree 引用 make copy-docs 生成的 _generated 内容，目录分组与 +.. sources/_generated/sources/verl/README.md 及 conf.py 中 sidebar_mapping 保持一致。 + +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: 🚀 快速开始 + + ../_generated/sources/verl/get_start/install_guidance + ../_generated/sources/verl/get_start/quick_start + ../_generated/sources/verl/get_start/dockerfile_build_guidance + +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: 📚 特性支持 + + ../_generated/sources/verl/feature_support/ascend_backend_features + ../_generated/sources/verl/feature_support/npu_advance_features + +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: 🧬 模型开发 + + ../_generated/sources/verl/dev_guide/model_dev/transfer_to_npu_guide + ../_generated/sources/verl/dev_guide/model_dev/parameter_and_metrics + ../_generated/sources/verl/dev_guide/model_dev/evaluation + .. toctree:: :maxdepth: 2 :hidden: - :caption: 🚀 快速入门 + :caption: 🎯 精度调试 - ../_generated/sources/verl/quick_start/ascend_quick_start - ../_generated/sources/verl/quick_start/ascend_sglang_quick_start - ../_generated/sources/verl/quick_start/dockerfile_build_guidance + ../_generated/sources/verl/dev_guide/precision_analysis/precision_alignment_zh + ../_generated/sources/verl/dev_guide/precision_analysis/precision_debugger_zh .. toctree:: :maxdepth: 2 :hidden: - :caption: 📚 特性指南 + :caption: ⚡ 性能调优 - ../_generated/sources/verl/features/ascend_backend_features - ../_generated/sources/verl/features/ascend_consistency + ../_generated/sources/verl/dev_guide/performance/ascend_performance_analysis_guide + ../_generated/sources/verl/dev_guide/performance/perf_tuning_on_ascend + ../_generated/sources/verl/dev_guide/performance/ascend_profiling_zh + ../_generated/sources/verl/dev_guide/performance/ascend_profiling_en .. toctree:: :maxdepth: 2 :hidden: - :caption: ⚡ 调优指南 + :caption: 📊 模型支持 - ../_generated/sources/verl/profiling/ascend_profiling_zh - ../_generated/sources/verl/profiling/ascend_profiling_en + ../_generated/sources/verl/model_support/model_and_algorithm_support .. toctree:: :maxdepth: 2 :hidden: - :caption: 📊 应用与调优践实 + :caption: 📋 最佳实践 - ../_generated/sources/verl/examples/ascend_performance_analysis_guide - ../_generated/sources/verl/examples/ascend_sglang_best_practices - ../_generated/sources/verl/examples/dapo_multi_model_optimization_practice - ../_generated/sources/verl/examples/ascend_retool_best_pratice - ../_generated/sources/verl/examples/run_qwen3_32B_megatron_1k_256k_npu - ../_generated/sources/verl/examples/gspo_optimization_practice + ../_generated/sources/verl/model_support/examples/dapo_multi_model_optimization_practice + ../_generated/sources/verl/model_support/examples/gspo_optimization_practice + ../_generated/sources/verl/model_support/examples/ascend_retool_best_pratice + ../_generated/sources/verl/model_support/examples/ascend_sglang_best_practices .. toctree:: :maxdepth: 2 :hidden: - :caption: 🔆 故障排查(FAQ) + :caption: 🔆 常见问题 ../_generated/sources/verl/faq/faq From cf029d68b81bc34c3c006311148ae5757a926e69 Mon Sep 17 00:00:00 2001 From: root <15750543867@163.com> Date: Tue, 19 May 2026 15:56:44 +0800 Subject: [PATCH 2/2] [fix] align LLaMA-Factory navigation with generated doc layout --- index.rst | 2 +- sources/LLaMA-Factory/index.rst | 5 ++--- sources/VeOmni/index.rst | 1 - 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/index.rst b/index.rst index c0812bab..614d208e 100644 --- a/index.rst +++ b/index.rst @@ -172,7 +172,7 @@

LLaMA-Factory

Unified Efficient Fine-Tuning of 100+ LLMs & VLMs。

-
官方链接|安装指南|快速上手
+
官方链接|安装指南|快速上手
diff --git a/sources/LLaMA-Factory/index.rst b/sources/LLaMA-Factory/index.rst index 8ffeec9e..c8acdba6 100644 --- a/sources/LLaMA-Factory/index.rst +++ b/sources/LLaMA-Factory/index.rst @@ -4,6 +4,5 @@ LLaMA-Factory .. toctree:: :maxdepth: 3 - ../_generated/sources/LLaMA-Factory/source/advanced/npu_installation - ../_generated/sources/LLaMA-Factory/source/advanced/npu_training - ../_generated/sources/LLaMA-Factory/source/advanced/distributed \ No newline at end of file + ../_generated/sources/LLaMA-Factory/source/multibackend/npu/npu_installation + ../_generated/sources/LLaMA-Factory/source/multibackend/npu/npu_training diff --git a/sources/VeOmni/index.rst b/sources/VeOmni/index.rst index 17d59b22..132aa32d 100644 --- a/sources/VeOmni/index.rst +++ b/sources/VeOmni/index.rst @@ -4,7 +4,6 @@ VeOmni .. toctree:: :maxdepth: 3 - ../_generated/sources/VeOmni/get_started/installation/install ../_generated/sources/VeOmni/get_started/installation/install_ascend_arm ../_generated/sources/VeOmni/get_started/installation/install_ascend_x86 ../_generated/sources/VeOmni/hardware_support/get_started_npu