Skip to content

[Doc] Align developer guide navigation titles#350

Open
Lidang-Jiang wants to merge 1 commit into
baidu:mainfrom
Lidang-Jiang:docs/dev-guide-navigation-20260506
Open

[Doc] Align developer guide navigation titles#350
Lidang-Jiang wants to merge 1 commit into
baidu:mainfrom
Lidang-Jiang:docs/dev-guide-navigation-20260506

Conversation

@Lidang-Jiang
Copy link
Copy Markdown
Contributor

Summary

  • Rename the developer evaluation section from Accuracy to Evaluation and add a short section description.
  • Add a short description to the developer performance section.
  • Rename Performance_benchmark to Performance Benchmark and align the caption and project casing.
Before
$ git ls-tree --name-only origin/main -- docs/source/developer_guide/evaluation/index.md docs/source/developer_guide/performance/index.md docs/source/developer_guide/performance/performance_benchmark/index.md
docs/source/developer_guide/evaluation/index.md
docs/source/developer_guide/performance/index.md
docs/source/developer_guide/performance/performance_benchmark/index.md

$ git grep -n -e "# Accuracy" -e "# Performance_benchmark" -e vllm-kunlun origin/main -- docs/source/developer_guide/evaluation/index.md docs/source/developer_guide/performance/performance_benchmark/index.md
origin/main:docs/source/developer_guide/evaluation/index.md:1:# Accuracy
origin/main:docs/source/developer_guide/performance/performance_benchmark/index.md:1:# Performance_benchmark
origin/main:docs/source/developer_guide/performance/performance_benchmark/index.md:3:This document details the performance testing methods for vllm-kunlun and the analysis of the results to ultimately optimize performance. The main considerations are server throughput and operator performance.

$ git show origin/main:docs/source/developer_guide/evaluation/index.md
# Accuracy

:::{toctree}
:caption: Accuracy
:maxdepth: 1
accuracy/index
accuracy_report/index
:::

$ git show origin/main:docs/source/developer_guide/performance/performance_benchmark/index.md
# Performance_benchmark

This document details the performance testing methods for vllm-kunlun and the analysis of the results to ultimately optimize performance. The main considerations are server throughput and operator performance.

:::{toctree}
:caption: Performance
:maxdepth: 1
benchmark_server
benchmark_kernel
profiling
:::
After
$ git show --stat --oneline HEAD -- docs/source/developer_guide/evaluation/index.md docs/source/developer_guide/performance/index.md docs/source/developer_guide/performance/performance_benchmark/index.md
03c6337 [Doc] Align developer guide navigation titles
 docs/source/developer_guide/evaluation/index.md                     | 6 ++++--
 docs/source/developer_guide/performance/index.md                    | 2 ++
 .../developer_guide/performance/performance_benchmark/index.md      | 6 +++---
 3 files changed, 9 insertions(+), 5 deletions(-)

$ git grep -n -e "# Evaluation" -e "# Performance Benchmark" -e vLLM-Kunlun HEAD -- docs/source/developer_guide/evaluation/index.md docs/source/developer_guide/performance/index.md docs/source/developer_guide/performance/performance_benchmark/index.md
HEAD:docs/source/developer_guide/evaluation/index.md:1:# Evaluation
HEAD:docs/source/developer_guide/evaluation/index.md:3:This section covers accuracy evaluation workflows and reports for vLLM-Kunlun.
HEAD:docs/source/developer_guide/performance/index.md:3:This section covers performance analysis and benchmarking guidance for vLLM-Kunlun.
HEAD:docs/source/developer_guide/performance/performance_benchmark/index.md:1:# Performance Benchmark
HEAD:docs/source/developer_guide/performance/performance_benchmark/index.md:3:This document details the performance testing methods for vLLM-Kunlun and the analysis of the results to ultimately optimize performance. The main considerations are server throughput and operator performance.

$ sed -n "1,18p" docs/source/developer_guide/evaluation/index.md
# Evaluation

This section covers accuracy evaluation workflows and reports for vLLM-Kunlun.

:::{toctree}
:caption: Evaluation
:maxdepth: 1
accuracy/index
accuracy_report/index
:::

$ sed -n "1,18p" docs/source/developer_guide/performance/index.md
# Performance

This section covers performance analysis and benchmarking guidance for vLLM-Kunlun.

:::{toctree}
:caption: Performance
:maxdepth: 1
performance_benchmark/index
:::

$ sed -n "1,18p" docs/source/developer_guide/performance/performance_benchmark/index.md
# Performance Benchmark

