Skip to content

docs: reformat ecosystem page to template shape - #1579

Merged
lbliii merged 5 commits into
mainfrom
lbliii/ecosystem-doc-template
Jun 29, 2026
Merged

lbliii merged 5 commits into
mainfrom
lbliii/ecosystem-doc-template

Conversation

@lbliii

@lbliii lbliii commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

What

Reformats the About β†’ Ecosystem page (fern/versions/latest/pages/about/ecosystem.mdx) around the NVIDIA docs ecosystem page template shape.

Note

This is an initial pass at standardizing around the ecosystem page template's recommended shape. The structure is in place β€” we can still massage the actual content/wording if desired.

Template elements applied

  • Positioning intro β€” places NeMo Gym within the NVIDIA NeMo platform and against its closest siblings.
  • <Tip> cross-reference β€” links to the Overview, "What NeMo Gym Provides", and Architecture pages (all targets verified to resolve).
  • ## NeMo Gym Within NVIDIA NeMo β€” describes the platform, lists sibling libraries, and states NeMo Gym's role.
  • ## Choosing Between NeMo Gym and NeMo Evaluator β€” comparison table for the two most-confused libraries (contrasts focus only; no negative claims).
  • ## Related Products in the NVIDIA NeMo Ecosystem β€” renamed from "Related NeMo Libraries"; existing Data / Evaluation & Training / Deployment tables preserved.
  • Stripped template author-only scaffolding (@tpl: comments, format-selection accordion).

Preserved

All existing integration content is kept verbatim: Environment Libraries, Training Framework Libraries, Agent Harnesses, the contribution invite, and the related-library tables.

Fern adaptations

  • No body # H1 β€” the About pages derive the H1/nav label from frontmatter title: (title-source: frontmatter), so the template's literal H1 lives in title:/intro instead. Kept title: "Ecosystem" to preserve the nav label and /about/ecosystem URL.
  • latest/ only β€” frozen GA snapshots (v0.3.0/, v0.2.1/) untouched per docs policy.

Validation

  • fern check β†’ All checks passed
  • Content accuracy-audited against CLAUDE.md and the about pages; product-capability claims tightened to match (Gym does SFT and RL; supports single-step as well as multi-turn environments).

πŸ€– Generated with Claude Code

Restructure the About > Ecosystem page around the NVIDIA docs
ecosystem page template: positioning intro, a cross-reference Tip,
a 'NeMo Gym Within NVIDIA NeMo' section with sibling libraries and
Gym's role, a 'Choosing Between NeMo Gym and NeMo Evaluator'
comparison, and a renamed 'Related Products' reference section.
All existing integration content (Environment Libraries, Training
Framework Libraries, Agent Harnesses, related-library tables) is
preserved.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
@github-actions

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://nvidia-preview-lbliii-ecosystem-doc-template.docs.buildwithfern.com/nemo/gym

Here are the markdown pages you've updated:

@sephmard sephmard added the documentation Improvements to documentation label Jun 26, 2026
@sephmard
sephmard self-requested a review June 29, 2026 14:12

@sephmard sephmard left a comment

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.

Accurate β€” no changes needed:

  • Intro paragraph: "pairing a dataset, agent harness, and verifier so the same environment can drive both evaluation and training" β€” technically correct. A Gym environment is a resources server (dataset + verifier) paired with an agent harness.
  • "NeMo Gym's role" paragraph: Accurate. Standardizing the agent harness, verifier, and session isolation is exactly what Gym does.
  • cross-links: All three resolve β€” /about, /about#what-nemo-gym-provides (heading confirmed), /about/architecture.
  • NeMo RL description: "Runs scalable post-training (GRPO, DPO, and SFT)" β€” correct.
  • NeMo Curator description: "Prepares, filters, and deduplicates training data at scale" β€” correct.

Needs changes β€” Evaluator mentions to remove:

There are three places, not just the table:

  1. Intro paragraph β€” "While NeMo RL handles post-training and NeMo Evaluator runs benchmark evaluations..." β€” the Evaluator mention needs to come out here too.
  2. "NeMo Gym Within NVIDIA NeMo" bullet list β€” the NeMo Evaluator bullet needs to be removed.
  3. Comparison table β€” remove the entire section.

The Related Products table at the bottom already lists NeMo Evaluator as a plain row, which is fine β€” that's just a reference list, not a positioning claim.

One minor flag worth a comment:
The "NeMo Gym Within NVIDIA NeMo" section lists libraries in a pipeline order (Curator β†’ Gym β†’ NeMo RL β†’ Evaluator). Once Evaluator is removed, the ordering still makes sense (Curator β†’ Gym β†’ NeMo RL) and doesn't need further changes.

- **NeMo Curator**: Prepares, filters, and deduplicates training data at scale.
- **NeMo Gym**: Defines the environments β€” dataset, agent harness, and verifier β€” that agents are evaluated and trained in *(this library)*.
- **NeMo RL**: Runs scalable post-training (GRPO, DPO, and SFT) against those environments.
- **NeMo Evaluator**: Benchmarks model quality across standard evaluations.

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.

Delete. Recommend removing this mention, as it is confusing. We are consolidating the Evaluator functionality directly into Gym.


Readers often compare these libraries because both touch evaluation, but they solve nearby problems at different layers.

| Aspect | NeMo Gym | NeMo Evaluator |

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.

Delete mention of Evaluator. Recommend removing this mention, as it is confusing. We are consolidating the Evaluator functionality directly into Gym.


**NeMo Gym's role**: NeMo Gym is where a task becomes an interactive environment. It standardizes how an agent interacts with the world (the agent harness), how task completion is scored (the verifier), and how per-task state is isolated β€” producing the rollouts and reward signals that training frameworks like NeMo RL consume, and the consistent scoring that evaluation depends on.

## Choosing Between NeMo Gym and NeMo Evaluator

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.

We should remove this whole section - we want to ensure its clear that Gym is available for first-class evaluation workflows

Signed-off-by: Lawrence Lane <llane@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 29, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@lbliii
lbliii requested a review from sephmard June 29, 2026 15:16
## Related Products in the NVIDIA NeMo Ecosystem

Depending on your workflow, you may also find these libraries useful:
Depending on your workflow, you may also find these NeMo libraries useful across data preparation, evaluation and training, and deployment.

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.

We removed Evaluator in favor of positioning Gym. But we still mention evaluation can be found in other NeMo libraries. Consider removing.

@sephmard sephmard left a comment

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.

One suggested change in comments. But approving as it otherwise looks good.

@lbliii
lbliii enabled auto-merge (squash) June 29, 2026 18:02
@lbliii
lbliii merged commit 3b6b456 into main Jun 29, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants