Skip to content

Commit

Permalink
Additional changes
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel committed Nov 4, 2024
1 parent b0d7a3d commit 986caca
Show file tree
Hide file tree
Showing 13 changed files with 44 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ swap:
Viam App: Viam app
viam registry: Viam Registry
Viam registry: Viam Registry
viam agent: Viam Agent
Viam agent: Viam Agent
viam cloud: Viam Cloud
Viam cloud: Viam Cloud
RPLIDAR: RPlidar
Rplidar: RPlidar
Viam platform: Viam platform
Expand Down
2 changes: 1 addition & 1 deletion docs/appendix/apis/data-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ date: "2024-09-19"
# updated: "" # When the content was last entirely checked
---

The data client API allows you to upload and retrieve data to and from the Viam cloud.
The data client API allows you to upload and retrieve data to and from the Viam Cloud.

{{% alert title="Support Notice" color="note" %}}

Expand Down
4 changes: 2 additions & 2 deletions docs/appendix/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The built-in `pi` sensor and board models have moved to the [`raspberry-pi` modu

{{% changelog date="2024-10-16" color="added" title="Set data retention policies" %}}

You can now set how long data collected by a component should remain stored in the Viam cloud in the component's data capture configuration.
You can now set how long data collected by a component should remain stored in the Viam Cloud in the component's data capture configuration.
For more information, see [Data management service](/services/data/).

{{% /changelog %}}
Expand Down Expand Up @@ -223,7 +223,7 @@ The dual GPS movement sensor calculates a compass heading from both GPS sensors,
{{% changelog date="2024-03-01" color="added" title="Viam Agent" %}}

You can now use the [Viam Agent](/fleet/provision/) to provision your machine or fleet of machines during deployment.
The Viam agent is a software provisioning manager that you can install on your machine which manages your `viam-server` installation, including installation and ongoing updates, as well as providing flexible deployment configuration options, such as pre-configured WiFi network credentials.
The Viam Agent is a software provisioning manager that you can install on your machine which manages your `viam-server` installation, including installation and ongoing updates, as well as providing flexible deployment configuration options, such as pre-configured WiFi network credentials.

{{% /changelog %}}

Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This page provides an overview of how a machine is structured, including on-devi
- [Basic machine example](#basic-machine-example)
- [Structure of more complex machines](#complex-machines-with-multiple-parts)

{{<imgproc class="imgzoom" src="/architecture/architecture-diagram.svg" resize="x1100" declaredimensions=true alt="Viam-server runs on your machine and communicates with processes running on your machine, with the Viam cloud, with API clients, and with other machines running viam-server." >}}
{{<imgproc class="imgzoom" src="/architecture/architecture-diagram.svg" resize="x1100" declaredimensions=true alt="Viam-server runs on your machine and communicates with processes running on your machine, with the Viam Cloud, with API clients, and with other machines running viam-server." >}}

## `viam-server` and `viam-micro-server`

Expand Down Expand Up @@ -117,7 +117,7 @@ Viam uses API keys with [role-based access control (RBAC)](/cloud/rbac/) to cont
{{<imgproc src="/architecture/data-flow.svg" resize="x1100" declaredimensions=true alt="Data flowing from local disk to cloud to the Viam app, SDKs, and MQL and SQL queries." >}}
<br>

Data is captured and synced to the Viam cloud as follows:
Data is captured and synced to the Viam Cloud as follows:

1. Data collected by your resources, such as sensors and cameras, is first stored locally in a specified directory (defaults to <file>~/.viam/capture</file>).
You control what data to capture, how often to capture it, and where to store it using the configuration in the Viam app.
Expand Down
42 changes: 21 additions & 21 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -495,8 +495,8 @@ done
| `tag` | Add or remove tags from data matching the ids or filter. | `ids`, `filter` |
| `database configure` | Create a new database user for the Viam organization's MongoDB Atlas Data Federation instance, or change the password of an existing user. See [Configure data query](/how-tos/sensor-data-query-with-third-party-tools/#configure-data-query). | - |
| `database hostname` | Get the MongoDB Atlas Data Federation instance hostname and connection URI. See [Configure data query](/how-tos/sensor-data-query-with-third-party-tools/#configure-data-query). | - |
| `delete binary` | Delete binary data from the Viam cloud. | - |
| `delete tabular` | Delete tabular data from the Viam cloud. | - |
| `delete binary` | Delete binary data from the Viam Cloud. | - |
| `delete tabular` | Delete tabular data from the Viam Cloud. | - |
| `--help` | Return help | - |
##### Positional arguments: `tag`
Expand Down Expand Up @@ -1092,7 +1092,7 @@ See [create an organization API key](#create-an-organization-api-key) for more i
### `packages`
The `packages` command allows you to upload packages to the Viam cloud or export packages from the Viam cloud.
The `packages` command allows you to upload packages to the Viam Cloud or export packages from the Viam Cloud.
```sh {class="command-line" data-prompt="$"}
viam packages upload --org-id=<org-id> --name=<package-name> --version=<version> --type=<type> --path=<path-to-package.tar.gz>
Expand All @@ -1111,8 +1111,8 @@ viam packages export --org-id=123 --name=MyMLModel --version=latest --type=ml_mo
<!-- prettier-ignore -->
| Command option | Description | Positional arguments |
| -------------- | ----------- | -------------------- |
| `upload` | Upload a package to the Viam cloud | - |
| `export` | Download a package from the Viam cloud | - |
| `upload` | Upload a package to the Viam Cloud | - |
| `export` | Download a package from the Viam Cloud | - |
##### Named arguments
Expand Down Expand Up @@ -1315,25 +1315,25 @@ viam train list --org-id=<org-id> --job-status=<job-status>
Examples:
```sh {class="command-line" data-prompt="$"}
# submit training job on data in Viam cloud with a Viam-managed training script
# submit training job on data in Viam Cloud with a Viam-managed training script
viam train submit managed --dataset-id=456 --model-org-id=123 --model-name=MyCoolClassifier --model-type=single_label_classification --model-labels=1,2,3
# submit custom training job with an existing training script in the Registry on data in Viam cloud
# submit custom training job with an existing training script in the Registry on data in Viam Cloud
viam train submit custom from-registry --dataset-id=<INSERT DATASET ID> --org-id=<INSERT ORG ID> --model-name=MyRegistryModel --model-version=2 --version=1 --script-name=mycompany:MyCustomTrainingScript --args=num_epochs=3,model_type=multi_label
# submit custom training job with an uploaded training script on data in Viam cloud
# submit custom training job with an uploaded training script on data in Viam Cloud
viam train submit custom with-upload --dataset-id=<INSERT DATASET ID> --model-org-id=<INSERT ORG ID> --model-name=MyRegistryModel --model-type=single_label_classification --model-version=2 --version=1 --path=<path-to-tar.gz> --script-name=mycompany:MyCustomTrainingScript --args=num_epochs=3,labels="'green_square blue_star'"
# get a training job from Viam cloud based on training job ID
# get a training job from Viam Cloud based on training job ID
viam train get --job-id=123
# get training job logs from Viam cloud based on training job ID
# get training job logs from Viam Cloud based on training job ID
viam train logs --job-id=123
# cancel training job in Viam cloud based on training job ID
# cancel training job in Viam Cloud based on training job ID
viam train cancel --job-id=123
# list training jobs in Viam cloud based on organization ID and job status
# list training jobs in Viam Cloud based on organization ID and job status
viam train list --org-id=123 --job-status=completed
```
Expand All @@ -1342,27 +1342,27 @@ viam train list --org-id=123 --job-status=completed
<!-- prettier-ignore -->
| Command option | Description | Positional arguments |
| -------------- | ----------- | -------------------- |
| `submit` | Submits training job on data in the Viam cloud. | `managed`, `custom` |
| `get` | Gets a training job from the Viam cloud based on training job ID. | - |
| `logs` | Gets the logs of a training job from the Viam cloud based on training job ID. | - |
| `cancel` | Cancels training job in the Viam cloud based on training job ID. | - |
| `list` | Lists training jobs in Viam cloud based on organization ID and job status. | - |
| `submit` | Submits training job on data in the Viam Cloud. | `managed`, `custom` |
| `get` | Gets a training job from the Viam Cloud based on training job ID. | - |
| `logs` | Gets the logs of a training job from the Viam Cloud based on training job ID. | - |
| `cancel` | Cancels training job in the Viam Cloud based on training job ID. | - |
| `list` | Lists training jobs in Viam Cloud based on organization ID and job status. | - |
##### Positional arguments: `submit`
<!-- prettier-ignore -->
| Argument | Description | Positional Arguments |
| -------- | ----------- | -------------------- |
| `managed` | Submits training job on data in the Viam cloud with a Viam-managed training script. | - |
| `custom` | Submits custom training job on data in the Viam cloud. | `from-registry`, `with-upload` |
| `managed` | Submits training job on data in the Viam Cloud with a Viam-managed training script. | - |
| `custom` | Submits custom training job on data in the Viam Cloud. | `from-registry`, `with-upload` |
##### Position arguments: `submit custom`
<!-- prettier-ignore -->
| Argument | Description |
| -------- | ----------- |
| `from-registry` | Submit custom training job with an existing training script in the registry on data in the Viam cloud. |
| `with-upload` | Upload a draft training script and submit a custom training job on data in the Viam cloud. |
| `from-registry` | Submit custom training job with an existing training script in the registry on data in the Viam Cloud. |
| `with-upload` | Upload a draft training script and submit a custom training job on data in the Viam Cloud. |
##### Named arguments
Expand Down
4 changes: 2 additions & 2 deletions docs/fleet/data-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Export data with the Viam CLI and download your data for offline access.
{{% /manualcard %}}
{{% manualcard title="Upload a batch of data" link="/how-tos/upload-data/" %}}

Upload data to the Viam cloud from your computer or mobile device using the data client API, the Viam CLI, or the Viam mobile app.
Upload data to the Viam Cloud from your computer or mobile device using the data client API, the Viam CLI, or the Viam mobile app.

{{% /manualcard %}}
{{< /cards >}}
Expand All @@ -82,7 +82,7 @@ The [data client API](/appendix/apis/data-client/) supports the following method

<br>

Methods to upload data like images or sensor readings directly to the Viam cloud:
Methods to upload data like images or sensor readings directly to the Viam Cloud:

{{< readfile "/static/include/app/apis/generated/data_sync-table.md" >}}

Expand Down
2 changes: 1 addition & 1 deletion docs/fleet/provision.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ It also configures timeouts to control how long `viam-agent` waits for a valid l
| `manufacturer` | string | Optional | Purely informative. May be displayed on captive portal or provisioning app. Default: `"viam"`. |
| `model` | string | Optional | Purely informative. May be displayed on captive portal or provisioning app. Default: `"custom"`. |
| `fragment_id` | string | Optional | The `fragment_id` of the fragment to configure machines with. Required when using the Viam mobile app for provisioning. The Viam mobile app uses the fragment to configure the machine. |
| `hotspot_prefix` | string | Optional | Viam agent will prepend this to the hostname of the device and use the resulting string for the provisioning hotspot SSID. Default: `"viam-setup"`. |
| `hotspot_prefix` | string | Optional | `viam-agent` will prepend this to the hostname of the device and use the resulting string for the provisioning hotspot SSID. Default: `"viam-setup"`. |
| `disable_dns_redirect` | boolean | Optional | By default, ALL DNS lookups using the provisioning hotspot will redirect to the device. This causes most phones/mobile devices to automatically redirect the user to the captive portal as a "sign in" screen. When disabled, only domains ending in .setup (ex: viam.setup) will be redirected. This generally avoids displaying the portal to users and is mainly used in conjunction with a mobile provisioning application workflow. Default: `false`. |
| `hotspot_password` | string | Optional | The Wifi password for the provisioning hotspot. Default: `"viamsetup"`. |
| `roaming_mode` | boolean | Optional | By default, the device will only attempt to connect to a single wifi network (the one with the highest priority), provided during initial provisioning/setup using the provisioning mobile app or captive web portal. Wifi connection alone is enough to consider the device as "online" even if the global internet is not reachable. If the primary network configured during provisioning cannot be connected to and roaming mode is enabled, the device will attempt connections to all configured networks in `networks`, and only consider the device online if the internet is reachable. Default: `false`. |
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/upload-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ You can also turn off **Syncing** unless you have other directories you'd like t

## Upload data with Python

You can use the Python data client API [`file_upload_from_path`](/appendix/apis/data-client/#fileuploadfrompath) method to upload one or more files from your computer to the Viam cloud.
You can use the Python data client API [`file_upload_from_path`](/appendix/apis/data-client/#fileuploadfrompath) method to upload one or more files from your computer to the Viam Cloud.

{{% alert title="Note" color="note" %}}

Expand Down
2 changes: 1 addition & 1 deletion docs/registry/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The [Viam Registry](https://app.viam.com/registry) is the storage and distributi
{{% /manualcard %}}
{{% manualcard link="/registry/training-scripts/" %}}

**Training scripts** to train and produce ML models in the Viam cloud for custom machine learning
**Training scripts** to train and produce ML models in the Viam Cloud for custom machine learning

{{% /manualcard %}}
{{< /cards >}}
10 changes: 5 additions & 5 deletions docs/services/data/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ However, if you want to manage your machine's captured data yourself, you can en
{{% /tab %}}
{{% tab name="viam-micro-server" %}}

The data is captured in the ESP32's flash memory until it is uploaded to the Viam cloud.
The data is captured in the ESP32's flash memory until it is uploaded to the Viam Cloud.

If the machine restarts before all data is synced, all unsynced data captured since the last sync point is lost.

Expand Down Expand Up @@ -85,7 +85,7 @@ To avoid syncing files that are still being written to, the data management serv

Data that is successfully synced to the cloud is automatically deleted from local storage.

When a machine loses its internet connection, it cannot resume cloud sync until it can reach the Viam cloud again.
When a machine loses its internet connection, it cannot resume cloud sync until it can reach the Viam Cloud again.

{{<imgproc src="/services/data/data_management.png" resize="x1100" declaredimensions=true alt="Data is captured on the machine, uploaded to the cloud, and then deleted off local storage." class="imgzoom" >}}

Expand Down Expand Up @@ -203,7 +203,7 @@ The following attributes are available for the data management service:
| `additional_sync_paths` | string array | Optional | Paths to any other directories on your machine from which you want to sync data to the cloud. Once data is synced from a directory, it is automatically deleted from your machine. | <p class="center-text"><i class="fas fa-times" title="no"></i></p> |
| `sync_interval_mins` | float | Optional | Time interval in minutes between syncing to the cloud. Viam does not impose a minimum or maximum on the frequency of data syncing. However, in practice, your hardware or network speed may impose limits on the frequency of data syncing. <br> Default: `0.1`, meaning once every 6 seconds. | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
| `delete_every_nth_when_disk_full` | int | Optional | How many files to delete when local storage meets the [fullness criteria](/services/data/#storage). The data management service will delete every Nth file that has been captured upon reaching this threshold. Use JSON mode to configure this attribute. <br> Default: `5`, meaning that every fifth captured file will be deleted. | <p class="center-text"><i class="fas fa-times" title="no"></i></p> |
| `maximum_num_sync_threads` | int | Optional | Max number of CPU threads to use for syncing data to the Viam cloud. <br> Default: [runtime.NumCPU](https://pkg.go.dev/runtime#NumCPU)/2 so half the number of logical CPUs available to viam-server | <p class="center-text"><i class="fas fa-times" title="no"></i></p> |
| `maximum_num_sync_threads` | int | Optional | Max number of CPU threads to use for syncing data to the Viam Cloud. <br> Default: [runtime.NumCPU](https://pkg.go.dev/runtime#NumCPU)/2 so half the number of logical CPUs available to viam-server | <p class="center-text"><i class="fas fa-times" title="no"></i></p> |
| `cache_size_kb` | float | Optional | `viam-micro-server` only. The maximum amount of storage bytes (in kilobytes) allocated to a data collector. <br> Default: `1` KB. | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |

### Resource data capture configuration
Expand Down Expand Up @@ -658,7 +658,7 @@ The following attributes are available for data capture configuration:
| ------------------ | ------ | --------- | ----------- |
| `capture_frequency_hz` | float | **Required** | Frequency in hertz at which to capture data. For example, to capture a reading every 2 seconds, enter `0.5`. |
| `method` | string | **Required** | Depends on the type of component or service. See [Supported components and services](/services/data/#supported-components-and-services). |
| `retention_policy` | object | Optional | Option to configure how long data collected by this component should remain stored in the Viam cloud. You must set this in JSON mode. See the JSON example for a camera component. Options: `"days": <int>`. Days are in UTC time. Setting a retention policy of 1 day means that data stored now will be deleted the following day **in UTC time**. |
| `retention_policy` | object | Optional | Option to configure how long data collected by this component should remain stored in the Viam Cloud. You must set this in JSON mode. See the JSON example for a camera component. Options: `"days": <int>`. Days are in UTC time. Setting a retention policy of 1 day means that data stored now will be deleted the following day **in UTC time**. |
| `additional_params` | depends | depends | Varies based on the method. For example, `ReadImage` requires a MIME type. |

### Supported components and services
Expand Down Expand Up @@ -703,7 +703,7 @@ You can also access data from a resource, machine part, or machine menu.
## Considerations

- **Capturing too much data**: You can [use filtering to collect and sync only certain images](/how-tos/image-data/#use-filtering-to-collect-and-sync-only-certain-images) to capture data selectively.
- **Rentention policy**: Set a `retention_policy` attribute in your [data capture configuration](#resource-data-capture-configuration) to avoid keeping data stored in the Viam cloud longer than a specified number of days.
- **Rentention policy**: Set a `retention_policy` attribute in your [data capture configuration](#resource-data-capture-configuration) to avoid keeping data stored in the Viam Cloud longer than a specified number of days.
- **Pausing sync**: You can pause cloud sync at any time by navigating to your machine's **CONFIGURE** tab and disabling **Syncing** for your [data management service](../).

If you have captured data that you do not want to sync, delete the data on the machine before resuming cloud sync.
Expand Down
Loading

0 comments on commit 986caca

Please sign in to comment.