Skip to content

DOCS-4059: Update terminology from Viam app to Viam #4379

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/vale/styles/Viam/AvoidWithSubstitution.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ action:
name: replace
swap:
in the website: on the website
web app: Viam app or Viam platform
cloud app: Viam app or Viam platform
web app: Viam or web UI or Viam platform
cloud app: Viam or web UI or Viam platform
user of an org: member of an org
compute parts: Computer
microprocessor: Raspberry Pi or Jetson or another specific term
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ ignorecase: true
action:
name: replace
swap:
cloud app: Viam app or Viam platform
cloud app: Viam or web UI or Viam platform
Scuttlebot: SCUTTLE robot
on the app: in the app
4 changes: 2 additions & 2 deletions docs/data-ai/ai/act.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ async def connect():
# API key ID
api_key_id='<API-KEY-ID>'
)
return await RobotClient.at_address("ADDRESS FROM THE VIAM APP", opts)
return await RobotClient.at_address("MACHINE ADDRESS", opts)


# Get largest detection box and see if it's center is in the left, center, or
Expand Down Expand Up @@ -104,7 +104,7 @@ if __name__ == "__main__":

{{% /expand%}}

If you configured the color detector to detect red in the Viam app, your rover should detect and navigate towards any red objects that come into view of its camera.
If you configured the color detector to detect red, your rover should detect and navigate towards any red objects that come into view of its camera.
Use something like a red sports ball or book cover as a target to follow to test your rover:

<div class="aligncenter">
Expand Down
10 changes: 5 additions & 5 deletions docs/data-ai/ai/advanced/upload-external-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ aliases:
- /services/data/upload/
- /how-tos/upload-data/
date: "2024-12-04"
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."
description: "Upload data to Viam from your local computer or mobile device using the data client API, Viam CLI, or Viam mobile app."
prev: "/data-ai/ai/act/"
---

Expand All @@ -30,7 +30,7 @@ However, if you already have a cache of data you'd like to use with Viam, you ca

### Prerequisites

{{% expand "A running machine connected to the Viam app. Click to see instructions." %}}
{{% expand "A running machine connected to Viam. Click to see instructions." %}}

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

Expand Down Expand Up @@ -72,15 +72,15 @@ In the **Additional paths**, enter the full path to the directory where the data

Toggle **Syncing** to on (green) if it isn't already on.

{{<imgproc src="/services/data/data-sync-temp.png" resize="x1100" declaredimensions=true alt="Data service configured in the Viam app as described." class="shadow" >}}
{{<imgproc src="/services/data/data-sync-temp.png" resize="x1100" declaredimensions=true alt="Data service configured as described." class="shadow" >}}

Click **Save** in the top right corner of the page.

{{% /tablestep %}}
{{% tablestep number=3 %}}
**Confirm that your data uploaded**

