Skip to content

Update deprecated huggingface-cli and fix broken links#1147

Merged
zhuzilin merged 9 commits intoTHUDM:mainfrom
Lyken17:main
Dec 19, 2025
Merged

Update deprecated huggingface-cli and fix broken links#1147
zhuzilin merged 9 commits intoTHUDM:mainfrom
Lyken17:main

Conversation

@Lyken17
Copy link
Contributor

@Lyken17 Lyken17 commented Dec 19, 2025

Update deprecated huggingface-cli

The huggingface-cli download command is deprecated in favor of hf download. Updated all documentation under docs/ to use the current command syntax.

Changes

  • 10 files updated: 5 English (docs/en/examples/) and 5 Chinese (docs/zh/examples/) markdown files
  • 18 command occurrences replaced across model download examples (DeepSeek-R1, GLM-4.5, GLM-Z1-9B, Qwen3-4B, Qwen3-30B-A3B) and dataset downloads (dapo-math-17k, aime-2024)

Example change:

# Before
huggingface-cli download Qwen/Qwen3-4B --local-dir /root/Qwen3-4B

# After
hf download Qwen/Qwen3-4B --local-dir /root/Qwen3-4B

Fix Outdated Links and Hyperrefs in docs/

Project Reference:

  • docs/README.md: "SGLang codebase" → "slime codebase"

RST References:

  • docs/zh/index.rst: "fault-tolerance.md" → "fault-torlance.md" (matching actual filename)

Internal Documentation Links:

  • docs/en/get_started/quick_start.md: "models/" → "../examples/" (2 links)
  • docs/zh/get_started/quick_start.md: "models/" → "../examples/" (2 links)
  • docs/en/examples/qwen3-4b-base-openhermes.md: "./models/qwen3-4B.md" → "qwen3-4B.md"
  • docs/zh/examples/qwen3-4b-base-openhermes.md: "./models/qwen3-4B.md" → "qwen3-4B.md"

Repository Root References:

  • docs/en/examples/qwen3-4b-base-openhermes.md: Script paths "../../" → "../../../" (2 links)
  • docs/zh/examples/qwen3-4b-base-openhermes.md: Script paths "../../" → "../../../" (2 links)
  • docs/en/get_started/usage.md: Repository paths "../../" → "../../../" (7 links)
  • docs/zh/get_started/usage.md: Repository paths "../../" → "../../../" (7 links)

Cross-Directory Links:

  • docs/en/get_started/qa.md: "./debug.md" → "../developer_guide/debug.md"
  • docs/zh/get_started/qa.md: "./debug.md" → "../developer_guide/debug.md"

Sphinx/MyST Compatibility:

  • docs/{en,zh}/examples/*.md: Remove "./" prefix from same-directory links (8 files, 8 links)
    • Fixed: ./qwen3-4B.mdqwen3-4B.md
    • Affected files: deepseek-r1.md, glm4.5-355B-A32B.md, qwen3-30B-A3B.md, qwen3-4b-base-openhermes.md (both en and zh)

GitHub Direct Links for Scripts and Python Files:

  • Replace all relative paths to .sh and .py files with GitHub repository URLs (15 files, 27 links)
    • Pattern: ../../../scripts/*.shhttps://github.com/THUDM/slime/blob/main/scripts/*.sh
    • Pattern: ../../../slime/**/*.pyhttps://github.com/THUDM/slime/blob/main/slime/**/*.py
    • Pattern: ../../../train.pyhttps://github.com/THUDM/slime/blob/main/train.py
    • Pattern: ../../../scripts/models/https://github.com/THUDM/slime/tree/main/scripts/models/
    • Examples: run-qwen3-4B.sh, run-qwen3-4B-base-sft.sh, sglang_rollout.py, train.py, arguments.py, types.py

Copilot AI and others added 9 commits December 18, 2025 03:31
Co-authored-by: Lyken17 <7783214+Lyken17@users.noreply.github.com>
…mand

Update deprecated huggingface-cli to hf command in documentation
Co-authored-by: Lyken17 <7783214+Lyken17@users.noreply.github.com>
Co-authored-by: Lyken17 <7783214+Lyken17@users.noreply.github.com>
…patibility

Co-authored-by: Lyken17 <7783214+Lyken17@users.noreply.github.com>
Co-authored-by: Lyken17 <7783214+Lyken17@users.noreply.github.com>
Fix broken documentation links and incorrect relative paths in docs/
@Lyken17 Lyken17 changed the title Update deprecated huggingface-cli to hf command in documentation Update deprecated huggingface-cli and fix broken links Dec 19, 2025
@zhuzilin zhuzilin merged commit 34bb0cd into THUDM:main Dec 19, 2025
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.

3 participants