Skip to content

Improve concepts docs and add docs for agent and resources server#796

Merged
bxyu-nvidia merged 10 commits intomainfrom
cwing/concepts-improvements
Mar 2, 2026
Merged

Improve concepts docs and add docs for agent and resources server#796
bxyu-nvidia merged 10 commits intomainfrom
cwing/concepts-improvements

Conversation

@cwing-nvidia
Copy link
Copy Markdown
Contributor

Summary

  • Add Training Approaches page explaining SFT vs RL, DPO, GRPO, and RLVR
  • Rename "Core Components" to "Environment Components" with a "What is an Environment?" introduction and updated architecture diagram
  • Create dedicated Agent Server, Resources Server pages with pseudocode and examples
  • Improve Model Server page with conceptual intro and consistent seealso links to server config
  • Streamline Environment Components page: replace tab-set with linked bullets, replace SVG with ASCII diagram showing rollout lifecycle across servers
  • Improve About overview: replace motivation with more concrete challenges, and more concrete details on how NeMo Gym addresses
  • Add cross-links between training approaches, training tutorials, and rollout collection
  • Introduce rollout concept in GRPO section with glossary term reference

Related Issues

Test Plan

  • Build docs locally and verify all new pages render correctly
  • Verify all {doc}, {ref}, and {term} cross-links resolve
  • Check environment diagram renders properly in code block

@bxyu-nvidia bxyu-nvidia linked an issue Mar 2, 2026 that may be closed by this pull request
bxyu-nvidia
bxyu-nvidia previously approved these changes Mar 2, 2026
Comment thread docs/about/concepts/core-components.md Outdated
Comment thread docs/about/concepts/training-approaches.md Outdated
Comment thread docs/about/index.md Outdated
Comment thread docs/about/index.md Outdated
…arity

Add new Training Approaches concept page explaining SFT vs RL, DPO,
GRPO, and the rise of RLVR. Restructure About overview with concrete
environment challenges and how NeMo Gym addresses each. Add "What is
an Environment?" intro to Core Components (renamed to Environment
Components). Reorder component presentation to Agent > Model > Resources
to follow rollout flow.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Create dedicated Agent Server page with rollout lifecycle pseudocode,
agent integration patterns (SimpleAgent, MiniSWEAgent), and tools
guidance. Streamline the Agent tab in Environment Components to a
concise overview linking to the new page. Add Agent Server to the
landing page grid and sidebar navigation.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Make explicit in both Environment Components and Agent Server pages
that the Agent is orchestration code which delegates all text
generation to the Model server. Addresses user confusion from #773.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Replace inline implementation list and config path with a concise
description and link to the dedicated Model Server page, matching
the pattern used by the Agent tab.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Create dedicated Resources Server overview page with pseudocode,
session management, tool implementations, verification logic, and
examples (workplace_assistant, math_with_code). Streamline the
Resources tab in Environment Components to match Agent/Model tabs.
Add Resources Server card and toctree entry to docs index.

Signed-off-by: Chris Wing <cwing@nvidia.com>
…onents

Remove tab-set, merge component descriptions into linked bullets,
and replace the architecture SVG with an ASCII diagram showing the
rollout lifecycle across Agent, Model, and Resources servers.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Add seealso linking to Model Server Fields in the configuration
reference, matching the pattern on Agent and Resources Server pages.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Add introductory paragraphs explaining the Model server's role
and middleware purpose, consistent with Agent and Resources Server
page structure.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Add rollout definition in GRPO context on training approaches page,
link What's Next to training tutorials, and add tip on training
tutorials page linking back to training approaches concepts.

Signed-off-by: Chris Wing <cwing@nvidia.com>
Remove the What's Next section from training-approaches since the
sidebar toctree already handles navigation between concept pages.
Minor wording fixes in core-components and about/index.

Signed-off-by: Chris Wing <cwing@nvidia.com>
@bxyu-nvidia bxyu-nvidia merged commit dbf4e7f into main Mar 2, 2026
6 checks passed
@bxyu-nvidia bxyu-nvidia deleted the cwing/concepts-improvements branch March 2, 2026 19:30
jsw-zorro pushed a commit to niletron/Gym that referenced this pull request Apr 7, 2026
…IDIA-NeMo#796)

## Summary

- Add Training Approaches page explaining SFT vs RL, DPO, GRPO, and RLVR
- Rename "Core Components" to "Environment Components" with a "What is
an Environment?" introduction and updated architecture diagram
- Create dedicated Agent Server, Resources Server pages with pseudocode
and examples
- Improve Model Server page with conceptual intro and consistent seealso
links to server config
- Streamline Environment Components page: replace tab-set with linked
bullets, replace SVG with ASCII diagram showing rollout lifecycle across
servers
- Improve About overview: replace motivation with more concrete
challenges, and more concrete details on how NeMo Gym addresses
- Add cross-links between training approaches, training tutorials, and
rollout collection
- Introduce rollout concept in GRPO section with glossary term reference

## Related Issues

- Addresses NVIDIA-NeMo#773 (Model vs Agent confusion)
- Partially addresses NVIDIA-NeMo#774 (rollout clarity and training cross-links)

## Test Plan

- [ ] Build docs locally and verify all new pages render correctly
- [ ] Verify all `{doc}`, `{ref}`, and `{term}` cross-links resolve
- [ ] Check environment diagram renders properly in code block

---------

Signed-off-by: Chris Wing <cwing@nvidia.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.

User confusion between Model vs Agent component

3 participants