Skip to content

docs: clarify inference sandbox prerequisite #6152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cv merged 1 commit into from
Jul 1, 2026
Merged

docs: clarify inference sandbox prerequisite #6152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions docs/inference/switch-inference-providers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# SPDX-License-Identifier: Apache-2.0
title: "Switch Inference Models at Runtime"
sidebar-title: "Switch Inference Providers"
description: "Change the active inference model without restarting the sandbox."
description-agent: "Changes the active inference model without restarting the sandbox. Use when switching inference providers, changing the model runtime, or reconfiguring inference routing."
description: "Change the active inference model for a running sandbox without restarting it."
description-agent: "Changes the active inference model for a running sandbox without restarting it. Use when switching inference providers, changing the model runtime, or reconfiguring inference routing."
keywords: ["switch nemoclaw inference model", "change inference runtime"]
content:
type: "how_to"
Expand All @@ -18,9 +18,15 @@ You do not need to restart the sandbox.

## Prerequisites

- A running NemoClaw sandbox.
- 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>

Comment on lines +21 to +29

@coderabbitai coderabbitai Bot Jul 1, 2026

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.

🎯 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.

## Find the Provider Name

The `--provider` value must match a provider already configured on the sandbox.
Expand Down
Loading