Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
latent-9 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/en/get_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Having problems running? Check out the [FAQ](faq)
:caption: dense model fine-tuning example
:linenos:

torchrun xtuner/v1/train/cli/sft.py --model-cfg examples/v1/sft_qwen3_tiny.py --chat_template qwen3 --dataset tests/resource/openai_sft.jsonl
torchrun xtuner/v1/train/cli/sft.py --model-cfg examples/v1/config/sft_qwen3_tiny.py --chat_template qwen3 --dataset tests/resource/openai_sft.jsonl
```

After successful execution, the log is as follows
Expand All @@ -91,7 +91,7 @@ After successful execution, the log is as follows
```
````

The above log shows that only 8G of memory is needed to run. If you want to reduce memory usage further, you can consider modifying the `num_hidden_layers` and `hidden_size` parameters in `examples/v1/sft_qwen3_tiny.py`.
The above log shows that only 8G of memory is needed to run. If you want to reduce memory usage further, you can consider modifying the `num_hidden_layers` and `hidden_size` parameters in `examples/v1/config/sft_qwen3_tiny.py`.

### MLLM Multimodal Large Model Fine-tuning

Expand All @@ -103,7 +103,7 @@ Take Intern-S1 scientific multimodal as an example
:caption: Intern-S1 tiny model fine-tuning example
:linenos:

torchrun xtuner/v1/train/cli/sft.py --config examples/v1/sft_intern_s1_tiny_config.py
torchrun xtuner/v1/train/cli/sft.py --config examples/v1/config/sft_intern_s1_tiny_config.py
```

After successful execution, the log is as follows
Expand Down Expand Up @@ -267,7 +267,7 @@ WARNING: input_ids length 4171 exceeds model_max_length 4096. truncated!
```
````

The above log shows that only 10G of memory is needed to run. If you want to reduce memory usage further, you can consider modifying the `llm_cfg` dictionary related parameters in `examples/v1/sft_intern_s1_tiny_config.py`.
The above log shows that only 10G of memory is needed to run. If you want to reduce memory usage further, you can consider modifying the `llm_cfg` dictionary related parameters in `examples/v1/config/sft_intern_s1_tiny_config.py`.

(faq)=
## FAQ
Expand Down