Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions docs/contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
(contribute-index)=

# Contribute to NeMo Gym

Guides for contributing to the NeMo Gym project.

---

::::{grid} 1 1 1 1
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`workflow;1.5em;sd-mr-1` Integrate Gym into RL Frameworks
:link: training-framework-integration
:link-type: ref
Implement NeMo Gym integration into a new training framework.
+++
{bdg-primary}`advanced` {bdg-secondary}`infra`
:::

::::

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This section covers how to integrate NeMo Gym into a new training framework. This content is for expert users who cannot use existing training framework integrations and need to implement their own.

:::{note}
Most users should use an existing integration such as NeMo RL. Refer to these guides only if you are developing a custom RL training framework or need to understand the integration requirements.
Most users should use an existing integration such as NeMo RL. Refer to these guides only if you are integrating an RL training framework or need to understand the integration requirements.
:::

## Prerequisites
Expand Down
24 changes: 20 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,23 @@ Train with GRPO using NeMo RL and NeMo Gym.

::::

## Contribute

Contribute to NeMo Gym development.

::::{grid} 1 2 2 2
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`workflow;1.5em;sd-mr-1` Integrate Gym into RL Frameworks
:link: contribute/rl-framework-integration/index
:link-type: doc
Implement NeMo Gym integration into a new training framework.
+++
{bdg-primary}`advanced`
:::

::::

---

```{toctree}
Expand Down Expand Up @@ -180,15 +197,14 @@ tutorials/rl-training-with-nemo-rl
```

```{toctree}
:caption: Training
:caption: Contribute
:hidden:
:maxdepth: 1

training/index
training/rl-framework-integration/index.md
Overview <contribute/index>
Integrate RL Frameworks <contribute/rl-framework-integration/index>
```


```{toctree}
:caption: Reference
:hidden:
Expand Down
21 changes: 5 additions & 16 deletions docs/training/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
(training-index)=

# Training with NeMo Gym

Conceptual guides for training with NeMo Gym.

---
orphan: true
---

::::{grid} 1 1 1 1
:gutter: 1 1 1 2
(training-index)=

:::{grid-item-card} {octicon}`workflow;1.5em;sd-mr-1` Integrate Gym into RL frameworks
:link: training-framework-integration
:link-type: ref
Implement NeMo Gym integration into a new training framework.
+++
{bdg-primary}`training` {bdg-secondary}`infra`
:::
# Training with NeMo Gym

::::
Coming soon.