Skip to content

[docs] Fix examples/ paths in the docs after skyrl-train -> skyrl migration#1269

Merged
SumanthRH merged 6 commits intomainfrom
fix-docs-examples-paths
Mar 3, 2026
Merged

[docs] Fix examples/ paths in the docs after skyrl-train -> skyrl migration#1269
SumanthRH merged 6 commits intomainfrom
fix-docs-examples-paths

Conversation

@SumanthRH
Copy link
Copy Markdown
Member

@SumanthRH SumanthRH commented Mar 3, 2026

Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
@SumanthRH SumanthRH marked this pull request as ready for review March 3, 2026 22:27
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates file paths in the documentation to reflect the migration of examples from examples/ to examples/train/. The changes are mostly correct and cover a large number of files. However, I've found a couple of instances where Python module paths in uv run commands were not updated, which could lead to confusion and errors for users following the documentation. I've added comments on the relevant files pointing out these missed updates.

The training configuration uses GRPO with colocated training and generation. Key parameters include:

**Training configuration** (from `examples/llm_as_a_judge/run_llm_judge.sh`):
**Training configuration** (from `examples/train/llm_as_a_judge/run_llm_judge.sh`):
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Thanks for updating the path in this heading. However, in the following code block, the uv run command on line 97 still refers to the old module path examples.llm_as_a_judge.main_llm_judge. This should be updated to examples.train.llm_as_a_judge.main_llm_judge to reflect the new directory structure.

### Step 2: Config knobs to tune for fully async training

Following [examples/fully_async/fully_async_run_gsm8k.sh](https://github.com/NovaSky-AI/SkyRL/blob/main/examples/train/fully_async/fully_async_run_gsm8k.sh), update the training configuration to use your new entrypoint `main_async.py`:
Following [examples/train/fully_async/fully_async_run_gsm8k.sh](https://github.com/NovaSky-AI/SkyRL/blob/main/examples/train/fully_async/fully_async_run_gsm8k.sh), update the training configuration to use your new entrypoint `main_async.py`:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

While you've correctly updated the path to fully_async_run_gsm8k.sh, the example command in the code block below (line 79) still uses the old Python module path. The path examples.fully_async.main_async should be updated to examples.train.fully_async.main_async to match the new directory structure.

devin-ai-integration[bot]

This comment was marked as resolved.

Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
@SumanthRH SumanthRH merged commit 4f6b766 into main Mar 3, 2026
1 check was pending
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