docs(inference): document nemoclaw inference get how-to#3431
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughUpdates documentation to replace the previous "confirm live gateway route" instructions with a "Verify the Active Model" section that shows how to run ChangesActive Inference Configuration Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/inference/switch-inference-providers.md (1)
35-58: ⚡ Quick winConsolidate duplicated verification guidance to prevent drift.
This new section overlaps with the existing
## Verify the Active Modelsection (Line 210 onward), which documents the samenemoclaw inference get/--jsonworkflow. Please merge or cross-reference one location so command behavior and error guidance stay in sync over time.🤖 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.md` around lines 35 - 58, The new "## Show the Active Inference Configuration" section duplicates the existing "## Verify the Active Model" guidance for the `nemoclaw inference get` command (including `--json` usage and the "OpenShell inference route is not configured." error); consolidate by removing one copy and either merge the content under a single canonical heading (preferably keep "Verify the Active Model") or replace the new section with a short cross-reference to that canonical section, ensuring the `nemoclaw inference get` example, `--json` output, and the exact error message remain present and identical to avoid drift.
🤖 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.
Nitpick comments:
In `@docs/inference/switch-inference-providers.md`:
- Around line 35-58: The new "## Show the Active Inference Configuration"
section duplicates the existing "## Verify the Active Model" guidance for the
`nemoclaw inference get` command (including `--json` usage and the "OpenShell
inference route is not configured." error); consolidate by removing one copy and
either merge the content under a single canonical heading (preferably keep
"Verify the Active Model") or replace the new section with a short
cross-reference to that canonical section, ensuring the `nemoclaw inference get`
example, `--json` output, and the exact error message remain present and
identical to avoid drift.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 915a917a-5fab-4211-8ad0-0a149a4f23e4
📒 Files selected for processing (1)
docs/inference/switch-inference-providers.md
|
✨ Thanks for submitting this detailed PR to document the Related open PRs: |
54b9edb to
9d02199
Compare
Expand the existing Verify the Active Model section so the inference get command is fully documented with example output (provider and model), --json output (with example JSON body), and the non-zero exit plus error string the command emits when the gateway has no inference route. Frame the section around both use cases (verify after switch, inspect the starting state before a switch) rather than verification only, so the section serves the broader how-to the section header already implies. No content moves outside the existing section, no new section is added; the surrounding nemoclaw <name> status reference is preserved. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
9d02199 to
ee3c9d0
Compare
Summary
Expand the existing "Verify the Active Model" section in
docs/inference/switch-inference-providers.mdto fully documentnemoclaw inference get. The command landed in #3424 with a one-line entry indocs/reference/commands.md, and the inference how-to page picked it up at a minimum level (command +--jsonflag only). This change adds the output shape, the JSON shape, and the unconfigured-route error so users have a documented inverse tonemoclaw inference seton the same page.Problem
After running
nemoclaw inference set --provider X --model Y, the inference how-to page tells users to runnemoclaw inference getandnemoclaw inference get --jsonbut does not show what either prints. Users either have to run the command themselves to find out what to expect, or rely onnemoclaw statusdiffs to confirm the route changed. The unconfigured-route case (gateway has no registered inference route) was not mentioned at all, so users hitting that error had no docs hint at what state caused it or how to recover.Changes
docs/inference/switch-inference-providers.md: rework the existing "Verify the Active Model" H2 to add (1) human-readable output (Provider: <name>/Model: <id>), (2) JSON output body, and (3) the non-zero exit +OpenShell inference route is not configured.error string with a pointer tonemoclaw onboard. Section title, position, and the trailingnemoclaw <name> statuscross-reference are preserved.The new content uses the verified output format from
src/lib/actions/inference-get.tsand the verified error message.Test plan
npx prek run --files docs/inference/switch-inference-providers.mdpasses (gitleaks, markdownlint, docs-to-skills dry-run, skills YAML)commitlintpassesmake docs(no Sphinx in container; rendered preview will appear via NemoClaw's docs build job)Type of Change
Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com
Summary by CodeRabbit
nemoclaw inference getcommand, including a--jsonmachine-readable example.nemoclaw onboardand verify state before/after switching routes.