Skip to content

Commit f4a87d3

Browse files
committed
More changes
1 parent 4f2eaca commit f4a87d3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+124
-129
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ Follow the guide to configure a [webcam](/operate/reference/components/camera/we
3838

3939
## Create a dataset
4040

41-
To create a dataset, use the Viam CLI or Viam:
41+
To create a dataset, use the CLI or the web UI:
4242

4343
{{< tabs >}}
4444
{{% tab name="Viam app" %}}
4545

46-
1. Open the [**DATASETS** tab on the **DATA** page](https://app.viam.com/data/datasets) of Viam.
46+
1. Open the [**DATASETS** tab on the **DATA** page](https://app.viam.com/data/datasets).
4747

4848
1. Click the **+ Create dataset** button.
4949

@@ -76,7 +76,7 @@ To create a dataset, use the Viam CLI or Viam:
7676
{{< tabs >}}
7777
{{% tab name="One image" %}}
7878

79-
You can add images to a dataset directly from a camera or vision component feed in the **CONTROL** or **CONFIGURATION** tabs of Viam.
79+
You can add images to a dataset directly from a camera or vision component feed in the machine's **CONTROL** or **CONFIGURATION** tabs.
8080

8181
To add an image directly to a dataset from a visual feed, complete the following steps:
8282

@@ -87,7 +87,7 @@ To add an image directly to a dataset from a visual feed, complete the following
8787
1. Click **Add** to add the image to the selected dataset.
8888
1. When you see a success notification that reads "Saved image to dataset", you have successfully added the image to the dataset.
8989

90-
To view images added to your dataset, go to the **DATA** page's [**DATASETS** tab](https://app.viam.com/data/datasets) in Viam and select your dataset.
90+
To view images added to your dataset, go to the **DATA** page's [**DATASETS** tab](https://app.viam.com/data/datasets) and select your dataset.
9191

9292
{{% /tab %}}
9393
{{% tab name="Many images" %}}
@@ -196,7 +196,7 @@ Repeat these steps for all images in the dataset.
196196
{{< tabs >}}
197197
{{% tab name="Viam app" %}}
198198

199-
1. Open the [**DATA** page](https://app.viam.com/data/view) of Viam.
199+
1. Open the [**DATA** page](https://app.viam.com/data/view).
200200

201201
1. Navigate to the **ALL DATA** tab.
202202

docs/data-ai/ai/deploy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ Save your config to use your specified version of the ML model.
7373

7474
## How the ML model service works
7575

76-
The service works with models trained inside and outside Viam:
76+
The service works with models trained on Viam or elsewhere:
7777

7878
- You can [train TFlite](/data-ai/ai/train-tflite/) or [other model frameworks](/data-ai/ai/train/) on data from your machines.
79-
- You can use [ML models](https://app.viam.com/registry?type=ML+Model) from the [Viam Registry](https://app.viam.com/registry).
80-
- You can upload externally trained models from a model file on the [**MODELS** tab](https://app.viam.com/models) in the **DATA** section of Viam.
79+
- You can use [ML models](https://app.viam.com/registry?type=ML+Model) from the [registry](https://app.viam.com/registry).
80+
- You can upload externally trained models from a model file on the [**MODELS** tab](https://app.viam.com/models).
8181
- 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.
8282

8383
On its own the ML model service only runs the model.

docs/data-ai/ai/train.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ date: "2024-12-04"
1818
---
1919

2020
You can create custom Python training scripts that train machine learning models to your specifications using PyTorch, TensorFlow, TFLite, ONNX, or any other ML framework.
21-
Once you upload a training script to the [Viam Registry](https://app.viam.com/registry?type=Training+Script), you can use it to build ML models in the Viam Cloud based on your datasets.
21+
Once you upload a training script to the [registry](https://app.viam.com/registry?type=Training+Script), you can use it to build ML models in the Viam Cloud based on your datasets.
2222

2323
You can also use training scripts that are in the registry already.
2424
If you wish to do this, skip to [Submit a training job](#submit-a-training-job).
@@ -772,7 +772,7 @@ You can view uploaded training scripts by navigating to the [registry's **Traini
772772

773773
## Submit a training job
774774

775-
After uploading the training script, you can run it by submitting a training job through Viam or using the Viam CLI or [ML Training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).
775+
After uploading the training script, you can run it by submitting a training job using the web UI, the CLI or the [ML Training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).
776776

777777
{{< table >}}
778778
{{% tablestep number=1 %}}

docs/data-ai/data/export.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
linkTitle: "Export data"
33
title: "Export data"
44
weight: 40
5-
description: "Download data from Viam using the data client API or the Viam CLI."
5+
description: "Download data from Viam using the data client API or the CLI."
66
type: "docs"
77
tags: ["data management", "cloud", "sync"]
88
icon: true
@@ -43,7 +43,7 @@ To export your data from the cloud using the Viam CLI:
4343
{{% tablestep number=1 %}}
4444
**Filter the data you want to download**
4545

46-
Navigate to the [**DATA** page in Viam](https://app.viam.com/data/view).
46+
Navigate to the [**DATA**](https://app.viam.com/data/view).
4747

4848
Use the filters on the left side of the page to filter only the data you wish to export.
4949

@@ -66,7 +66,7 @@ Run the copied command in a terminal:
6666
viam data export --org-ids=<org-id> --data-type=<binary|tabular> --mime-types=<mime types> --destination=.
6767
```
6868

69-
This command uses the Viam CLI to download the data onto your computer based on the search criteria you select in Viam.
69+
This command uses the Viam CLI to download the data onto your computer based on the search criteria you select in the web UI.
7070

7171
By default, the command creates two new directories named `data` and `metadata` in the current directory and downloads the specified data into the `data` folder and metadata, like bounding box information and labels, in JSON format into the `metadata` folder.
7272
If you want to store the data in a different location, change the specified folder with the [`--destination` flag](/dev/tools/cli/#named-arguments).

docs/data-ai/data/query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can then run queries against that data to search for outliers or edge cases,
2727

2828
- **MQL**: Viam also supports the [MongoDB Query language](https://www.mongodb.com/docs/manual/tutorial/query-documents/) for querying captured data from MQL-compatible clients such as `mongosh` or MongoDB Compass.
2929

30-
## Query data on Viam
30+
## Query data in the web UI
3131

3232
### Prerequisites
3333

docs/data-ai/data/visualize.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ aliases:
1414
viamresources: ["sensor", "data_manager"]
1515
platformarea: ["data", "fleet"]
1616
date: "2024-12-04"
17-
description: "Use teleop or grafana to visualize sensor data from Viam."
17+
description: "Use teleop or grafana to visualize sensor data."
1818
---
1919

2020
Once you have used the data management service to [capture data](/data-ai/capture-data/capture-sync/), you can visualize your data on a dashboard with the Viam app's **TELEOP** page or a variety of third-party tools, including Grafana, Tableau, Google's Looker Studio, and more.
@@ -41,7 +41,7 @@ See [configure a machine](/operate/get-started/supported-hardware/) for more inf
4141
{{% tablestep number=1 %}}
4242
**Create a workspace on Viam**
4343

44-
Log in to the [Viam app](https://app.viam.com/).
44+
Log in to [Viam](https://app.viam.com/).
4545

4646
Navigate to the **FLEET** page's **TELEOP** tab.
4747
Create a workspace by clicking **+ Create workspace**.
@@ -266,7 +266,7 @@ See the [guide on querying data](/data-ai/data/query/) for more information.
266266

267267
For more detailed instructions on using Grafana, including a full step-by-step configuration walkthrough, see [visualizing data with Grafana](/tutorials/services/visualize-data-grafana/).
268268

269-
On top of visualizing sensor data with third-party tools, you can also [query it with the Python SDK](/dev/reference/apis/data-client/) or [query it on Viam](/data-ai/data/query/).
269+
On top of visualizing sensor data with third-party tools, you can also [query it with the Python SDK](/dev/reference/apis/data-client/) or [query it in the web UI](/data-ai/data/query/).
270270

271271
To see full projects using visualization, check out these resources:
272272

docs/dev/reference/apis/billing-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You will also need an API key and API key ID to authenticate your session.
3333
Your API key needs to have [Org owner permissions](/manage/manage/rbac/#organization-settings-and-roles) to use the billing client API.
3434
To get an API key (and corresponding ID), you have two options:
3535

36-
- [Create an API key on Viam](/operate/control/api-keys/#add-an-api-key)
36+
- [Create an API key in the web UI](/operate/control/api-keys/#add-an-api-key)
3737
- [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key)
3838

3939
The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates a `BillingClient`:

docs/dev/reference/apis/components/generic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The generic API allows you to give commands to your [generic components](/operat
1616

1717
{{% alert title="Example usage" color="tip" %}}
1818

19-
See [Deploy control logic](/manage/software/control-logic/) for an example of how to use the generic component API, including how to call `DoCommand()` from the Viam SDKs or from Viam.
19+
See [Deploy control logic](/manage/software/control-logic/) for an example of how to use the generic component API, including how to call `DoCommand()` from the SDKs or the web UI.
2020

2121
{{% /alert %}}
2222

docs/dev/reference/apis/data-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To use the Viam data client API, you first need to instantiate a `ViamClient` an
4949
You will also need an API key and API key ID to authenticate your session.
5050
To get an API key (and corresponding ID), you have two options:
5151

52-
- [Create an API key on Viam](/operate/control/api-keys/#add-an-api-key)
52+
- [Create an API key in the web UI](/operate/control/api-keys/#add-an-api-key)
5353
- [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key)
5454

5555
The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates a `DataClient`:

docs/dev/reference/apis/fleet.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To use the Viam fleet management API, you first need to instantiate a `ViamClien
4848
You will also need an API key and API key ID to authenticate your session.
4949
To get an API key (and corresponding ID), you have two options:
5050

51-
- [Create an API key on Viam](/operate/control/api-keys/#add-an-api-key)
51+
- [Create an API key in the web UI](/operate/control/api-keys/#add-an-api-key)
5252
- [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key)
5353

5454
The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates an `AppClient`:
@@ -135,10 +135,10 @@ You can use the module environment variables `VIAM_API_KEY` and `VIAM_API_KEY_ID
135135

136136
To copy the ID of your machine {{< glossary_tooltip term_id="part" text="part" >}}, select the part status dropdown to the right of your machine's location and name on the top of its page and click the copy icon next to **Part ID**:
137137

138-
{{<imgproc src="/build/program/data-client/grab-part-id.png" resize="1000x" class="shadow imgzoom" style="width: 500px" declaredimensions=true alt="Part ID displayed on Viam.">}}
138+
{{<imgproc src="/build/program/data-client/grab-part-id.png" resize="1000x" class="shadow imgzoom" style="width: 500px" declaredimensions=true alt="Part ID displayed in the web UI.">}}
139139

140140
## Find machine ID
141141

142142
To copy the ID of your {{< glossary_tooltip term_id="machine" text="machine" >}}, click the **...** (Actions) button in the upper-right corner of your machine's page, then click **Copy machine ID**:
143143

144-
{{<imgproc src="/fleet/app-usage/copy-machine-id.png" resize="1000x" class="shadow imgzoom" style="width: 500px" declaredimensions=true alt="Machine ID in the actions dropdown on Viam.">}}
144+
{{<imgproc src="/fleet/app-usage/copy-machine-id.png" resize="1000x" class="shadow imgzoom" style="width: 500px" declaredimensions=true alt="Machine ID in the actions dropdown in the web UI.">}}

0 commit comments

Comments
 (0)