Skip to content

docs(optimization): add docker sandbox patterns for isolating experimentalist - #1084

Merged
BrianNewsom merged 5 commits into
mainfrom
pr-1034-sandbox
Aug 4, 2026
Merged

docs(optimization): add docker sandbox patterns for isolating experimentalist#1084
BrianNewsom merged 5 commits into
mainfrom
pr-1034-sandbox

Conversation

@BrianNewsom

@BrianNewsom BrianNewsom commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • recommend Docker Sandboxes for laptop Experimentalist runs
  • invoke the Tau3 example directly through sbx exec
  • document host-service routing and the Apple Silicon Terminal-Bench limitation

Test plan

  • Run the Tau3 benchmark and agent end to end inside a Docker Sandbox
  • Run make docs-check

Summary by CodeRabbit

  • Documentation
    • Updated Experimentalist setup guidance with Docker Engine and Docker Sandboxes prerequisites.
    • Added instructions for isolated execution, environment variables, datasets, proxy settings, security considerations, and host services.
    • Documented artifact inspection, sandbox lifecycle commands, network requirements, and Apple Silicon limitations.

nicot and others added 4 commits July 31, 2026 16:02
Document an isolated laptop workflow while preserving the current architecture caveat.

Signed-off-by: Nico Tonozzi <ntonozzi@nvidia.com>
Signed-off-by: Brian Newsom <brnewsom@nvidia.com>
Signed-off-by: Brian Newsom <brnewsom@nvidia.com>

# Conflicts:
#	docs/get-started/example-agent.mdx
#	plugins/nemo-experimentalist/README.md
Signed-off-by: Brian Newsom <brnewsom@nvidia.com>
@BrianNewsom
BrianNewsom requested review from a team as code owners August 4, 2026 20:59
@github-actions github-actions Bot added the feat label Aug 4, 2026
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation replaces direct host execution with Docker Sandbox execution for the Experimentalist. It adds versioned prerequisites, environment forwarding, host service access, security limitations, artifact handling, and sandbox lifecycle commands.

Changes

Experimentalist Sandbox Documentation

Layer / File(s) Summary
Sandbox prerequisites and execution setup
docs/get-started/example-agent.mdx, plugins/nemo-experimentalist/README.md
Documents Docker Engine and Docker Sandboxes requirements. Adds commands to create and run the Experimentalist in clone mode with forwarded settings and host service access.
Connectivity and isolation constraints
docs/get-started/example-agent.mdx, plugins/nemo-experimentalist/README.md
Describes outbound connectivity, environment separation, platform constraints, and clone-mode visibility limits.
Artifact inspection and sandbox lifecycle
docs/get-started/example-agent.mdx
Adds commands to inspect and copy artifacts, then stop or remove the sandbox.

Possibly related PRs

Suggested labels: docs

Suggested reviewers: aleckhoury, sandychapman

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change and its Docker Sandbox isolation purpose for Experimentalist runs.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pr-1034-sandbox

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/get-started/example-agent.mdx`:
- Around line 178-181: Add a final “## Next Steps” section to the tutorial after
the existing sbx cleanup commands, including canonical Fern links to relevant
related guides. Ensure this section is the last content in the page and follows
the documentation cross-linking guidelines.
- Around line 167-172: Add concrete sbx commands in
docs/get-started/example-agent.mdx lines 167-172 to inspect run.json, compare
the agent-0 and agent-1 directories, and copy retained artifacts from the
sandbox to the host. In plugins/nemo-experimentalist/README.md lines 99-104, add
the artifact-copy command or link to the complete guide.
- Around line 156-164: Require a sanitized checkout in both documented flows:
update docs/get-started/example-agent.mdx lines 156-164 and
plugins/nemo-experimentalist/README.md lines 88-97 to ensure unrelated secrets
are absent from the Git root before sandbox creation, and keep credentials
outside the repository when needed. Preserve the existing warning while
documenting this requirement for each flow.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 4bbce0ce-7edc-48cc-b262-aff99a847e28

📥 Commits

Reviewing files that changed from the base of the PR and between f45c965 and d5970a2.

📒 Files selected for processing (2)
  • docs/get-started/example-agent.mdx
  • plugins/nemo-experimentalist/README.md

Comment thread docs/get-started/example-agent.mdx
Comment thread docs/get-started/example-agent.mdx Outdated
Comment thread docs/get-started/example-agent.mdx
Signed-off-by: Brian Newsom <brnewsom@nvidia.com>
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 30406/38435 79.1% 63.8%
Integration Tests 18006/37104 48.5% 21.0%

@BrianNewsom BrianNewsom changed the title feat(optimization): add docker sandbox patterns for isolating experimentalist docs(optimization): add docker sandbox patterns for isolating experimentalist Aug 4, 2026
@github-actions github-actions Bot added the docs label Aug 4, 2026
@BrianNewsom
BrianNewsom added this pull request to the merge queue Aug 4, 2026
Merged via the queue into main with commit dfc602d Aug 4, 2026
56 checks passed
@BrianNewsom
BrianNewsom deleted the pr-1034-sandbox branch August 4, 2026 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants