Repository navigation
Update CLI reference for the registry model framework and --module-resource - #5449
Conversation
rdk#6643 and rdk#6638, released in RDK v1.13.0, accept registry as a model framework and add a repeatable --module-resource flag to packages upload, training-script upload and update, and train submit custom with-upload.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Docs review: Ready to mergeThis PR adds CI: All required checks passing Docs health: No regressions (3 pages compared) Nits
Verified against source (9 claims)
Automated review by Claude. Rerunning the review updates this comment. |
The train submit custom with-upload usage line and example and the train-a-model.md upload command omitted --framework, which both commands require. Note that update with only --module-resource needs a registry framework already set.
|
Fixed in 17a920d:
Generated by Claude Code |
|
Fixed in 45105ec: the Generated by Claude Code |
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |

RDK v1.13.0 lets the CLI upload ML models and training scripts whose framework is
registry, meaning the model runs through module resources from the registry, and adds a repeatable--module-resourceflag that names those resources. This PR adds both to the CLI reference and fixes the custom training script upload example, which left out the required--framework.Source changes
go.viam.com/apito v0.1.597 and addsModelFrameworkRegistry, soregistryjoins the CLI'smodelFrameworkslist.--module-resource(a repeatableStringSliceFlag) topackages upload,training-script upload,training-script updateandtrain submit custom with-upload, and adds--frameworktotraining-script update.validateRegistryModuleResourcesrequires at least one model triple when the framework isregistry("--module-resource is required when --framework is registry") and rejects the flag for any other framework.git merge-base --is-ancestore5e32c22b and 27fe9b8e7 against v1.13.0). Flags were checked againstcli/app.go,cli/ml_training.goandcli/packages.goat that tag.Documents: no DOCS ticket found for RSDK-14608, its parent RSDK-14607, or APP-18037.
Docs changes
docs/cli/reference.md:packages upload:registryadded to--model-framework, plus a new--module-resourcerow.train submit custom with-uploadandtraining-script upload:registryadded to--framework, plus a new--module-resourcerow.--frameworkis now marked Required, matching the code (Required: trueon both commands; this was already true in v1.12.0, so the "Optional" label was wrong before this change too).training-script update: new--frameworkand--module-resourcerows. Setting either replaces the stored framework and module resources; with only--module-resource, the script keeps its current framework (MLTrainingUpdateAction).docs/train/custom-training-scripts.md: the "Package and upload" example ranviam training-script uploadwithout--framework, which the CLI rejects. The example now passes--framework=<framework>, and the text lists the values and the--module-resourcerequirement forregistry.Not changed:
train submit managedalready lists onlytfliteandtensorflow, and the CLI rejectsregistrythere.How I found these
cli-xref.md→packages upload,training-script,train submit→docs/cli/reference.md.--framework,--model-framework,model_framework,module-resource,registry, and the old listpytorch,onnxacrossdocs/,static/,data/,layouts/. That addedcustom-training-scripts.md.train-a-model.md,datasets-and-training.md,manage-your-fleet.mdandautomate-with-scripts.mdpasstfliteand stay correct.deploy-custom-model.mdalready describes Registry in the UI.Checks
prettier (repo-local 3.2.5), markdownlint, vale,
frontmatter_rules.pyandmake build-prodpass.Generated by daily docs change agent
Generated by Claude Code