docs: clarify inference sandbox prerequisite - #6152
Merged
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughUpdated documentation for switching inference providers: revised front-matter description text and expanded the Prerequisites section to clarify that a selected/resumed sandbox (or ChangesDocumentation clarification
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
E2E Target RecommendationRequired E2E targets: None Full E2E target advisor summaryE2E Target AdvisorBase: Required E2E targets
Optional E2E targets
Relevant changed files
|
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-6152.docs.buildwithfern.com/nemoclaw |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/inference/switch-inference-providers.mdx`:
- Around line 21-29: Update the prerequisite text in the
switch-inference-providers docs so the `--sandbox <name>` option is described as
necessary whenever no default sandbox is selected, not only when multiple
sandboxes are registered. Adjust the wording near the NemoClaw onboarding and
`inference set` guidance to match the behavior described by the existing Note,
using the same `$$nemoclaw inference set` and `$$nemoclaw onboard` references.
🪄 Autofix (Beta)
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: 3f5a28d7-0fa7-4a8b-a004-292ef9154c98
📒 Files selected for processing (1)
docs/inference/switch-inference-providers.mdx
Comment on lines
+21
to
+29
| - A running NemoClaw sandbox created or resumed with `$$nemoclaw onboard`. | ||
| - A selected default sandbox, or pass `--sandbox <name>` to each `$$nemoclaw inference set` command when more than one sandbox is registered. | ||
| - The OpenShell CLI on your `PATH`, which NemoClaw uses internally. | ||
|
|
||
| <Note> | ||
| If you run `$$nemoclaw inference set` before NemoClaw has a selected sandbox, the CLI exits with `No sandbox selected`. | ||
| Run `$$nemoclaw onboard` first, then retry the switch. | ||
| </Note> | ||
|
|
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Broaden the --sandbox prerequisite wording.
This says --sandbox <name> is only needed when more than one sandbox is registered, but inference set also fails when no default sandbox is selected at all. Users can hit that path with a single sandbox too, so this should say --sandbox <name> is available whenever no default is set.
Suggested wording tweak
-- A selected default sandbox, or pass `--sandbox <name>` to each `nemoclaw inference set` command when more than one sandbox is registered.
+- A selected default sandbox, or pass `--sandbox <name>` to each `nemoclaw inference set` command when no default sandbox is selected.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - A running NemoClaw sandbox created or resumed with `$$nemoclaw onboard`. | |
| - A selected default sandbox, or pass `--sandbox <name>` to each `$$nemoclaw inference set` command when more than one sandbox is registered. | |
| - The OpenShell CLI on your `PATH`, which NemoClaw uses internally. | |
| <Note> | |
| If you run `$$nemoclaw inference set` before NemoClaw has a selected sandbox, the CLI exits with `No sandbox selected`. | |
| Run `$$nemoclaw onboard` first, then retry the switch. | |
| </Note> | |
| - A running NemoClaw sandbox created or resumed with `$$nemoclaw onboard`. | |
| - A selected default sandbox, or pass `--sandbox <name>` to each `$$nemoclaw inference set` command when no default sandbox is selected. | |
| - The OpenShell CLI on your `PATH`, which NemoClaw uses internally. | |
| <Note> | |
| If you run `$$nemoclaw inference set` before NemoClaw has a selected sandbox, the CLI exits with `No sandbox selected`. | |
| Run `$$nemoclaw onboard` first, then retry the switch. | |
| </Note> |
🤖 Prompt for 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.
In `@docs/inference/switch-inference-providers.mdx` around lines 21 - 29, Update
the prerequisite text in the switch-inference-providers docs so the `--sandbox
<name>` option is described as necessary whenever no default sandbox is
selected, not only when multiple sandboxes are registered. Adjust the wording
near the NemoClaw onboarding and `inference set` guidance to match the behavior
described by the existing Note, using the same `$$nemoclaw inference set` and
`$$nemoclaw onboard` references.
Contributor
PR Review Advisor — No blocking findingsMerge posture: No blocking advisor findings This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision. |
Contributor
PR Review Advisor (Nemotron Ultra) — No blocking findingsMerge posture: No blocking advisor findings Action checklist
Findings index
Review findings by urgency: 0 required fixes, 0 items to resolve/justify, 1 in-scope improvement
|
prekshivyas
approved these changes
Jul 1, 2026
Hadar301
pushed a commit
to Hadar301/NemoClaw-OpenShift
that referenced
this pull request
Jul 12, 2026
<!-- markdownlint-disable MD041 --> ## Summary Clarifies that `nemoclaw inference set` requires a running, selected NemoClaw sandbox before switching providers. This prevents new users from copying the first switch command and immediately hitting `No sandbox selected`. ## Related Issue Fixes NVIDIA#6092 ## Changes - Updates the Switch Inference Providers page metadata to describe running-sandbox scope. - Expands prerequisites to tell users to run `$$nemoclaw onboard` and use `--sandbox <name>` when needed. - Adds a note explaining the `No sandbox selected` error and recovery path before the first `inference set` example. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates <!-- Check all that apply. For any "covered by existing tests", "not applicable", or waiver entry, add a brief justification on the same line or in the Changes section. --> - [ ] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [x] Tests not applicable — justification: doc-only prerequisite clarification with no runtime behavior change. - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Verification <!-- Check each item you ran and confirmed. Leave unchecked items you skipped. Doc-only changes do not require npm test unless you ran it. --> - [x] PR description includes the DCO sign-off declaration and every commit appears as `Verified` in GitHub - [x] Git hooks passed during commit and push, or `npx prek run --from-ref main --to-ref HEAD` passes - [ ] Targeted tests pass for changed behavior - [ ] Full `npm test` passes (broad runtime changes only) - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) Verification note: `npm run docs` completed with 0 errors, but Fern reported 1 hidden warning, so the warning-free docs checkbox is intentionally left unchecked. --- <!-- DCO sign-off is required in this PR description, and every commit must appear as Verified in GitHub. Run: git config user.name && git config user.email --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified the guide for switching the active inference model in a running sandbox. * Updated prerequisites to list the required setup more explicitly, including selecting a sandbox or providing one with the command. * Added a note about the “No sandbox selected” message and the steps to retry after onboarding. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies that
nemoclaw inference setrequires a running, selected NemoClaw sandbox before switching providers. This prevents new users from copying the first switch command and immediately hittingNo sandbox selected.Related Issue
Fixes #6092
Changes
$$nemoclaw onboardand use--sandbox <name>when needed.No sandbox selectederror and recovery path before the firstinference setexample.Type of Change
Quality Gates
Verification
Verifiedin GitHubnpx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only)Verification note:
npm run docscompleted with 0 errors, but Fern reported 1 hidden warning, so the warning-free docs checkbox is intentionally left unchecked.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit