Skip to content

Commit 82fc4df

Browse files
authored
DOCS-3423: Add some feedback from Adrienne and redesign deploy.md based on Eliot's feedback for capture sync (#3984)
1 parent eaf077a commit 82fc4df

File tree

4 files changed

+26
-62
lines changed

4 files changed

+26
-62
lines changed

docs/data-ai/ai/deploy.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,17 @@ aliases:
2828
- /manage/data/deploy-model/
2929
---
3030

31-
The Machine Learning (ML) model service allows you to deploy [machine learning models](/data-ai/ai/deploy/#deploy-your-ml-model) to your machine.
32-
The service works with models trained inside and outside the Viam app:
33-
34-
- You can [train TFlite](/data-ai/ai/train-tflite/) or [other models](/data-ai/ai/train/) on data from your machines.
35-
- You can upload externally trained models on the [**MODELS** tab](https://app.viam.com/data/models) in the **DATA** section of the Viam app.
36-
- You can use [ML models](https://app.viam.com/registry?type=ML+Model) from the [Viam Registry](https://app.viam.com/registry).
37-
- You can use a [model](/data-ai/ai/deploy/#deploy-your-ml-model) trained outside the Viam platform whose files are on your machine.
31+
After training or uploading a machine learning model, use a machine learning (ML) model service to deploy the ML model to your machine.
3832

39-
## Deploy your ML model
33+
## Deploy your ML model on an ML model service
4034

41-
Navigate to the **CONFIGURE** tab of one of your machine in the [Viam app](https://app.viam.com).
42-
Add an ML model service that supports the ML model you trained or the one you want to use from the registry.
35+
1. Navigate to the **CONFIGURE** tab of one of your machine in the [Viam app](https://app.viam.com).
36+
2. Add an ML model service that supports the ML model you want to use.
37+
- For example, use the `ML model / TFLite CPU` service for TFlite ML models that you trained with Viam's built-in training.
4338

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

46-
### Model framework support
41+
{{% expand "Want more information about model framework and hardware support for each ML model service? Click here." %}}
4742

4843
Viam currently supports the following frameworks:
4944

@@ -59,16 +54,14 @@ Viam currently supports the following frameworks:
5954
For some models of the ML model service, like the [Triton ML model service](https://github.com/viamrobotics/viam-mlmodelservice-triton/) for Jetson boards, you can configure the service to use either the available CPU or a dedicated GPU.
6055
{{< /alert >}}
6156

62-
For example,use the `ML model / TFLite CPU` service for TFlite ML models.
63-
If you used the built-in training, this is the ML model service you need to use.
64-
If you used a custom training script, you may need a different ML model service.
57+
{{< /expand>}}
6558

66-
To deploy a model, click **Select model** and select the model from your organization or the registry.
67-
Save your config.
59+
3. Click **Select model** and select a model from your organization or the registry.
60+
4. Save your config.
6861

69-
### Machine learning models from registry
62+
### Models available to deploy on the ML Model service
7063

71-
You can search the machine learning models that are available to deploy on this service from the registry here:
64+
You can also use these publicly available machine learning models with an ML model service:
7265

7366
{{<mlmodels>}}
7467

@@ -85,7 +78,14 @@ Enter **JSON** mode and find the `"packages"` section of your config.
8578
Replace `"version": "latest"` with `"version"` from the package reference you just copied, for example `"version": "2024-11-14T15-05-26"`.
8679
Save your config to use your specified version of the ML model.
8780

88-
## Next steps
81+
## How the ML model service works
82+
83+
The service works with models trained inside and outside the Viam app:
84+
85+
- You can [train TFlite](/data-ai/ai/train-tflite/) or [other model frameworks](/data-ai/ai/train/) on data from your machines.
86+
- You can use [ML models](https://app.viam.com/registry?type=ML+Model) from the [Viam Registry](https://app.viam.com/registry).
87+
- 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.
88+
- You can use a [model](/data-ai/ai/deploy/#deploy-your-ml-model-on-an-ml-model-service) 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.
8989

9090
On its own the ML model service only runs the model.
9191
After deploying your model, you need to configure an additional service to use the deployed model.

docs/data-ai/ai/train-tflite.md

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -53,43 +53,6 @@ Follow the guide to [create a dataset](/data-ai/ai/create-dataset/) if you haven
5353

5454
{{% /expand%}}
5555

56-
{{% expand "A configured camera. Click to see instructions." %}}
57-
58-
First, connect the camera to your machine's computer if it's not already connected (like with an inbuilt laptop webcam).
59-
60-
Then, navigate to the **CONFIGURE** tab of your machine's page in the [Viam app](https://app.viam.com).
61-
Click the **+** icon next to your machine part in the left-hand menu and select **Component**.
62-
The `webcam` model supports most USB cameras and inbuilt laptop webcams.
63-
You can find additional camera models in the [camera configuration](/operate/reference/components/camera/#configuration) documentation.
64-
65-
Complete the camera configuration and use the **TEST** panel in the configuration card to test that the camera is working.
66-
67-
{{% /expand%}}
68-
69-
{{% expand "No computer or webcam?" %}}
70-
71-
No problem.
72-
You don't need to buy or own any hardware to complete this guide.
73-
74-
Use [Try Viam](https://app.viam.com/try) to borrow a rover free of cost online.
75-
The rover already has `viam-server` installed and is configured with some components, including a webcam.
76-
77-
Once you have borrowed a rover, go to its **CONTROL** tab where you can view camera streams and also drive the rover.
78-
You should have a front-facing camera and an overhead view of your rover.
79-
Now you know what the rover can perceive.
80-
81-
To change what the front-facing camera is pointed at, find the **cam** camera panel on the **CONTROL** tab and click **Toggle picture-in-picture** so you can continue to view the camera stream.
82-
Then, find the **viam_base** panel and drive the rover around.
83-
84-
Now that you have seen that the cameras on your Try Viam rover work, begin by [Creating a dataset and labeling data](/data-ai/ai/create-dataset/).
85-
You can drive the rover around as you capture data to get a variety of images from different angles.
86-
87-
{{< alert title="Tip" color="tip" >}}
88-
Be aware that if you are running out of time during your rental, you can extend your rover rental as long as there are no other reservations.
89-
{{< /alert >}}
90-
91-
{{% /expand%}}
92-
9356
## Train a machine learning (ML) model
9457

9558
Now that you have a dataset with your labeled images, you are ready to train a machine learning model.
@@ -163,7 +126,7 @@ Once your model has finished training, you can test it.
163126
Ideally, you want your ML model to be able to work with a high level of confidence.
164127
As you test it, if you notice faulty predictions or confidence scores, you will need to adjust your dataset and retrain your model.
165128

166-
If you trained a classification model, you can test it with the following instructions.
129+
If you trained a _classification_ model, you can test it with the following instructions.
167130

168131
1. Navigate to the [**DATA** tab](https://app.viam.com/data/view) and click on the **Images** subtab.
169132
1. Click on an image to open the side menu, and select the **Actions** tab.
@@ -180,7 +143,8 @@ You can test both detection models and classifier models using the following res
180143

181144
## Next steps
182145

183-
Now your machine can make inferences about its environment. The next step is to [act](/data-ai/ai/act/) or [alert](/data-ai/ai/alert/) based on these inferences.
146+
Now your machine can make inferences about its environment.
147+
The next step is to [deploy](/data-ai/ai/deploy/) the ML model and then [act](/data-ai/ai/act/) or [alert](/data-ai/ai/alert/) based on these inferences.
184148

185149
See the following tutorials for examples of using machine learning models to make your machine do things based on its inferences about its environment:
186150

docs/dev/reference/changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ In addition to other improvements, your component, service, and other resource c
273273
{{% changelog date="2024-03-01" color="added" title="Additional ML models" %}}
274274

275275
Viam has added support for the TensorFlow, PyTorch, and ONNX ML model frameworks, expanding upon the existing support for TensorFlow Lite models.
276-
You can now upload your own ML model(/data-ai/ai/deploy/#deploy-your-ml-model) using any of these frameworks for use with the Vision service.
276+
You can now upload your own ML model(/data-ai/ai/deploy/#deploy-your-ml-model-on-an-ml-model-service) using any of these frameworks for use with the Vision service.
277277

278278
{{% /changelog %}}
279279

@@ -312,7 +312,7 @@ You can now use the [generic service](/operate/reference/components/generic/) to
312312

313313
{{% changelog date="2024-02-12" color="added" title="ML models in the registry" %}}
314314

315-
You can now upload [machine learning (ML) models](/data-ai/ai/deploy/#deploy-your-ml-model) to the Viam Registry, in addition to modules.
315+
You can now upload [machine learning (ML) models](/data-ai/ai/deploy/#deploy-your-ml-model-on-an-ml-model-service) to the Viam Registry, in addition to modules.
316316
You may upload models you have trained yourself using the Viam app, or models you have trained outside of the App.
317317
When uploading, you have the option to make your model available to the general public for reuse.
318318

@@ -994,7 +994,7 @@ You will need to first register the machine learning model file with the [ML mod
994994
{{% changelog date="2023-03-31" color="added" title="Machine learning for image classification models" %}}
995995

996996
You can now [train](/data-ai/ai/train-tflite/) and [deploy](/data-ai/ai/deploy/) image classification models with the [data management service](/data-ai/capture-data/capture-sync/) and use your machine's image data directly within Viam.
997-
Additionally, you can upload and use existing [machine learning models](/data-ai/ai/deploy/#deploy-your-ml-model) with your machines.
997+
Additionally, you can upload and use existing [machine learning models](/data-ai/ai/deploy/#deploy-your-ml-model-on-an-ml-model-service) with your machines.
998998
For more information on using data synced to the cloud to train machine learning models, read [train a TFlite](/data-ai/ai/train-tflite/) or [another model](/data-ai/ai/train/).
999999

10001000
{{% /changelog %}}

docs/operate/reference/services/vision/mlmodel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Before configuring your `mlmodel` detector or classifier, you need to:
2929

3030
<h4>1. Train or upload an ML model</h4>
3131

32-
You can add an [existing model](/data-ai/ai/deploy/#deploy-your-ml-model) or [train a TFlite](/data-ai/ai/train-tflite/) or [another model](/data-ai/ai/train/) for object detection and classification using your data in the [Viam Cloud](/data-ai/capture-data/capture-sync/).
32+
You can add an [existing model](/data-ai/ai/deploy/#deploy-your-ml-model-on-an-ml-model-service) or [train a TFlite](/data-ai/ai/train-tflite/) or [another model](/data-ai/ai/train/) for object detection and classification using your data in the [Viam Cloud](/data-ai/capture-data/capture-sync/).
3333

3434
{{% /manualcard %}}
3535
{{% manualcard %}}

0 commit comments

Comments
 (0)