Skip to content

[codex] Add sandbox API docs guide#1717

Open
hemildesai wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
hemildesai:codex/opensandbox-coverage-tests
Open

[codex] Add sandbox API docs guide#1717
hemildesai wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
hemildesai:codex/opensandbox-coverage-tests

Conversation

@hemildesai

Copy link
Copy Markdown
Contributor

Summary

  • Add a Fern guide for the provider-neutral nemo_gym.sandbox API.
  • Link the guide from the Infrastructure docs and include nemo_gym.sandbox in the API reference index.
  • Adjust Engineering Notes ordering so the new Sandbox API page appears in the Infrastructure section.

Validation

  • npm run check -- --warnings passed with 0 errors.
  • Remaining Fern warning: redirects check skipped because the local session is not authenticated with Fern.

@copy-pr-bot

copy-pr-bot Bot commented Jun 24, 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.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown

@hemildesai hemildesai force-pushed the codex/opensandbox-coverage-tests branch from f007617 to a5a4d52 Compare June 24, 2026 20:40
@cwing-nvidia

Copy link
Copy Markdown
Contributor

Given we will be adding a number of providers, can we update to a parent-child content structure:

infrastructure/sandbox/index.mdx — provider-neutral overview: when to use it, core types, lifecycle, sync vs async, SandboxSpec fields, file transfer, status/cleanup, error handling, a local first-run example. This is the part every user reads.

infrastructure/sandbox/opensandbox.mdx — OpenSandbox-specific: connection/create/probe/operations config, provider_options, resource→k8s mapping, isolation/security properties, the mini_swe_agent_2 YAML + ng_run command, and OpenSandbox troubleshooting rows.

(ECS Fargate, Apptainer, OpenShell etc providers will each have their own child page)

infrastructure/sandbox/adding-a-provider.mdx — the SandboxProvider protocol + registry.py contributor guide.

Each new provider from #1685 then drops in as one more child page with the same shape (setup / config / isolation properties / example)


## YAML Configuration

The exact YAML location is agent-specific. Agents that use this module should expose provider settings and spec settings in their Gym config, then map those values into `AsyncSandbox` and `SandboxSpec`.

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.

i thought @ananthsub 's PR had decoupled this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes removed for now. Will add a configuration guide after Ananth's PR is merged

@hemildesai hemildesai force-pushed the codex/opensandbox-coverage-tests branch 3 times, most recently from 09842bc to 2f96191 Compare June 25, 2026 19:01
@hemildesai hemildesai marked this pull request as ready for review June 25, 2026 19:03
Signed-off-by: Hemil Desai <hemild@nvidia.com>
@hemildesai hemildesai force-pushed the codex/opensandbox-coverage-tests branch from 2f96191 to 86e1839 Compare June 25, 2026 19:22
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.

2 participants