Skip to content

docs: fix example config paths in English installation guide - #1994

Open
latent-9 wants to merge 1 commit into
InternLM:mainfrom
latent-9:docs/fix-en-install-config-paths
Open

docs: fix example config paths in English installation guide#1994
latent-9 wants to merge 1 commit into
InternLM:mainfrom
latent-9:docs/fix-en-install-config-paths

Conversation

@latent-9

Copy link
Copy Markdown

The English installation guide references example configs that 404:

  • examples/v1/sft_qwen3_tiny.py (lines 71, 94)
  • examples/v1/sft_intern_s1_tiny_config.py (lines 106, 270)

Both configs actually live under examples/v1/config/examples/v1/ contains only config/ and scripts/. Running the documented command as-is fails at Config.fromfile(...) with FileNotFoundError.

The Chinese installation guide (docs/zh_cn/get_started/installation.md) already uses the correct examples/v1/config/... paths, so this simply brings the English doc back in line.

Docs-only, no functional change.

The English quick-start referenced examples/v1/sft_qwen3_tiny.py and
examples/v1/sft_intern_s1_tiny_config.py, which 404 — the configs live under
examples/v1/config/. The Chinese installation guide already uses the correct
examples/v1/config/ paths; this brings the English doc in line so the
documented torchrun commands run.

@ErenAta16 ErenAta16 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified against the tree rather than eyeballing the paths, and the change is right.

examples/v1/ on main contains only two entries, both directories:

dir  config
dir  scripts

so nothing at examples/v1/*.py resolves, and the commands in the English installation guide fail for anyone copying them. The corrected targets are both present:

examples/v1/config/  ->  19 files, including
                         sft_qwen3_tiny.py
                         sft_intern_s1_tiny_config.py

The detail that makes this straightforward to accept is that docs/zh_cn/get_started/installation.md already carries the corrected paths:

torchrun  xtuner/v1/train/cli/sft.py --model-cfg examples/v1/config/sft_qwen3_tiny.py ...
torchrun xtuner/v1/train/cli/sft.py --config examples/v1/config/sft_intern_s1_tiny_config.py

So the two translations had drifted and this brings the English one back in line rather than proposing a new convention. Worth mentioning in the description, since "which one is correct" is the first question a reviewer has on a path fix, and the Chinese doc answers it.

Both the command lines and the surrounding prose references are updated in the same diff, which is the part that usually gets half-done. Someone reading "modify the num_hidden_layers parameter in ..." needs the same corrected path as the command above it.

Looks complete for this file.

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.

2 participants