Say RegisterCustomTrainingContainer needs a non-empty description

[Shannon Bradshaw (shannonbradshaw)]

Source changes

• viam-python-sdk#1289: register_custom_training_container no longer defaults description to "", because the RegisterCustomTrainingContainer RPC rejects an empty description (container description must be specified, app mltraining/ml_training_service.go). Not yet in a published Python release (latest v0.84.0).

Documents: no ticket key found (the PR carries none).

Docs changes

• static/include/app/apis/overrides/protos/mltraining.RegisterCustomTrainingContainer.md: adds that the description must not be empty. This is true today against every SDK version, since the server enforces it.
• static/include/app/apis/generated/mltraining.md and mltraining-table.md: the override text, as the generator renders it.

The generated Python parameter line still says description is optional. It is scraped from python.viam.dev, which still shows description: str = '', so regenerating cannot fix it yet. That line is tracked in the docs-agent backlog until python.viam.dev and a published release show the parameter without a default.

Regenerated with update_sdk_methods.py "" app,mltraining (the Go app-client tabs are scraped only when app is in the resource list). The output is identical to these committed files.

How I found these

• Xref lookup: app-api-xref.md (ML training client)
• Grep matches: register_custom_training_container, RegisterCustomTrainingContainer, container description across docs/ and static/: the generated reference and docs/train/custom-containers.md, whose examples already pass a description.

Checks: vale 3.12.0 on the three files, frontmatter_rules.py, make build-prod all pass. Prettier and markdownlint do not cover static/.

---

Generated by daily docs change agent

---

Generated by Claude Code

[netlify]

✅ Deploy Preview for viam-docs ready!

Name	Link
🔨 Latest commit	6f8bf71
🔍 Latest deploy log	https://app.netlify.com/projects/viam-docs/deploys/6ad1ec11241ae82f45915376
😎 Deploy Preview	https://deploy-preview-5430--viam-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 37 (🟢 up 2 from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: 60 (no change from production) View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[Eliza Farley (elizafarley)]

Docs review: Ready to merge

Adds a sentence to the RegisterCustomTrainingContainer proto override saying the description must not be empty, and regenerates the ML training reference and summary table. The claim matches the server-side check in app, and the generated files match what the override produces.

CI: All required checks passing

Docs health: No regressions (no docs/ pages changed)

Nits

• static/include/app/apis/generated/mltraining.md:497: the Python tab still lists description as (optional), which conflicts with the new summary sentence a few lines above it. The PR description explains why: the line is scraped from python.viam.dev, which still shows description: str = '', and it's tracked for a later regeneration. No change needed here. Rerun update_sdk_methods.py once a Python SDK release that includes viam-python-sdk#1289 is published on python.viam.dev.

Verified against source (3 claims)

• The server rejects an empty description (container description must be specified): viamrobotics/app mltraining/ml_training_service.go:680-681 (error defined at :51)
• The Python SDK no longer defaults description: viamrobotics/viam-python-sdk src/viam/app/ml_training_client.py:311 on main (description: str, no default)
• The summary table's copy of the full override line is generator output, not a hand edit: update_sdk_methods.py:990-1030 takes text up to the first .\n, which is the whole one-line override

Automated review by Claude. Rerunning the review updates this comment.