This document details the performance testing methods for vLLM-Kunlun and the analysis of the results to ultimately optimize performance. The main considerations are server throughput and operator performance.

:::{toctree}
:caption: Performance Benchmark
:maxdepth: 1
benchmark_server
benchmark_kernel
profiling
:::

$ git diff --check origin/main..HEAD

$ PYTHONWARNINGS=ignore::UserWarning sphinx-build -b html -n -W --keep-going docs/source /tmp/vllm-kunlun-docs-dev-guide-pr-html
Running Sphinx v8.1.3
loading translations [en]... done
making output directory... done
[autosummary] generating autosummary for: community/contributors.md, community/governance.md, community/user_stories/index.md, community/versioning_policy.md, developer_guide/contribution/contributing.md, developer_guide/contribution/index.md, developer_guide/evaluation/accuracy/accuracy_kernel.md, developer_guide/evaluation/accuracy/accuracy_server.md, developer_guide/evaluation/accuracy/index.md, developer_guide/evaluation/accuracy_report/GLM-4.5-Air.md, ..., user_guide/configuration/env_vars.md, user_guide/configuration/index.md, user_guide/feature_guide/graph_mode.md, user_guide/feature_guide/index.md, user_guide/feature_guide/lora.md, user_guide/feature_guide/quantization.md, user_guide/release_notes.md, user_guide/support_matrix/index.md, user_guide/support_matrix/supported_features.md, user_guide/support_matrix/supported_models.md
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'substitution', 'colon_fence'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=5, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={vllm_version: ..., vllm_kunlun_version: ..., pip_vllm_kunlun_version: ..., pip_vllm_version: ..., ci_vllm_version: ...}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 45 source files that are out of date
updating environment: [new config] 45 added, 0 changed, 0 removed
reading sources... [  2%] community/contributors
reading sources... [  4%] community/governance
reading sources... [  7%] community/user_stories/index
reading sources... [  9%] community/versioning_policy
reading sources... [ 11%] developer_guide/contribution/contributing
reading sources... [ 13%] developer_guide/contribution/index
reading sources... [ 16%] developer_guide/evaluation/accuracy/accuracy_kernel
reading sources... [ 18%] developer_guide/evaluation/accuracy/accuracy_server
reading sources... [ 20%] developer_guide/evaluation/accuracy/index
reading sources... [ 22%] developer_guide/evaluation/accuracy_report/GLM-4.5
reading sources... [ 24%] developer_guide/evaluation/accuracy_report/GLM-4.5-Air
reading sources... [ 27%] developer_guide/evaluation/accuracy_report/InternVL3_5-30B-A3B
reading sources... [ 29%] developer_guide/evaluation/accuracy_report/Qwen2.5-VL-7B-Instruct
reading sources... [ 31%] developer_guide/evaluation/accuracy_report/index
reading sources... [ 33%] developer_guide/evaluation/index
reading sources... [ 36%] developer_guide/feature_guide/Kunlun_Graph
reading sources... [ 38%] developer_guide/feature_guide/index
reading sources... [ 40%] developer_guide/performance/index
reading sources... [ 42%] developer_guide/performance/performance_benchmark/benchmark_kernel
reading sources... [ 44%] developer_guide/performance/performance_benchmark/benchmark_server
reading sources... [ 47%] developer_guide/performance/performance_benchmark/index
reading sources... [ 49%] developer_guide/performance/performance_benchmark/profiling
reading sources... [ 51%] faqs
reading sources... [ 53%] index
reading sources... [ 56%] installation
reading sources... [ 58%] quick_start
reading sources... [ 60%] tutorials/index
reading sources... [ 62%] tutorials/multi_xpu_DeepSeek-V3.2-Exp-w8a8
reading sources... [ 64%] tutorials/multi_xpu_GLM-4.5
reading sources... [ 67%] tutorials/multi_xpu_GLM-5-W8A8-INT8
reading sources... [ 69%] tutorials/multi_xpu_Qwen2.5-VL-32B
reading sources... [ 71%] tutorials/multi_xpu_Qwen3-Coder-480B-A35B(W8A8)
reading sources... [ 73%] tutorials/single_xpu_InternVL2_5-26B
reading sources... [ 76%] tutorials/single_xpu_Qwen3-8B
reading sources... [ 78%] tutorials/single_xpu_Qwen3-VL-32B
reading sources... [ 80%] user_guide/configuration/env_vars
reading sources... [ 82%] user_guide/configuration/index
reading sources... [ 84%] user_guide/feature_guide/graph_mode
reading sources... [ 87%] user_guide/feature_guide/index
reading sources... [ 89%] user_guide/feature_guide/lora
reading sources... [ 91%] user_guide/feature_guide/quantization
reading sources... [ 93%] user_guide/release_notes
reading sources... [ 96%] user_guide/support_matrix/index
reading sources... [ 98%] user_guide/support_matrix/supported_features
reading sources... [100%] user_guide/support_matrix/supported_models

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... 
copying static files... 
Writing evaluated template result to /tmp/vllm-kunlun-docs-dev-guide-pr-html/_static/language_data.js
Writing evaluated template result to /tmp/vllm-kunlun-docs-dev-guide-pr-html/_static/documentation_options.js
Writing evaluated template result to /tmp/vllm-kunlun-docs-dev-guide-pr-html/_static/basic.css
Writing evaluated template result to /tmp/vllm-kunlun-docs-dev-guide-pr-html/_static/copybutton.js
copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [  2%] community/contributors
writing output... [  4%] community/governance
writing output... [  7%] community/user_stories/index
writing output... [  9%] community/versioning_policy
writing output... [ 11%] developer_guide/contribution/contributing
writing output... [ 13%] developer_guide/contribution/index
writing output... [ 16%] developer_guide/evaluation/accuracy/accuracy_kernel
writing output... [ 18%] developer_guide/evaluation/accuracy/accuracy_server
writing output... [ 20%] developer_guide/evaluation/accuracy/index
writing output... [ 22%] developer_guide/evaluation/accuracy_report/GLM-4.5
writing output... [ 24%] developer_guide/evaluation/accuracy_report/GLM-4.5-Air
writing output... [ 27%] developer_guide/evaluation/accuracy_report/InternVL3_5-30B-A3B
writing output... [ 29%] developer_guide/evaluation/accuracy_report/Qwen2.5-VL-7B-Instruct
writing output... [ 31%] developer_guide/evaluation/accuracy_report/index
writing output... [ 33%] developer_guide/evaluation/index
writing output... [ 36%] developer_guide/feature_guide/Kunlun_Graph
writing output... [ 38%] developer_guide/feature_guide/index
writing output... [ 40%] developer_guide/performance/index
writing output... [ 42%] developer_guide/performance/performance_benchmark/benchmark_kernel
writing output... [ 44%] developer_guide/performance/performance_benchmark/benchmark_server
writing output... [ 47%] developer_guide/performance/performance_benchmark/index
writing output... [ 49%] developer_guide/performance/performance_benchmark/profiling
writing output... [ 51%] faqs
writing output... [ 53%] index
writing output... [ 56%] installation
writing output... [ 58%] quick_start
writing output... [ 60%] tutorials/index
writing output... [ 62%] tutorials/multi_xpu_DeepSeek-V3.2-Exp-w8a8
writing output... [ 64%] tutorials/multi_xpu_GLM-4.5
writing output... [ 67%] tutorials/multi_xpu_GLM-5-W8A8-INT8
writing output... [ 69%] tutorials/multi_xpu_Qwen2.5-VL-32B
writing output... [ 71%] tutorials/multi_xpu_Qwen3-Coder-480B-A35B(W8A8)
writing output... [ 73%] tutorials/single_xpu_InternVL2_5-26B
writing output... [ 76%] tutorials/single_xpu_Qwen3-8B
writing output... [ 78%] tutorials/single_xpu_Qwen3-VL-32B
writing output... [ 80%] user_guide/configuration/env_vars
writing output... [ 82%] user_guide/configuration/index
writing output... [ 84%] user_guide/feature_guide/graph_mode
writing output... [ 87%] user_guide/feature_guide/index
writing output... [ 89%] user_guide/feature_guide/lora
writing output... [ 91%] user_guide/feature_guide/quantization
writing output... [ 93%] user_guide/release_notes
writing output... [ 96%] user_guide/support_matrix/index
writing output... [ 98%] user_guide/support_matrix/supported_features
writing output... [100%] user_guide/support_matrix/supported_models

generating indices... genindex done
writing additional pages... search done
copying images... [100%] logos/vllm-kunlun-logo-text-light.png

dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in ../../../../../tmp/vllm-kunlun-docs-dev-guide-pr-html.

Test plan

  • git diff --check origin/main..HEAD
  • PYTHONWARNINGS=ignore::UserWarning sphinx-build -b html -n -W --keep-going docs/source /tmp/vllm-kunlun-docs-dev-guide-pr-html

Signed-off-by: Lidang Jiang <lidangjiang@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant