Skip to content

[Doc] Add a doc page for SkyRLGymGenerator, multi-turn rollout/tokenization#186

Merged
tyler-griggs merged 4 commits intoNovaSky-AI:mainfrom
CharlieFRuan:pr-0822-skyrlgymgen-doc
Aug 27, 2025
Merged

[Doc] Add a doc page for SkyRLGymGenerator, multi-turn rollout/tokenization#186
tyler-griggs merged 4 commits intoNovaSky-AI:mainfrom
CharlieFRuan:pr-0822-skyrlgymgen-doc

Conversation

@CharlieFRuan
Copy link
Collaborator

This PR adds a documentation page detailing the behavior of SkyRLGymGenerator, including the 3 codepaths described in #152, how multi-turn and single-turn rollouts/tokenizations work, and how token-in-token-out is enforced.

As a result, we can remove some bulky comments in skyrl_gym_generator.py

Copy link
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 introduces a new documentation page for SkyRLGymGenerator, explaining its multi-turn tokenization behavior and the different codepaths. This allows for the removal of detailed comments from the source code, improving its readability. The changes are well-structured and the new documentation is comprehensive. I've provided a few suggestions to improve the clarity and correct some minor typos in the new documentation file.

CharlieFRuan and others added 3 commits August 22, 2025 16:13
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@tyler-griggs
Copy link
Member

I'll take a look at this today! If you get a sec, could you add screenshots of the rendered doc?

@CharlieFRuan
Copy link
Collaborator Author

Yep, rendered docs:
doc1

doc2 doc3 doc4 doc5

@tyler-griggs tyler-griggs merged commit fd2b530 into NovaSky-AI:main Aug 27, 2025
3 checks passed
dzorlu referenced this pull request in fleet-ai/SkyRL Feb 4, 2026
…zation (#186)

This PR adds a documentation page detailing the behavior of
`SkyRLGymGenerator`, including the 3 codepaths described in
NovaSky-AI#152, how multi-turn and
single-turn rollouts/tokenizations work, and how token-in-token-out is
enforced.

As a result, we can remove some bulky comments in
`skyrl_gym_generator.py`

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.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.

2 participants