v3.0 edits #3743

sguequierre · 2024-12-09T16:31:36Z

IA edits for data and ai

npentrel

very good start - definitely moving in the right direction. I've only done a superficial review and will do more once you're further along

npentrel · 2024-12-10T13:40:12Z

docs/data-ai/get-started/capture-sync.md

+You can use Viam's built-in data management service to capture images from a camera on your machine and sync the images to the cloud.
+
+With your images synced to the cloud, you can view images from all your machines in the Viam app interface.
+From there, you can use your image data to do things like [train ML models](/how-tos/train-deploy-ml/).
+


I assume this file isn't done yet - since it talks about images? Will skip to the next

npentrel · 2024-12-10T13:41:29Z

docs/data-ai/data/visualize.md

+
+{{< /alert >}}
+
+## Prerequisites: Teleop


I think have a heading ## Teleop and then H3s for the sub-headings to avoid this. Then you can also briefly intro both

npentrel · 2024-12-10T13:42:42Z

docs/data-ai/data/visualize.md

+
+## Configure a sensor widget
+
+Follow our docs to [configure a teleop workspace](manage/troubleshoot/teleoperate/).


You'll want to have the instructions here instead, copy them or create an include

copied over bc needed some adjustments

npentrel · 2024-12-10T13:44:48Z

docs/data-ai/data/query.md

+{{% /tablestep %}}
+{{< /table >}}
+
+## Configure data query


This is weird here - the user would get confused why they are asked to do this. See the visualize.md file comments for h2 and h3s

npentrel · 2024-12-10T13:45:38Z

docs/data-ai/data/export.md

