diff --git a/docs/contribute/index.md b/docs/contribute/index.md new file mode 100644 index 000000000..d4ec63d29 --- /dev/null +++ b/docs/contribute/index.md @@ -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` +::: + +:::: + diff --git a/docs/training/rl-framework-integration/generation-backend-and-openai-compatible-http-server.md b/docs/contribute/rl-framework-integration/generation-backend-and-openai-compatible-http-server.md similarity index 100% rename from docs/training/rl-framework-integration/generation-backend-and-openai-compatible-http-server.md rename to docs/contribute/rl-framework-integration/generation-backend-and-openai-compatible-http-server.md diff --git a/docs/training/rl-framework-integration/gym-integration-footprint-and-form-factor.md b/docs/contribute/rl-framework-integration/gym-integration-footprint-and-form-factor.md similarity index 100% rename from docs/training/rl-framework-integration/gym-integration-footprint-and-form-factor.md rename to docs/contribute/rl-framework-integration/gym-integration-footprint-and-form-factor.md diff --git a/docs/training/rl-framework-integration/gym-rl-framework-integration-success-criteria.md b/docs/contribute/rl-framework-integration/gym-rl-framework-integration-success-criteria.md similarity index 100% rename from docs/training/rl-framework-integration/gym-rl-framework-integration-success-criteria.md rename to docs/contribute/rl-framework-integration/gym-rl-framework-integration-success-criteria.md diff --git a/docs/training/rl-framework-integration/index.md b/docs/contribute/rl-framework-integration/index.md similarity index 95% rename from docs/training/rl-framework-integration/index.md rename to docs/contribute/rl-framework-integration/index.md index 884f555be..804f34c10 100644 --- a/docs/training/rl-framework-integration/index.md +++ b/docs/contribute/rl-framework-integration/index.md @@ -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 diff --git a/docs/training/rl-framework-integration/openai-compatible-http-server-on-policy-correction.md b/docs/contribute/rl-framework-integration/openai-compatible-http-server-on-policy-correction.md similarity index 100% rename from docs/training/rl-framework-integration/openai-compatible-http-server-on-policy-correction.md rename to docs/contribute/rl-framework-integration/openai-compatible-http-server-on-policy-correction.md diff --git a/docs/index.md b/docs/index.md index d193fb65f..835f79d5b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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} @@ -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 +Integrate RL Frameworks ``` - ```{toctree} :caption: Reference :hidden: diff --git a/docs/training/index.md b/docs/training/index.md index 68290bf03..ff83042e2 100644 --- a/docs/training/index.md +++ b/docs/training/index.md @@ -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.