Repository navigation
Update ML training API reference for training container methods - #5398
Merged
Jeremy Rose (jeremyrose-viam) merged 1 commit intoOct 7, 2026
Merged
Jeremy Rose (jeremyrose-viam) merged 1 commit into
Jeremy Rose (jeremyrose-viam) merged 1 commit into
Conversation
viam-python-sdk#1267 (APP-18127, APP-17611), released in v0.83.1 and now on python.viam.dev, adds list_containers, get_container, register_custom_training_container and delete_custom_training_container, and a container_id parameter on submit_custom_training_job. Add CSV rows and proto description overrides, and regenerate mltraining. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01J5WsNbGP1yKuqz7GyobaFN
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Jeremy Rose (jeremyrose-viam)
approved these changes
Oct 7, 2026
Jeremy Rose (jeremyrose-viam)
deleted the
claude/DOCS-5002-ml-training-container-methods
branch
October 7, 2026 18:41
Member
|
Follow-up on the known gap in the description: the |
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
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.

Source changes
MLTrainingClientgainslist_containers(org_id),get_container(id),register_custom_training_container(org_id, image_uri, description)anddelete_custom_training_container(id), andsubmit_custom_training_jobgains an optionalcontainer_id. Released in Python SDK v0.83.1 (git tag --contains 08502a67), and now on python.viam.dev.GetContainer, APP-18128) and app#13641 (container_idonSubmitCustomTrainingJob, APP-17651) are live.Documents: DOCS-5002 (APP-18128,
GetContainer). Also matched: the epic-level DOCS-4913 (Blocked) and DOCS-5010 (APP-17651).Docs changes
.github/workflows/sdk_protos_map.csv: newmltrainingrows forListContainers,GetContainer,RegisterCustomTrainingContainerandDeleteCustomTrainingContainer, Python column only. The GoMLTrainingClientin RDK v1.11.0 has none of these methods, TypeScript v0.76.0 has none, and the generator has no Flutter app-client support.static/include/app/apis/overrides/protos/mltraining.*Container*.md: one-sentence descriptions for the four methods. The register and list descriptions carry the server rules from appmltraining/ml_training_service.go(publicly readablelinux/amd64Docker Hub images only; Viam's public containers plus the organization's own).static/include/app/apis/generated/mltraining.md,mltraining-table.md: regenerated. The diff adds the four methods and thecontainer_idparameter on the Pythonsubmit_custom_training_jobtab, and nothing else.Generator note: I ran
update_sdk_methods.py "" app,mltrainingrather than"" mltraining. Withmltrainingalone,parse_go.pyonly scrapes Go app-client methods when theappresource is in the run, so every Go tab on the page disappeared. Addingappscrapes them;app.mdcame out unchanged, so this PR touches only themltrainingfiles.Known gap, not changed here: the scraped Python docstring marks
descriptionas optional onregister_custom_training_container, but the server rejects an empty description (errNoDescriptionSpecified). That text comes from python.viam.dev, so the fix belongs in the SDK docstring.How I found these
app-api-xref.md(MLTrainingService) and the docs-agent backlog itempython-sdk-08502a67-ml-training-containers, whose two release conditions both hold as of this run.Checks:
make build-prodpasses. Generated files are outside prettier and markdownlint scope.Generated by daily docs change agent
🤖 Generated with Claude Code
https://claude.ai/code/session_01J5WsNbGP1yKuqz7GyobaFN
Generated by Claude Code