+{{% alert title="In this page" color="tip" %}}
+
+- [Export data with the Viam CLI](#export-data-with-the-viam-cli)
+
+{{% /alert %}}


you can get rid of these, since the TOC is now in the left hand nav

Suggested change

{{% alert title="In this page" color="tip" %}}

- [Export data with the Viam CLI](#export-data-with-the-viam-cli)

{{% /alert %}}

npentrel · 2024-12-10T13:47:33Z

docs/data-ai/ai/create-dataset.md

+Collect images from your machine as it monitors its environment and add these images to a dataset.
+By creating a dataset from your images, you can then train a machine learning model.
+To ensure the model you create performs well, you need to train it on a variety of images that cover the range of things your machine should be able to recognize.


Intro here needs work

npentrel · 2024-12-10T13:52:00Z

docs/data-ai/ai/deploy.md

 ---
+


I am wondering here if we should merge relevant bits from the ML model service page into this and then get rid of that page in the reference section. It feels somewhat possible? Wondering the same about the vision service and data mgmt service tbh but this seems a good place to start

And maybe also cover https://docs.viam.com/registry/ml-models/#model-framework-support ?

nice, that seems to have worked. Now let's see if we can do the same for vision service and data management service

npentrel · 2024-12-10T13:54:05Z

docs/data-ai/ai/run-inference.md

+
+For more detailed information, including optional attribute configuration, see the [`mlmodel` docs](/services/vision/mlmodel/).
+
+## Use an SDK


Good start, I think we could possibly add a code sample here before pointing to APIs?

npentrel · 2024-12-10T13:55:10Z

docs/data-ai/ai/alert.md

+
+Note that your machine must be connected to the internet for data sync and email notifications to work.
+
+## Set up your monitor


like I said yesterday, this feels weird - let's iterate

Ah sorry this edit slipped my mind, will make it

npentrel · 2024-12-10T13:57:39Z

docs/data-ai/ai/alert.md

+
+{{% snippet "setup.md" %}}
+
+## Configure the camera and computer vision


So there's room here for discussions but I think we can consider this as a follow on from the pages before this. So I think you may be able to shorten these steps - until you get to the filtered-camera module

sguequierre · 2024-12-13T15:11:30Z

docs/data-ai/get-started/capture-sync.md

+
+You can also access data from a resource or machine part menu.
+
+## Next steps


veer towards keeping this here bc still helpful... thoughts?

let's keep it for now

npentrel

Ok - I think merge this as is and address the feedback in a separate PR. This is coming together quite nicely. I think next week may be a good time for you to gather feedback from Jack & Tahiya / others on this. And maybe late next week would be good to run this by Bill if he has time (I'd like to be there for that one)

docs/data-ai/get-started/capture-sync.md

npentrel · 2024-12-13T15:32:49Z

docs/data-ai/get-started/capture-sync.md

+Once you have configured the data management service, you can specify the data you want to capture at a resource level.
+
+To configure data capture and cloud sync, you must have one of the following components and services configured on your machine:
+
+{{< readfile "/static/include/data/capture-supported.md" >}}


It doesn't really make sense to have the methods in this table at this point when you just want to say which components and services are supported. I think it's probably best to put what is supported later in this page and keep the requirement up front to more minimal. Also remember you can use the data management service to just sync arbitrary files that something is creating on a machine. Without any configured components.

How about something like:

Suggested change

Once you have configured the data management service, you can specify the data you want to capture at a resource level.

To configure data capture and cloud sync, you must have one of the following components and services configured on your machine:

{{< readfile "/static/include/data/capture-supported.md" >}}

You can capture data from [supported components and services](#link-to-table-that-is-later-in-the-page) or from arbitrary folders on your machines.

npentrel · 2024-12-13T15:33:44Z

docs/data-ai/get-started/capture-sync.md

+
+## Configure the data management service
+
+To start, configure a data management service to capture and sync the resource data.


You can only configure one. And like I said above, it's not restricted to resources.

Suggested change

To start, configure a data management service to capture and sync the resource data.

To start, configure the data management service to capture and sync data.

npentrel · 2024-12-13T15:34:50Z

docs/data-ai/get-started/capture-sync.md

+
+{{< imgproc src="/tutorials/data-management/data-management-conf.png" alt="Data capture configuration card." resize="600x" >}}
+
+For more advanced attribute configuration information, see [Data management service configuration](/data-ai/reference/data/#data-management-service-configuration).


Have you already tried moving more of the service pages into these guides and decided against it or are you waiting to do that later in a different PR?

I personally envisioned having these pages be simpler versions of the reference docs (closer to the how-tos) but still keeping the reference docs up bc that info is also necessary. Does that make sense?

that makes sense. if we need to keep them then so be it - just want to check that there's actually still info in there we don't already cover

npentrel · 2024-12-13T15:35:09Z

docs/data-ai/get-started/capture-sync.md

+
+## Configure data capture
+
+Scroll to the config card you wish to configure data capture and sync on.


Suggested change

Scroll to the config card you wish to configure data capture and sync on.

Scroll to the resource card you wish to configure data capture and sync on.

npentrel · 2024-12-13T16:39:33Z

docs/data-ai/ai/alert.md

 ---
+
+At this point, you should have already set up and tested [computer vision functionality](/data-ai/ai/run-inference/).
+On this page, you'll learn how to use triggers to send alerts in the form of email notifications when certain detections or classifications are made.


you'll need to capture both email & webhooks. webhooks are almost certainly the more sought after part

Possibly we want to put the webhook info into and include and put that on all of the multiple alert pages...

you mean the webhook info from the helmet tutorial to /data-ai/data/advanced/alert-data/? IMO that seems like a lot of info to add/could overwhelm the page but I can add it if you think necessary

I ended up doing it like this here: https://docs-test.viam.dev/3723/manage/troubleshoot/alert/#webhooks just so that we also cover webhooks. The emails are nice but I think more people will need webhooks than emails so we need to mention them and provide the info for it. I think maybe we need to have a webhook reference page or something that we can then link to from the three pages. Or use this as an include and put it in all the places where this comes up

made it into an include

npentrel · 2024-12-13T16:39:44Z

docs/data-ai/ai/alert.md

+First, you'll set up data capture and sync to record images with the anomaly and upload them to the cloud.
+Next, you'll configure a trigger to send email notifications when the anomaly is detected.
+
+## Configured a filtered camera


Suggested change

## Configured a filtered camera

## Configure a filtered camera

npentrel · 2024-12-13T16:40:09Z

docs/data-ai/ai/alert.md

+
+## Configured a filtered camera
+
+Your physical camera is working and your vision service is set up.


Add a prerequisites section please, that way this page follows the general pattern we use on other pages

npentrel · 2024-12-13T16:43:44Z

docs/data-ai/ai/act.md

 ---
+
+You can use the [vision service API](/dev/reference/apis/services/vision/) to get information about your machine's inferences and program behavior based on that.


I think worth you chatting with Jack and Tahiya about whether we want to introduce the vision service here as one of many possible services you could use.

Also needs more work in intro to explain that we'll show a few examples here only

npentrel · 2024-12-13T16:43:56Z

docs/data-ai/ai/act.md

+
+You can use the following code to detect and follow the location of a colored object:
+
+{{% expand "click to view code" %}}


capitalization

Co-authored-by: Naomi Pentrel <[email protected]>

npentrel reviewed Dec 10, 2024

View reviewed changes

npentrel force-pushed the v3.0 branch from 0a2a2fc to b0a1ace Compare December 10, 2024 18:36

sguequierre added 5 commits December 11, 2024 11:59

moving files around

ad45107

make a pr

167e640

More edits

3584c3a

fixup

4c982f1

Make changes

f851066

sguequierre force-pushed the v3.0-edits branch from 8bde469 to f851066 Compare December 11, 2024 17:00

sguequierre added 3 commits December 12, 2024 11:26

Apply code review feedback:

0721913

Delete duplicate page

61cc149

Merge branch 'v3.0' into v3.0-edits

775c488

sguequierre requested a review from npentrel December 12, 2024 16:59

sguequierre added 5 commits December 12, 2024 13:30

fixup transitions

9725bac

fixup checks

d473919

test fixups

a39e097

update table

41a8adc

fixup

d56cd06

sguequierre commented Dec 13, 2024

View reviewed changes

npentrel approved these changes Dec 13, 2024

View reviewed changes

sguequierre and others added 2 commits December 16, 2024 10:53

Apply suggestions from code review

6b05632

Co-authored-by: Naomi Pentrel <[email protected]>

Update docs/data-ai/get-started/capture-sync.md

f0decce

Co-authored-by: Naomi Pentrel <[email protected]>

sguequierre merged commit bb06e29 into viamrobotics:v3.0 Dec 16, 2024
4 of 7 checks passed

sguequierre deleted the v3.0-edits branch December 16, 2024 16:10

sguequierre restored the v3.0-edits branch December 16, 2024 16:11

npentrel added a commit that referenced this pull request Jan 7, 2025

v3.0 edits (#3743)

c973166

Co-authored-by: Naomi Pentrel <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v3.0 edits #3743

v3.0 edits #3743

sguequierre commented Dec 9, 2024 •

edited

Loading

npentrel left a comment

npentrel Dec 10, 2024

npentrel Dec 10, 2024

npentrel Dec 10, 2024

sguequierre Dec 10, 2024

npentrel Dec 10, 2024

npentrel Dec 10, 2024

npentrel Dec 10, 2024

npentrel Dec 10, 2024

npentrel Dec 13, 2024

npentrel Dec 10, 2024

npentrel Dec 10, 2024

sguequierre Dec 10, 2024

npentrel Dec 10, 2024

sguequierre Dec 13, 2024

npentrel Dec 13, 2024

npentrel left a comment

npentrel Dec 13, 2024

npentrel Dec 13, 2024

npentrel Dec 13, 2024

sguequierre Dec 17, 2024

npentrel Dec 17, 2024

npentrel Dec 13, 2024

npentrel Dec 13, 2024

npentrel Dec 13, 2024

sguequierre Dec 17, 2024

npentrel Dec 17, 2024

sguequierre Dec 18, 2024

npentrel Dec 13, 2024

npentrel Dec 13, 2024

npentrel Dec 13, 2024

npentrel Dec 13, 2024

npentrel Dec 13, 2024


		## Configure a sensor widget

		Follow our docs to [configure a teleop workspace](manage/troubleshoot/teleoperate/).


		For more detailed information, including optional attribute configuration, see the [`mlmodel` docs](/services/vision/mlmodel/).

		## Use an SDK


		Note that your machine must be connected to the internet for data sync and email notifications to work.

		## Set up your monitor


		{{% snippet "setup.md" %}}

		## Configure the camera and computer vision


		You can also access data from a resource or machine part menu.

		## Next steps


		## Configure the data management service

		To start, configure a data management service to capture and sync the resource data.

	To start, configure a data management service to capture and sync the resource data.
	To start, configure the data management service to capture and sync data.


		{{< imgproc src="/tutorials/data-management/data-management-conf.png" alt="Data capture configuration card." resize="600x" >}}

		For more advanced attribute configuration information, see [Data management service configuration](/data-ai/reference/data/#data-management-service-configuration).


		## Configure data capture

		Scroll to the config card you wish to configure data capture and sync on.

	Scroll to the config card you wish to configure data capture and sync on.
	Scroll to the resource card you wish to configure data capture and sync on.

	## Configured a filtered camera
	## Configure a filtered camera


		## Configured a filtered camera

		Your physical camera is working and your vision service is set up.

		---

		You can use the [vision service API](/dev/reference/apis/services/vision/) to get information about your machine's inferences and program behavior based on that.


		You can use the following code to detect and follow the location of a colored object:

		{{% expand "click to view code" %}}

v3.0 edits #3743

v3.0 edits #3743

Conversation

sguequierre commented Dec 9, 2024 • edited Loading

npentrel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

npentrel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sguequierre commented Dec 9, 2024 •

edited

Loading