Skip to content
Open
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
4 changes: 2 additions & 2 deletions docs/about/release-notes/current-release.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ For self-managed Kubernetes, start with
GRPO jobs also require Kubernetes/Ray, OpenSandbox-enabled Gym execution, and
job-storage PVC configuration; see
[GRPO and Reward Environments](/documentation/customizer-reference/grpo-and-reward-environments)
and [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/opensandbox).
and [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/open-sandbox).

## Upgrade from v0.4.x

Expand Down Expand Up @@ -230,6 +230,6 @@ nemo agents ethos migrate --name <agent-name>
- Issues: [https://github.com/NVIDIA-NeMo/nemo-platform/issues](https://github.com/NVIDIA-NeMo/nemo-platform/issues)
- GRPO and Reward Environments: [https://docs.nvidia.com/nemo-platform/documentation/customizer-reference/grpo-and-reward-environments](https://docs.nvidia.com/nemo-platform/documentation/customizer-reference/grpo-and-reward-environments)
- GRPO Environment Packages: [https://docs.nvidia.com/nemo-platform/documentation/customizer-reference/tutorials/grpo-environment-packages](https://docs.nvidia.com/nemo-platform/documentation/customizer-reference/tutorials/grpo-environment-packages)
- OpenSandbox setup: [https://docs.nvidia.com/nemo-platform/documentation/kubernetes-deployment/setup/helm/opensandbox](https://docs.nvidia.com/nemo-platform/documentation/kubernetes-deployment/setup/helm/opensandbox)
- OpenSandbox setup: [https://docs.nvidia.com/nemo-platform/documentation/kubernetes-deployment/setup/helm/open-sandbox](https://docs.nvidia.com/nemo-platform/documentation/kubernetes-deployment/setup/helm/open-sandbox)
- NeMo Fabric: [https://docs.nvidia.com/nemo/fabric/about-nemo-fabric/overview/](https://docs.nvidia.com/nemo/fabric/about-nemo-fabric/overview/)
- NeMo Agent Toolkit: [https://docs.nvidia.com/nemo/agent-toolkit/latest/](https://docs.nvidia.com/nemo/agent-toolkit/latest/)
2 changes: 1 addition & 1 deletion docs/about/release-notes/release-0-3-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ See [Setup](/documentation/get-started) for prerequisites and provider
configuration.

For self-managed Kubernetes, start with
[Install NeMo Platform Helm Chart](/documentation/self-managed-deployment/setup/helm/install).
[Install NeMo Platform Helm Chart](/documentation/kubernetes-deployment/setup/helm/install).

## Upgrade from v0.2.x

Expand Down
2 changes: 1 addition & 1 deletion docs/agents/deploy-agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ models:
```

To make an external model available to the agent, register a provider first —
see [Deploy Models](/documentation/models-and-inference/tutorials/deploy-models#add-external-providers)
see [Deploy Models](/documentation/models-and-inference/deploy-models#add-external-providers)
for NVIDIA Build, OpenAI, and Anthropic examples.

<Note>
Expand Down
2 changes: 1 addition & 1 deletion docs/customizer/grpo-training.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ GRPO fails at submit, before any GPU is claimed, unless the platform operator ha

If a submit fails on either of the first two, that is a platform configuration gap, not a problem with your package. Neither is settable per job.

Installing OpenSandbox is a separate operator task: [OpenSandbox](/documentation/self-managed-deployment/setup/helm/opensandbox), or [OpenSandbox with Kata](/documentation/self-managed-deployment/setup/helm/opensandbox-kata) for the Kata runtime.
Installing OpenSandbox is a separate operator task: [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/open-sandbox), or [OpenSandbox with Kata](/documentation/kubernetes-deployment/setup/helm/opensandbox-kata) for the Kata runtime.

## Next Steps

Expand Down
4 changes: 2 additions & 2 deletions docs/customizer/tutorials/grpo-environment-packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Do not put `.jsonl` in the environment package. If a Gym config lists `datasets[
Before packaging an environment, ensure you have:

1. **A NeMo Platform configured with `platform.runtime: kubernetes`** — GRPO provisions a Ray cluster and has no local Docker fallback
2. **Sandboxed Gym enabled on the cluster** by your platform operator (`sandbox_cluster_capable` and a job-storage PVC claim). Refer to [Cluster prerequisites](/documentation/customizer-reference/grpo-and-reward-environments#cluster-prerequisites); installing OpenSandbox is covered in [OpenSandbox](/documentation/self-managed-deployment/setup/helm/opensandbox)
2. **Sandboxed Gym enabled on the cluster** by your platform operator (`sandbox_cluster_capable` and a job-storage PVC claim). Refer to [Cluster prerequisites](/documentation/customizer-reference/grpo-and-reward-environments#cluster-prerequisites); installing OpenSandbox is covered in [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/open-sandbox)
3. **The `nemo` CLI on your `PATH`**, or a source checkout where `uv run --package nmp-rl` resolves
4. **The training image tag** your cluster runs — vendoring a wheel closure requires the `nemo-gym`, `ray`, and `openai` versions it reports
5. **A machine with internet access** for the packaging step. Training clusters consume uploaded FileSets only. For details on which environment type require internet access too, see details below.
Expand Down Expand Up @@ -431,7 +431,7 @@ nemo files upload ./weather-env/ weather-env --workspace default
nemo files list weather-env --workspace default
```

Job JSON: [GRPO and Reward Environments](/documentation/customizer-reference/grpo-and-reward-environments#submit-the-job). Sandboxed Gym is configured on the platform (`NMP_RL_SANDBOXED_GYM_DEFAULT`), not in the job payload. Cluster setup: [OpenSandbox](/documentation/self-managed-deployment/setup/helm/opensandbox).
Job JSON: [GRPO and Reward Environments](/documentation/customizer-reference/grpo-and-reward-environments#submit-the-job). Sandboxed Gym is configured on the platform (`NMP_RL_SANDBOXED_GYM_DEFAULT`), not in the job payload. Cluster setup: [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/open-sandbox).

## Next Steps

Expand Down
32 changes: 32 additions & 0 deletions docs/fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,35 @@ redirects:
# Sphinx page URLs (foo.html); must follow all :path*/index.html rules above
- source: "/:path*.html"
destination: "/:path*"
# NV 6722631: OpenSandbox how-to live slug is open-sandbox.
- source: "/documentation/self-managed-deployment/setup/helm/opensandbox"
destination: "/documentation/kubernetes-deployment/setup/helm/open-sandbox"
- source: "/latest/documentation/self-managed-deployment/setup/helm/opensandbox"
destination: "/latest/documentation/kubernetes-deployment/setup/helm/open-sandbox"
- source: "/documentation/kubernetes-deployment/setup/helm/opensandbox"
destination: "/documentation/kubernetes-deployment/setup/helm/open-sandbox"
- source: "/latest/documentation/kubernetes-deployment/setup/helm/opensandbox"
destination: "/latest/documentation/kubernetes-deployment/setup/helm/open-sandbox"
# NV 6722623: published hrefs still use the old self-managed-deployment nav slug.
- source: "/documentation/self-managed-deployment/helm"
destination: "/documentation/kubernetes-deployment/setup/helm"
- source: "/latest/documentation/self-managed-deployment/helm"
destination: "/latest/documentation/kubernetes-deployment/setup/helm"
- source: "/documentation/self-managed-deployment/:path*"
destination: "/documentation/kubernetes-deployment/:path*"
- source: "/latest/documentation/self-managed-deployment/:path*"
destination: "/latest/documentation/kubernetes-deployment/:path*"
# NV 6722632: Models and Inference pages are no longer under /tutorials/.
- source: "/documentation/models-and-inference/tutorials/run-inference"
destination: "/documentation/models-and-inference/run-inference"
- source: "/latest/documentation/models-and-inference/tutorials/run-inference"
destination: "/latest/documentation/models-and-inference/run-inference"
- source: "/documentation/models-and-inference/tutorials/deploy-models"
destination: "/documentation/models-and-inference/deploy-models"
- source: "/latest/documentation/models-and-inference/tutorials/deploy-models"
destination: "/latest/documentation/models-and-inference/deploy-models"
# NV 6722634: Plugin UIs title otherwise kebab-cases to plugin-u-is.
- source: "/documentation/studio/plugin-u-is"
destination: "/documentation/studio/plugins"
- source: "/latest/documentation/studio/plugin-u-is"
destination: "/latest/documentation/studio/plugins"
28 changes: 25 additions & 3 deletions docs/fern/scripts/sync-helm-docs.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,29 @@ const DROP_LINE =
/^Documentation can be found at: https:\/\/docs\.nvidia\.com\/nemo-platform\.\s*$/;

const DEPLOYMENT_LINK =
/For deployment instructions, see https:\/\/docs\.nvidia\.com\/nemo-platform\/documentation\/self-managed-deployment\/setup\./;
/For deployment instructions, see https:\/\/docs\.nvidia\.com\/nemo-platform\/(?:latest\/)?documentation\/(?:self-managed-deployment|kubernetes-deployment)\/setup\.?/;

const DEPLOYMENT_LINK_REPLACEMENT =
"For deployment guide, see " +
"[Self-Managed Deployment](/documentation/self-managed-deployment/setup) " +
"[Kubernetes Deployment](/documentation/kubernetes-deployment/setup) " +
"in the NeMo Platform documentation.";

const EXAMPLES_OVERLAY_LINK = /\[examples\/opensandbox\]\(examples\/opensandbox\)/;
const EXAMPLES_OVERLAY_REPLACEMENT =
"[k8s/helm/examples/opensandbox](https://github.com/NVIDIA-NeMo/nemo-platform/tree/main/k8s/helm/examples/opensandbox)";

function rewritePublishedDocsUrls(text) {
return text
.replace(
/\/documentation\/self-managed-deployment\//g,
"/documentation/kubernetes-deployment/",
)
.replace(
/(\/documentation\/kubernetes-deployment\/setup\/helm\/)opensandbox(?!-kata)/g,
"$1open-sandbox",
);
}

function stripLeadingSpdxComments(markdown) {
const lines = markdown.split("\n");

Expand Down Expand Up @@ -68,7 +84,13 @@ function extractIntro(readme) {

if (DROP_LINE.test(line)) continue;

out.push(line.replace(DEPLOYMENT_LINK, DEPLOYMENT_LINK_REPLACEMENT));
out.push(
rewritePublishedDocsUrls(
line
.replace(DEPLOYMENT_LINK, DEPLOYMENT_LINK_REPLACEMENT)
.replace(EXAMPLES_OVERLAY_LINK, EXAMPLES_OVERLAY_REPLACEMENT),
),
);
}

while (out.length && !out[out.length - 1].trim()) out.pop();
Expand Down
3 changes: 2 additions & 1 deletion docs/fern/versions/latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,7 @@ navigation:
- page: Monitor
path: ../../studio/monitor.mdx
- page: Plugin UIs
slug: plugins
path: ../../studio/plugins.mdx
- page: Guardrail Configs
path: ../../studio/guardrails.mdx
Expand Down Expand Up @@ -403,7 +404,7 @@ navigation:
- page: Volcano
path: ../../set-up/helm/volcano.mdx
- page: OpenSandbox
slug: opensandbox
slug: open-sandbox
path: ../../set-up/helm/opensandbox.mdx
- page: OpenSandbox with Kata
slug: opensandbox-kata
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,4 @@ client.inference.virtual_models.delete(name="guarded-with-defaults")
- [Architecture](/documentation/guardrail-models/core-concepts/architecture) — Understand the middleware pipeline and VirtualModel wiring
- [Configuration Structure](/documentation/guardrail-models/core-concepts/configurations/configuration-structure) — Configuration schema reference
- [Manage Configurations](/documentation/guardrail-models/core-concepts/configurations/manage-configurations) — Create and manage your own configurations
- [Run Inference](/documentation/models-and-inference/tutorials/run-inference) — Run inference with a guardrail configuration
- [Run Inference](/documentation/models-and-inference/run-inference) — Run inference with a guardrail configuration
1 change: 1 addition & 0 deletions docs/run-inference/tutorials/deploy-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Resource names for deployments, deployment configs, and providers must contain o
<Markdown src="/snippets/_snippets/tutorials/cli-sdk-setup.mdx" />
---

<a id="add-external-providers"></a>
## Add External Providers

Register external inference APIs like NVIDIA Build or OpenAI.
Expand Down
2 changes: 1 addition & 1 deletion docs/run-inference/tutorials/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Learn how to run inference through the NeMo Platform.

## Guides

- [Run Inference](/documentation/models-and-inference/tutorials/run-inference) — Route requests via model entity, provider, or OpenAI routing
- [Run Inference](/documentation/models-and-inference/run-inference) — Route requests via model entity, provider, or OpenAI routing
4 changes: 2 additions & 2 deletions docs/set-up/helm/file-storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If using S3 storage, you must provision and manage your own bucket and credentia

## Local Storage (Default)

By default, the Files service uses local filesystem storage. Files are stored on the shared PVC configured in [Persistent Volumes](/documentation/self-managed-deployment/setup/helm/persistent-volumes).
By default, the Files service uses local filesystem storage. Files are stored on the shared PVC configured in [Persistent Volumes](/documentation/kubernetes-deployment/setup/helm/persistent-volumes).

The default configuration is equivalent to:

Expand All @@ -34,7 +34,7 @@ platformConfig:
path: /vol/files
```

You do not need to add this to your `values.yaml`. Once the PVC is set up as described in [Persistent Volumes](/documentation/self-managed-deployment/setup/helm/persistent-volumes), local storage works out of the box.
You do not need to add this to your `values.yaml`. Once the PVC is set up as described in [Persistent Volumes](/documentation/kubernetes-deployment/setup/helm/persistent-volumes), local storage works out of the box.

## S3 Object Storage

Expand Down
28 changes: 14 additions & 14 deletions docs/set-up/helm/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,95 +9,95 @@ description: ""

NeMo Platform is bundled in an all-in-one Helm chart for self-managed Kubernetes deployments. Use these guides to deploy the platform on local clusters such as minikube and kind, managed clusters such as EKS, AKS, GKE, and OKE, or on-prem Kubernetes.

Start with [Prerequisites](/documentation/self-managed-deployment/setup/helm/prerequisites), then follow [Install](/documentation/self-managed-deployment/setup/helm/install). The install guide pins the chart with `NMP_HELM_CHART_VERSION` and uses the `nvidia/nemo-platform` NGC org for chart and image access.
Start with [Prerequisites](/documentation/kubernetes-deployment/setup/helm/prerequisites), then follow [Install](/documentation/kubernetes-deployment/setup/helm/install). The install guide pins the chart with `NMP_HELM_CHART_VERSION` and uses the `nvidia/nemo-platform` NGC org for chart and image access.

<Cards>

<Card title="Prerequisites" href="/documentation/self-managed-deployment/setup/helm/prerequisites">
<Card title="Prerequisites" href="/documentation/kubernetes-deployment/setup/helm/prerequisites">

Review the prerequisites for installing the NeMo Platform Helm Chart.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="Install" href="/documentation/self-managed-deployment/setup/helm/install">
<Card title="Install" href="/documentation/kubernetes-deployment/setup/helm/install">

Install the NeMo Platform using the Helm chart.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="NetworkPolicy Smoke Test" href="/documentation/self-managed-deployment/setup/helm/network-policy-smoke-test">
<Card title="NetworkPolicy Smoke Test" href="/documentation/kubernetes-deployment/setup/helm/network-policy-smoke-test">

Verify Helm NetworkPolicies on a local Kind cluster with Calico and Chainsaw.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">kind</span> <span class="md-tag">networking</span></small>

</Card>
<Card title="Database Setup" href="/documentation/self-managed-deployment/setup/helm/database-setup">
<Card title="Database Setup" href="/documentation/kubernetes-deployment/setup/helm/database-setup">

Set up an external database for the NeMo Platform.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Ingress" href="/documentation/self-managed-deployment/setup/helm/ingress">
<Card title="Ingress" href="/documentation/kubernetes-deployment/setup/helm/ingress">

Set up Ingress for the NeMo Platform.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Persistent Volumes" href="/documentation/self-managed-deployment/setup/helm/persistent-volumes">
<Card title="Persistent Volumes" href="/documentation/kubernetes-deployment/setup/helm/persistent-volumes">

Set up persistent volumes for the NeMo Platform.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="File Storage" href="/documentation/self-managed-deployment/setup/helm/file-storage">
<Card title="File Storage" href="/documentation/kubernetes-deployment/setup/helm/file-storage">

Configure storage options for the Files service.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Multinode Networking" href="/documentation/self-managed-deployment/setup/helm/multinode-networking">
<Card title="Multinode Networking" href="/documentation/kubernetes-deployment/setup/helm/multinode-networking">

Configure high-performance east-west networking (EFA, InfiniBand, TCP-XO, SR-IOV) for multi-node training.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Volcano" href="/documentation/self-managed-deployment/setup/helm/volcano">
<Card title="Volcano" href="/documentation/kubernetes-deployment/setup/helm/volcano">

Install the Volcano scheduler for multi-node jobs. The chart does not install Volcano.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="OpenSandbox" href="/documentation/self-managed-deployment/setup/helm/opensandbox">
<Card title="OpenSandbox" href="/documentation/kubernetes-deployment/setup/helm/open-sandbox">

Install OpenSandbox with the shared-kernel / default runtime path and point jobs at the in-cluster server.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="OpenSandbox with Kata" href="/documentation/self-managed-deployment/setup/helm/opensandbox-kata">
<Card title="OpenSandbox with Kata" href="/documentation/kubernetes-deployment/setup/helm/opensandbox-kata">

Install Kata Containers and an OpenSandbox server that uses RuntimeClass kata-qemu.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="OpenShift" href="/documentation/self-managed-deployment/setup/helm/openshift">
<Card title="OpenShift" href="/documentation/kubernetes-deployment/setup/helm/openshift">

Install with OpenShift-compatible configuration.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">openshift</span></small>

</Card>
<Card title="Backup and Restore" href="/documentation/self-managed-deployment/setup/helm/backup-and-restore">
<Card title="Backup and Restore" href="/documentation/kubernetes-deployment/setup/helm/backup-and-restore">

Set up backup and restore configurations for the NeMo Platform.

Expand Down
Loading
Loading