Navigate to your [**DATA** page in the Viam app](https://app.viam.com/data/view) and confirm that your data appears there.
Navigate to your [**DATA** page](https://app.viam.com/data/view) and confirm that your data appears there.
If you don't see your files yet, wait a few moments and refresh the page.

{{% /tablestep %}}
Expand Down Expand Up @@ -243,7 +243,7 @@ if __name__ == "__main__":

Save and run your code once.
Running your code more than once will duplicate the data.
View your uploaded data in your [**DATA** page in the Viam app](https://app.viam.com/data/view).
View your uploaded data in your [**DATA** page](https://app.viam.com/data/view).

{{% /tablestep %}}
{{< /table >}}
Expand Down
8 changes: 4 additions & 4 deletions docs/data-ai/ai/alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For example, a trigger could alert you when a camera feed detects an anomaly.

### Prerequisites

{{% expand "A running machine connected to the Viam app." %}}
{{% expand "A running machine connected to Viam." %}}

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

Expand Down Expand Up @@ -128,7 +128,7 @@ Because the filter only syncs images that contain an anomaly, this trigger sends

Follow these steps to configure a trigger to alert when `filtered-camera` syncs an image:

1. Go to the **CONFIGURE** tab of your machine on the [Viam app](https://app.viam.com).
1. Go to the **CONFIGURE** tab of your machine.
Click the **+** (Create) button in the left side menu and select **Trigger**.

1. Enter a name and click **Create**.
Expand All @@ -144,14 +144,14 @@ Follow these steps to configure a trigger to alert when `filtered-camera` syncs
To add an email notification:

1. Click **Add Email**.
{{<imgproc src="/build/configure/trigger-configured-email.png" resize="x400" declaredimensions=true alt="The trigger configured with an example email in the Viam app." class="shadow" >}}
{{<imgproc src="/build/configure/trigger-configured-email.png" resize="x400" declaredimensions=true alt="The trigger configured with an example email." class="shadow" >}}
1. Add the email you wish to be notified whenever this trigger is triggered.
1. Configure the time between notifications.

To add a webhook notification:

1. Click **Add Webhook**.
{{<imgproc src="/build/configure/trigger-configured.png" resize="x400" declaredimensions=true alt="The trigger configured with an example URL in the Viam app." class="shadow" >}}
{{<imgproc src="/build/configure/trigger-configured.png" resize="x400" declaredimensions=true alt="The trigger configured with an example URL." class="shadow" >}}
1. Add the URL of your cloud function.
1. Configure the time between notifications.
1. Write your cloud function to process the [webhook](/data-ai/reference/triggers-configuration/#webhook-attributes).
Expand Down
16 changes: 8 additions & 8 deletions docs/data-ai/ai/create-dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This page explains how to create a dataset that meets these criteria for your tr

## Prerequisites

{{% expand "a machine connected to the Viam app" %}}
{{% expand "a machine connected to Viam" %}}

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

Expand All @@ -38,12 +38,12 @@ Follow the guide to configure a [webcam](/operate/reference/components/camera/we

## Create a dataset

To create a dataset, use the Viam CLI or the Viam app:
To create a dataset, use the CLI or the web UI:

{{< tabs >}}
{{% tab name="Viam app" %}}
{{% tab name="web UI" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{{% tab name="web UI" %}}
{{% tab name="Web UI" %}}

[nit]


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

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

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

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

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

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

To view images added to your dataset, go to the **DATA** page's [**DATASETS** tab](https://app.viam.com/data/datasets) in the Viam app and select your dataset.
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.

{{% /tab %}}
{{% tab name="Many images" %}}
Expand Down Expand Up @@ -194,9 +194,9 @@ Repeat these steps for all images in the dataset.
## Add tagged images to a dataset

{{< tabs >}}
{{% tab name="Viam app" %}}
{{% tab name="web UI" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{{% tab name="web UI" %}}
{{% tab name="Web UI" %}}

[nit]


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

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

Expand Down
8 changes: 4 additions & 4 deletions docs/data-ai/ai/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ After training or uploading a machine learning model, use a machine learning (ML

## Deploy your ML model on an ML model service

1. Navigate to the **CONFIGURE** tab of one of your machine in the [Viam app](https://app.viam.com).
1. Navigate to the **CONFIGURE** tab of one of your machine.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
1. Navigate to the **CONFIGURE** tab of one of your machine.
1. Navigate to the **CONFIGURE** tab of one of your machines.

2. Add an ML model service that supports the ML model you want to use.
- For example, use the `ML model / TFLite CPU` service for TFlite ML models that you trained with Viam's built-in training.

Expand Down Expand Up @@ -73,11 +73,11 @@ Save your config to use your specified version of the ML model.

## How the ML model service works

The service works with models trained inside and outside the Viam app:
The service works with models trained on Viam or elsewhere:

- 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/models) in the **DATA** section of the Viam app.
- You can use [ML models](https://app.viam.com/registry?type=ML+Model) from the [registry](https://app.viam.com/registry).
- You can upload externally trained models from a model file on the [**MODELS** tab](https://app.viam.com/models).
- 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.

On its own the ML model service only runs the model.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-ai/ai/run-inference.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ If your vision service does not include an ML model, you must [deploy an ML mode

To use a vision service:

1. Visit the **CONFIGURE** page of the Viam app.
1. Visit your machine's **CONFIGURE** page.
1. Click the **+** icon next to your main machine part and select **Component or service**.
1. Type in the name of the service and select a vision service.
1. If your vision service does not include an ML model, [deploy an ML model to your machine](/data-ai/ai/deploy/) to use that service.
1. Configure the service based on your use case.
1. To view the deployed vision service, use the live detection feed in the Viam app.
1. To view the deployed vision service, use the live detection feed.
The feed shows an overlay of detected objects or classifications on top of a live camera feed.
On the **CONFIGURE** or **CONTROL** pages for your machine, expand the **Test** area of the service panel to view the feed.

Expand Down
4 changes: 2 additions & 2 deletions docs/data-ai/ai/train-tflite.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Follow this guide to use your image data to train an ML model, so that your mach

## Prerequisites

{{% expand "a machine connected to the Viam app" %}}
{{% expand "a machine connected to Viam" %}}

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

Expand All @@ -51,7 +51,7 @@ Now that you have a dataset that contains your labeled images, you are ready to
{{% tablestep number=1 %}}
**Find your training dataset**

In the Viam app, navigate to your list of [**DATASETS**](https://app.viam.com/data/datasets) and select the one you want to train on.
Navigate to your list of [**DATASETS**](https://app.viam.com/data/datasets) and select the one you want to train on.

{{% /tablestep %}}
{{% tablestep number=2 %}}
Expand Down
9 changes: 4 additions & 5 deletions docs/data-ai/ai/train.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ date: "2024-12-04"
---

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

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

## Submit a training job

After uploading the training script, you can run it by submitting a training job through the Viam app or using the Viam CLI or [ML Training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).
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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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).
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).

[ood nit]


{{< table >}}
{{% tablestep number=1 %}}
**Create the training job**

{{< tabs >}}
{{% tab name="Viam app" min-height="150px" %}}

In the Viam app, navigate to your list of [**DATASETS**](https://app.viam.com/data/datasets) and select the one you want to train a model on.
{{% tab name="web UI" min-height="150px" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{{% tab name="web UI" min-height="150px" %}}
{{% tab name="Web UI" min-height="150px" %}}

[nit]

Navigate to your list of [**DATASETS**](https://app.viam.com/data/datasets) and select the one you want to train a model on.

Click **Train model** and select **Train on a custom training script**, then follow the prompts.

Expand Down
2 changes: 1 addition & 1 deletion docs/data-ai/capture-data/capture-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For more information, see [How sync works](/data-ai/capture-data/advanced/how-sy

## Configure data capture and sync for individual resources

1. Navigate to a configured {{< glossary_tooltip term_id="resource" text="resource" >}} in **Builder** mode in the [Viam app](https://app.viam.com).
1. Navigate to a configured {{< glossary_tooltip term_id="resource" text="resource" >}} in **Builder** mode.
1. Find the **Data capture** section in the resource panel.
1. Click **+ Add method**.

Expand Down
4 changes: 2 additions & 2 deletions docs/data-ai/capture-data/conditional-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can also view [trigger-sync-examples module](https://github.com/viam-labs/tr

## Prerequisites

{{% expand "A running machine connected to the Viam app. Click to see instructions." %}}
{{% expand "A running machine connected to Viam. Click to see instructions." %}}

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

Expand Down Expand Up @@ -294,7 +294,7 @@ To test your setup, [configure a webcam](/operate/reference/components/camera/we
Make sure to physically connect any hardware parts to the computer controlling your machine.
For a camera component, use the `ReadImage` method.
The data manager will now capture data.
Go to the [**CONTROL** tab](/manage/troubleshoot/teleoperate/default-interface/#viam-app).
Go to the [**CONTROL** tab](/manage/troubleshoot/teleoperate/default-interface/#web-ui).
You should see the sensor.
Click on `GetReadings`.

Expand Down
4 changes: 2 additions & 2 deletions docs/data-ai/capture-data/filter-before-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,11 @@ Turn off data capture on your original camera if you haven't already, so that yo
**Save to start capturing**

Save the config.
With cloud sync enabled, captured data is automatically uploaded to the Viam app after a short delay.
With cloud sync enabled, captured data is automatically uploaded to Viam after a short delay.

{{% /tablestep %}}
{{% tablestep number=7 %}}
**View filtered data in the Viam app**
**View filtered data on Viam**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
**View filtered data on Viam**
**View filtered data in the Viam web UI**


Once you save your configuration, place something that is part of your trained ML model within view of your camera.

Expand Down
6 changes: 3 additions & 3 deletions docs/data-ai/data/advanced/alert-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can configure triggers to alert in the following scenarios:
{{< tabs >}}
{{% tab name="Builder mode" %}}

1. Go to the **CONFIGURE** tab of your machine on the [Viam app](https://app.viam.com).
1. Go to the **CONFIGURE** tab of your machine.
Click the **+** (Create) button in the left side menu and select **Trigger**.

{{<imgproc src="/build/configure/trigger-create.png" resize="x400" declaredimensions=true alt="The Create menu with Trigger at the bottom of the list of options." class="shadow" >}}
Expand Down Expand Up @@ -52,14 +52,14 @@ You can configure triggers to alert in the following scenarios:
To add an email notification:

1. Click **Add Email**.
{{<imgproc src="/build/configure/trigger-configured-email.png" resize="x400" style="width: 500px" declaredimensions=true alt="A trigger configured with an example email in the Viam app." class="shadow" >}}
{{<imgproc src="/build/configure/trigger-configured-email.png" resize="x400" style="width: 500px" declaredimensions=true alt="A trigger configured with an example email." class="shadow" >}}
1. Add the email you wish to be notified whenever this trigger is triggered.
1. Configure the time between notifications.

To add a webhook notification:

1. Click **Add Webhook**.
{{<imgproc src="/build/configure/trigger-configured.png" resize="x400" style="width: 500px" declaredimensions=true alt="A trigger configured with an example URL in the Viam app." class="shadow" >}}
{{<imgproc src="/build/configure/trigger-configured.png" resize="x400" style="width: 500px" declaredimensions=true alt="A trigger configured with an example URL." class="shadow" >}}
1. Add the URL of your cloud function.
1. Configure the time between notifications.
1. Write your cloud function to process the [webhook](/data-ai/reference/triggers-configuration/#webhook-attributes).
Expand Down
6 changes: 3 additions & 3 deletions docs/data-ai/data/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
linkTitle: "Export data"
title: "Export data"
weight: 40
description: "Download data from the Viam app using the data client API or the Viam CLI."
description: "Download data from Viam using the data client API or the CLI."
type: "docs"
tags: ["data management", "cloud", "sync"]
icon: true
Expand Down Expand Up @@ -43,7 +43,7 @@ To export your data from the cloud using the Viam CLI:
{{% tablestep number=1 %}}
**Filter the data you want to download**

Navigate to the [**DATA** page in the Viam app](https://app.viam.com/data/view).
Navigate to the [**DATA**](https://app.viam.com/data/view).
Copy link
Member

Choose a reason for hiding this comment

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

For example:

Suggested change
Navigate to the [**DATA**](https://app.viam.com/data/view).
Navigate to [Viam > DATA](https://app.viam.com/data/view).

Copy link
Collaborator

Choose a reason for hiding this comment

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

Or just this:

Suggested change
Navigate to the [**DATA**](https://app.viam.com/data/view).
Navigate to the [**DATA**](https://app.viam.com/data/view) page.


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

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

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

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.
If you want to store the data in a different location, change the specified folder with the [`--destination` flag](/dev/tools/cli/#named-arguments).
Expand Down
8 changes: 4 additions & 4 deletions docs/data-ai/data/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ languages: []
viamresources: ["sensor", "data_manager"]
platformarea: ["data", "core"]
date: "2024-12-03"
description: "Query sensor data that you have synced to the Viam app using the Viam app with SQL or MQL."
description: "Query sensor data that you have synced to Viam with SQL or MQL."
---

You can use the data management service to [capture sensor data](/data-ai/capture-data/capture-sync/) from any machine and sync that data to the cloud.
Expand All @@ -27,7 +27,7 @@ You can then run queries against that data to search for outliers or edge cases,

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

## Query data in the Viam app
## Query data in the web UI

### Prerequisites

Expand All @@ -36,9 +36,9 @@ See [capture sensor data](/data-ai/capture-data/capture-sync/) for more informat

### Query from the app

Once your data has synced, you can query your data from within the Viam app using {{< glossary_tooltip term_id="sql" text="SQL" >}} or {{< glossary_tooltip term_id="mql" text="MQL" >}}.
Once your data has synced, you can query your data from within web UI using {{< glossary_tooltip term_id="sql" text="SQL" >}} or {{< glossary_tooltip term_id="mql" text="MQL" >}}.

You must have the [owner role](/manage/manage/rbac/) in order to query data in the Viam app.
You must have the [owner role](/manage/manage/rbac/) in order to query data on Viam.

{{< table >}}
{{% tablestep number=1 %}}
Expand Down
Loading
Loading