Skip to content

DOCS-3423: Add some feedback from Adrienne and redesign deploy.md based on Eliot's feedback for capture sync #3984

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.

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

Conversation

sguequierre
Copy link
Contributor

  • simplify docs and make easier to follow
  • remove prerequisites of camera and webcam from train-tflite bc that would have come earlier in the process

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Feb 10, 2025
Copy link

netlify bot commented Feb 10, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 0209ac7
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/67aa3d93ae77390008b1ff03
😎 Deploy Preview https://deploy-preview-3984--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 25 (🟢 up 4 from production)
Accessibility: 98 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

Copy link

netlify bot commented Feb 10, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit e4704d7
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/67adff7fdfae9900082183a5
😎 Deploy Preview https://deploy-preview-3984--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 29 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

@@ -163,7 +126,7 @@ Once your model has finished training, you can test it.
Ideally, you want your ML model to be able to work with a high level of confidence.
As you test it, if you notice faulty predictions or confidence scores, you will need to adjust your dataset and retrain your model.

If you trained a classification model, you can test it with the following instructions.
If you trained a _classification_ model, you can test it with the following instructions.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wanted to make this a little more obvious as adrienne missed it, can remove if think unnecessary

- You can [train TFlite](/data-ai/ai/train-tflite/) or [other model frameworks](/data-ai/ai/train/) on data from your machines.
- You can use [ML models](https://app.viam.com/registry?type=ML+Model) from the [Viam Registry](https://app.viam.com/registry).
- You can upload externally trained models from a model file on the [**MODELS** tab](https://app.viam.com/data/models) in the **DATA** section of the Viam app.
- You can use a [model](/data-ai/ai/deploy/#deploy-your-ml-model) trained outside the Viam platform whose files are on your machine. See the documentation of the model of ML model service you're using (pick one that supports your model framework) for instructions on this.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought parenthesis could be useful for ppl that are just coming here as some might / ai might point them here. but wanted to hide this a bit at the bottom as it's more advanced use cases and eliot wants to simplify docs


{{<resources_svc api="rdk:service:mlmodel" type="ML model">}}

### Model framework support
{{% expand "Want more information about model framework and hardware support for each ML model service? Click here." %}}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought it was basically like we were restating the same thing twice here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but we still need this info

@npentrel npentrel merged commit 82fc4df into viamrobotics:main Feb 13, 2025
12 checks passed
Copy link

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants