Skip to content

Commit 2ac7188

Browse files
Initial restructure POC
1 parent 0b64df7 commit 2ac7188

39 files changed

+92
-73
lines changed

docs/data-ai/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You can also monitor your machines through teleop, power your application logic,
3737
{{< cards >}}
3838
{{% card link="/data-ai/data/query/" noimage="true" %}}
3939
{{% card link="/data-ai/data/visualize/" noimage="true" %}}
40-
{{% card link="/data-ai/data/advanced/alert-data/" noimage="true" %}}
40+
{{% card link="/data-ai/data/alert-data/" noimage="true" %}}
4141
{{% card link="/data-ai/data/export/" noimage="true" %}}
4242
{{< /cards >}}
4343
{{< /how-to-expand >}}
@@ -48,9 +48,9 @@ You can also monitor your machines through teleop, power your application logic,
4848
{{% card link="/data-ai/ai/train-tflite/" noimage="true" %}}
4949
{{% card link="/data-ai/ai/train/" noimage="true" %}}
5050
{{% card link="/data-ai/ai/deploy/" noimage="true" %}}
51-
{{% card link="/data-ai/ai/run-inference/" noimage="true" %}}
52-
{{% card link="/data-ai/ai/alert/" noimage="true" %}}
53-
{{% card link="/data-ai/ai/act/" noimage="true" %}}
51+
{{% card link="/data-ai/inference/run-inference/" noimage="true" %}}
52+
{{% card link="/data-ai/inference/alert/" noimage="true" %}}
53+
{{% card link="/data-ai/inference/act/" noimage="true" %}}
5454
{{< /cards >}}
5555
{{< /how-to-expand >}}
5656

docs/data-ai/ai/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
linkTitle: "Leverage AI"
3-
title: "Leverage AI"
2+
linkTitle: "Train an ML model"
3+
title: "Train an ML model"
44
weight: 300
55
layout: "empty"
66
type: "docs"

docs/data-ai/ai/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The service works with models trained inside and outside the Viam app:
8383
On its own the ML model service only runs the model.
8484
After deploying your model, you need to configure an additional service to use the deployed model.
8585
For example, you can configure an [`mlmodel` vision service](/operate/reference/services/vision/) to visualize the inferences your model makes.
86-
Follow our docs to [run inference](/data-ai/ai/run-inference/) to add an `mlmodel` vision service and see inferences.
86+
Follow our docs to [run inference](/data-ai/inference/run-inference/) to add an `mlmodel` vision service and see inferences.
8787

8888
For other use cases, consider [creating custom functionality with a module](/operate/get-started/other-hardware/).
8989

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ To capture images of edge cases and re-train your model using those images, comp
154154
## Next steps
155155

156156
Now your machine can make inferences about its environment.
157-
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.
157+
The next step is to [deploy](/data-ai/ai/deploy/) the ML model and then [act](/data-ai/inference/act/) or [alert](/data-ai/inference/alert/) based on these inferences.
158158

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

docs/data-ai/ai/train.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -846,4 +846,4 @@ You can also view your training jobs' logs with the [`viam train logs`](/dev/too
846846
{{< /table >}}
847847

848848
To use your new model with machines, you must [deploy it](/data-ai/ai/deploy/) with the appropriate ML model service.
849-
Then you can use another service, such as the vision service, to [run inference](/data-ai/ai/run-inference/).
849+
Then you can use another service, such as the vision service, to [run inference](/data-ai/inference/run-inference/).

docs/data-ai/ai/advanced/upload-external-data.md renamed to docs/data-ai/ai/upload-external-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ aliases:
1313
- /how-tos/upload-data/
1414
date: "2024-12-04"
1515
description: "Upload data to the Viam app from your local computer or mobile device using the data client API, Viam CLI, or Viam mobile app."
16-
prev: "/data-ai/ai/act/"
16+
prev: "/data-ai/inference/act/"
1717
---
1818

1919
When you configure the data management service, Viam automatically uploads data from the default directory `~/.viam/capture` and any directory you configured.

docs/data-ai/capture-data/advanced/_index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/data-ai/capture-data/capture-other-sources.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Some models do not support all options, for example webcams do not capture point
8080

8181
{{< /expand >}}
8282

83-
For instructions on configuring data capture and sync with JSON, go to [Advanced data capture and sync configurations](/data-ai/capture-data/advanced/advanced-data-capture-sync/) and follow the instructions for JSON examples.
83+
For instructions on configuring data capture and sync with JSON, go to [Advanced data capture and sync configurations](/data-ai/reference/advanced-data-capture-sync/) and follow the instructions for JSON examples.
8484

8585
## View captured data
8686

@@ -121,12 +121,12 @@ For instructions on configuring data capture and sync with JSON, go to [Advanced
121121
For other ways to control data synchronization, see:
122122

123123
- [Conditional sync](/data-ai/capture-data/conditional-sync/)
124-
- [Retention policies](/data-ai/capture-data/advanced/advanced-data-capture-sync/#cloud-data-retention)
125-
- [Sync optimization](/data-ai/capture-data/advanced/advanced-data-capture-sync/#sync-optimization)
124+
- [Retention policies](/data-ai/reference/advanced-data-capture-sync/#cloud-data-retention)
125+
- [Sync optimization](/data-ai/reference/advanced-data-capture-sync/#sync-optimization)
126126

127127
{{< /alert >}}
128128

129129
## Next steps
130130

131-
For more information on available configuration attributes and options like capturing directly to MongoDB or conditional sync, see [Advanced data capture and sync configurations](/data-ai/capture-data/advanced/advanced-data-capture-sync/).
131+
For more information on available configuration attributes and options like capturing directly to MongoDB or conditional sync, see [Advanced data capture and sync configurations](/data-ai/reference/advanced-data-capture-sync/).
132132
To leverage AI, you can now [create a dataset](/data-ai/ai/create-dataset/) with the data you've captured.

docs/data-ai/capture-data/conditional-sync.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Conditional cloud sync"
2+
title: "Conditional sync"
33
linkTitle: "Conditional sync"
44
description: "Trigger cloud sync to sync captured data when custom conditions are met."
55
type: "docs"
@@ -15,7 +15,7 @@ aliases:
1515
languages: []
1616
viamresources: ["sensor", "data_manager"]
1717
platformarea: ["data", "registry"]
18-
next: /data-ai/capture-data/advanced/advanced-data-capture-sync/
18+
next: /data-ai/reference/advanced-data-capture-sync/
1919
date: "2024-12-04"
2020
---
2121

docs/data-ai/capture-data/filter-before-sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
linkTitle: "Filter data"
2+
linkTitle: "Filter captured data"
33
title: "Filter data before sync"
44
weight: 13
55
layout: "docs"

docs/data-ai/capture-data/advanced/how-sync-works.md renamed to docs/data-ai/capture-data/how-sync-works.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
linkTitle: "How sync works"
33
title: "How sync works"
44
tags: ["data management", "data", "services"]
5-
weight: 12
5+
weight: 10
66
layout: "docs"
77
type: "docs"
88
platformarea: ["data"]
99
description: "Data capture and sync works differently for viam-server and viam-micro-server."
1010
date: "2024-12-18"
11-
prev: "/data-ai/capture-data/advanced/advanced-data-capture-sync/"
11+
prev: "/data-ai/reference/advanced-data-capture-sync/"
1212
---
1313

1414
Data capture and cloud sync works differently for `viam-server` and `viam-micro-server`.
@@ -115,4 +115,4 @@ If your robot is offline and can't sync and your machine's disk fills up beyond
115115
For more information, see [Automatic data deletion details](/data-ai/capture-data/advanced/how-sync-works/)
116116

117117
Data capture supports capturing tabular data directly to MongoDB in addition to capturing to disk.
118-
For more information, see [Capture directly to MongoDB](/data-ai/capture-data/advanced/advanced-data-capture-sync/#capture-directly-to-your-own-mongodb-cluster).
118+
For more information, see [Capture directly to MongoDB](/data-ai/reference/advanced-data-capture-sync/#capture-directly-to-your-own-mongodb-cluster).

docs/data-ai/data/advanced/_index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/data-ai/data/advanced/alert-data.md renamed to docs/data-ai/data/alert-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
linkTitle: "Alert on data"
2+
linkTitle: "Alert"
33
title: "Alert on data"
44
weight: 60
55
layout: "docs"

docs/data-ai/data/export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
linkTitle: "Export data"
2+
linkTitle: "Export"
33
title: "Export data"
44
weight: 40
55
description: "Download data from the Viam app using the data client API or the Viam CLI."
@@ -15,7 +15,7 @@ aliases:
1515
viamresources: ["sensor", "data_manager"]
1616
platformarea: ["data", "cli"]
1717
date: "2024-12-03"
18-
next: "/data-ai/data/advanced/alert-data/"
18+
next: "/data-ai/data/alert-data/"
1919
---
2020

2121
You can download machine data from cloud storage to your computer with the Viam CLI.

docs/data-ai/data/query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
linkTitle: "Query data"
2+
linkTitle: "Query"
33
title: "Query data"
44
weight: 20
55
layout: "docs"

docs/data-ai/data/visualize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
linkTitle: "Visualize data"
2+
linkTitle: "Visualize"
33
title: "Visualize data"
44
weight: 20
55
layout: "docs"

docs/data-ai/inference/_index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
linkTitle: "Run inference"
3+
title: "Run inference"
4+
weight: 300
5+
layout: "empty"
6+
type: "docs"
7+
empty_node: true
8+
open_on_desktop: true
9+
header_only: true
10+
---

docs/data-ai/ai/act.md renamed to docs/data-ai/inference/act.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 70
55
layout: "docs"
66
type: "docs"
77
description: "Use the vision service API to act based on inferences."
8-
next: "/data-ai/ai/advanced/upload-external-data/"
8+
next: "/data-ai/ai/upload-external-data/"
99
---
1010

1111
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.

docs/data-ai/ai/alert.md renamed to docs/data-ai/inference/alert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For example, a trigger could alert you when a camera feed detects an anomaly.
2121

2222
{{< expand "A configured camera and vision service." >}}
2323

24-
Follow the instructions to [configure a camera](/operate/reference/components/camera/) and [run inference](/data-ai/ai/run-inference/).
24+
Follow the instructions to [configure a camera](/operate/reference/components/camera/) and [run inference](/data-ai/inference/run-inference/).
2525

2626
{{< /expand >}}
2727

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
linkTitle: "Run inference"
2+
linkTitle: "Vision inference"
33
title: "Run inference on a model"
44
weight: 50
55
layout: "docs"

docs/data-ai/quickstart/_index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
linkTitle: "Quickstart"
3+
title: "Quickstart"
4+
weight: 1
5+
layout: "empty"
6+
type: "docs"
7+
empty_node: true
8+
open_on_desktop: true
9+
header_only: true
10+
---

docs/data-ai/quickstart/capture.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
linkTitle: "Capture"
3+
title: "Capture"
4+
weight: 20
5+
layout: "docs"
6+
type: "docs"
7+
description: "Use the vision service API to act based on inferences."
8+
next: "/data-ai/ai/upload-external-data/"
9+
---

docs/data-ai/quickstart/infer.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
linkTitle: "Infer"
3+
title: "Infer"
4+
weight: 30
5+
layout: "docs"
6+
type: "docs"
7+
description: "Use the vision service API to act based on inferences."
8+
next: "/data-ai/ai/upload-external-data/"
9+
---

docs/data-ai/quickstart/setup.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
linkTitle: "Setup"
3+
title: "Setup"
4+
weight: 10
5+
layout: "docs"
6+
type: "docs"
7+
description: "Use the vision service API to act based on inferences."
8+
next: "/data-ai/ai/upload-external-data/"
9+
---

docs/data-ai/capture-data/advanced/advanced-data-capture-sync.md renamed to docs/data-ai/reference/advanced-data-capture-sync.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
linkTitle: "Advanced data capture and sync configurations"
3-
title: "Advanced data capture and sync configurations"
2+
linkTitle: "Sync configuration"
3+
title: "Sync configuration"
44
tags: ["data management", "data", "services"]
55
weight: 10
66
layout: "docs"
@@ -705,9 +705,9 @@ Failing to write to MongoDB doesn't affect capturing and syncing data to cloud s
705705
Configure how long your synced data remains stored in the cloud:
706706

707707
- **Retain data up to a certain size (for example, 100GB) or for a specific length of time (for example, 14 days):** Set `retention_policies` at the resource level.
708-
See the `retention_policy` field in [data capture configuration attributes](/data-ai/capture-data/advanced/advanced-data-capture-sync/#click-to-view-data-capture-attributes).
708+
See the `retention_policy` field in [data capture configuration attributes](/data-ai/reference/advanced-data-capture-sync/#click-to-view-data-capture-attributes).
709709
- **Delete data captured by a machine when you delete the machine:** Control whether your cloud data is deleted when a machine or machine part is removed.
710-
See the `delete_data_on_part_deletion` field in the [data management service configuration attributes](/data-ai/capture-data/advanced/advanced-data-capture-sync/#click-to-view-data-management-attributes).
710+
See the `delete_data_on_part_deletion` field in the [data management service configuration attributes](/data-ai/reference/advanced-data-capture-sync/#click-to-view-data-management-attributes).
711711

712712
### Sync optimization
713713

docs/data-ai/ai/advanced/_index.md renamed to docs/data-ai/reference/api/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
linkTitle: "Advanced"
3-
title: "Advanced"
4-
weight: 200
2+
linkTitle: "APIs"
3+
title: "APIs"
4+
weight: 500
55
layout: "empty"
66
type: "docs"
77
empty_node: true

docs/data-ai/reference/triggers-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ date: "2025-05-05"
1111
Triggers can alert you by email or webhook when the following events occur:
1212

1313
- [machine telemetry data syncs from your local device to the Viam cloud](/manage/troubleshoot/alert/)
14-
- [data syncs from a machine](/data-ai/data/advanced/alert-data/)
15-
- [service detects a specified object or classifies a specified label](/data-ai/ai/alert/)
14+
- [data syncs from a machine](/data-ai/data/alert-data/)
15+
- [service detects a specified object or classifies a specified label](/data-ai/inference/alert/)
1616

1717
## Trigger attributes
1818

docs/dev/reference/changelog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ It is not possible to store metadata associated with a Viam user.
144144

145145
{{% changelog color="added" title="Hot Data Store" date="2025-03-11" %}}
146146

147-
The [hot data store](/data-ai/capture-data/advanced/advanced-data-capture-sync/#capture-to-the-hot-data-store) allows you to access recent data faster.
147+
The [hot data store](/data-ai/reference/advanced-data-capture-sync/#capture-to-the-hot-data-store) allows you to access recent data faster.
148148

149149
{{% /changelog %}}
150150

@@ -514,7 +514,7 @@ See [Visualize data with Grafana](/tutorials/services/visualize-data-grafana/) f
514514

515515
{{% changelog date="2024-01-31" color="added" title="Use triggers to trigger actions" %}}
516516

517-
You can now configure [triggers](/data-ai/data/advanced/alert-data/) (previously called webhooks) to execute actions when certain types of data are sent from your machine to the cloud.
517+
You can now configure [triggers](/data-ai/data/alert-data/) (previously called webhooks) to execute actions when certain types of data are sent from your machine to the cloud.
518518

519519
{{% /changelog %}}
520520

docs/manage/troubleshoot/teleoperate/default-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Additionally, the app allows you to:
4545

4646
- see if your machines are online
4747
- [view a machine's logs](/manage/troubleshoot/troubleshoot/#check-logs)
48-
- [upload images from your phone to the cloud](/data-ai/ai/advanced/upload-external-data/#upload-images-with-the-viam-mobile-app)
48+
- [upload images from your phone to the cloud](/data-ai/ai/upload-external-data/#upload-images-with-the-viam-mobile-app)
4949
- [invite people to collaborate with you and modify access](/manage/troubleshoot/teleoperate/default-interface/#viam-mobile-app)
5050

5151
<br>

docs/operate/mobility/use-input-to-act.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ readings = await my_sensor.get_readings()
5151
Other common inputs include the methods of a [board](/dev/reference/apis/components/board/) (`GetGPIO`, `GetPWM`, `PWMFrequency`, `GetDigitalInterruptValue`, and `ReadAnalogReader`), or a [power sensor](/dev/reference/apis/components/power-sensor/) (`GetVoltage`, `GetCurrent`, `GetPower`, and `GetReadings`).
5252

5353
You can also use camera input, for example to detect objects and pick them up with an arm.
54-
See [Act based on inferences](/data-ai/ai/act/) for relevant examples.
54+
See [Act based on inferences](/data-ai/inference/act/) for relevant examples.
5555

56-
If you want to send alerts based on computer vision or captured data, see [Alert on inferences](/data-ai/ai/alert/) or [Alert on data](/data-ai/data/advanced/alert-data/).
56+
If you want to send alerts based on computer vision or captured data, see [Alert on inferences](/data-ai/inference/alert/) or [Alert on data](/data-ai/data/alert-data/).
5757

5858
{{% /tablestep %}}
5959
{{% tablestep number=3 %}}

docs/operate/reference/components/camera/webcam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ If you are using a CSI camera v1.3 or v2.0, or v3.0 with a Raspberry Pi, use the
267267
For CSI cameras used with Jetsons, use the `viam:camera:csi` model provided by the same module.
268268

269269
For Raspberry Pi AI cameras like the IMX500 AI camera, use a module such as [this `viam-pi-ai-camera` vision service](https://github.com/HipsterBrown/viam-pi-ai-camera).
270-
For more information about the vision service, see [run inference](https://docs.viam.com/data-ai/ai/run-inference/).
270+
For more information about the vision service, see [run inference](https://docs.viam.com/data-ai/inference/run-inference/).
271271
{{% /expand%}}
272272

273273
{{% expand "High CPU usage" %}}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ linkTitle: "Vision Service"
44
weight: 20
55
type: "docs"
66
layout: "empty"
7-
canonical: "/data-ai/ai/run-inference/"
7+
canonical: "/data-ai/inference/run-inference/"
88
---

docs/tutorials/projects/helmet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ Now that you have verified that the detector and data sync are working, modify y
251251

252252
## Set up email notifications
253253

254-
[Triggers](/data-ai/ai/alert/) allow you to send webhook requests or email notifications when certain events happen.
254+
[Triggers](/data-ai/inference/alert/) allow you to send webhook requests or email notifications when certain events happen.
255255

256256
For example, you can set up a trigger to perform an action whenever an image of someone without a hard hat is uploaded to the cloud.
257257

0 commit comments

Comments
 (0)