Skip to content

Commit

Permalink
Make Viam Registry capitalization consistent (#3647)
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Nov 4, 2024
1 parent 508627d commit 5d6d1cd
Show file tree
Hide file tree
Showing 27 changed files with 104 additions and 98 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ action:
swap:
viam app: Viam app
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
8 changes: 4 additions & 4 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 All @@ -235,7 +235,7 @@ You can now use the [generic service](/services/generic/) to define new, unique

{{% changelog date="2024-02-12" color="added" title="ML models in the registry" %}}

You can now upload [machine learning (ML) models](/registry/ml-models/) to the Viam registry, in addition to modules.
You can now upload [machine learning (ML) models](/registry/ml-models/) to the Viam Registry, in addition to modules.
You may upload models you have trained yourself using the Viam app, or models you have trained outside of the App.
When uploading, you have the option to make your model available to the general public for reuse.

Expand Down Expand Up @@ -446,7 +446,7 @@ Sessions are enabled by default, with the option to [disable sessions](/appendix

{{% changelog date="2023-06-30" color="added" title="Connect an ODrive motor controller as a Viam module" %}}

You can integrate and control ODrive motor controllers with Viam using the [`odrive` module from the Viam registry](https://github.com/viamrobotics/odrive).
You can integrate and control ODrive motor controllers with Viam using the [`odrive` module from the Viam Registry](https://github.com/viamrobotics/odrive).

See the [Odrive module readme](https://github.com/viamrobotics/odrive) to learn how to connect and use an ODrive motor controller with Viam, and view the sample configurations.

Expand Down
2 changes: 1 addition & 1 deletion docs/appendix/glossary/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ short_description: A module provides one or more modular resources, which add re
A _module_ provides one or more {{< glossary_tooltip term_id="modular-resource" text="modular resources" >}}, which add {{< glossary_tooltip term_id="resource" text="resource" >}} {{< glossary_tooltip term_id="type" text="types" >}} or {{< glossary_tooltip term_id="model" text="models" >}} that are not built into Viam.
Modules run alongside `viam-server` as separate process, communicating with `viam-server` over UNIX sockets.

You can [create your own module](/how-tos/create-module/) or [add existing modules from the Viam registry](/registry/modular-resources/).
You can [create your own module](/how-tos/create-module/) or [add existing modules from the Viam Registry](/registry/modular-resources/).

For more information see the [modular resource documentation](/registry/).
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
60 changes: 30 additions & 30 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The CLI lets you:
- Retrieve [organization](/cloud/organizations/) and location information
- Manage [machine fleet](/fleet/) data and logs
- Control machines by issuing component and service commands
- Upload and manage [modular resources](/registry/) in the Viam registry
- Upload and manage [modular resources](/registry/) in the Viam Registry

For example, this CLI command moves a servo to the 75 degree position:

Expand Down 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 @@ -623,7 +623,7 @@ This includes:
- Creating metadata for a {{< glossary_tooltip term_id="resource" text="modular resource" >}}
- Uploading a new module to the [Viam registry](https://app.viam.com/registry)
- Uploading a new version of your module to the [Viam registry](https://app.viam.com/registry)
- Updating an existing module in the Viam registry
- Updating an existing module in the Viam Registry
- Updating a module's metadata file based on models it provides
- Building your module for different architectures using cloud runners
- Building a module locally and running it on a target device. Rebuilding & restarting if already running.
Expand Down Expand Up @@ -679,7 +679,7 @@ viam module build logs --wait --id=$(viam module build start --version "0.1.2")
# restart a module running on your local viam-server, by name, without building or reconfiguring
viam module reload --restart-only --id viam:python-example-module
# upload a new or updated custom module to the Viam registry:
# upload a new or updated custom module to the Viam Registry:
viam module upload --version=1.0.0 --platform=darwin/arm64 packaged-module.tar.gz
```

Expand All @@ -692,7 +692,7 @@ viam module upload --version=1.0.0 --platform=darwin/arm64 packaged-module.tar.g
| `create` | Generate new metadata for a custom module on your local filesystem. | - |
| `update` | Update an existing custom module on your local filesystem with recent changes to the [`meta.json` file](#the-metajson-file). Note that the `upload` command automatically runs `update` for you; you do not need to explicitly run `update` if you are also running `upload`. | - |
| `update-models` | Update the module's metadata file with the models it provides. | - |
| `upload` | Validate and upload a new or existing custom module on your local filesystem to the Viam registry. See [Upload validation](#upload-validation) for more information. | **module-path** : specify the path to the file, directory, or compressed archive (with `.tar.gz` or `.tgz` extension) that contains your custom module code. |
| `upload` | Validate and upload a new or existing custom module on your local filesystem to the Viam Registry. See [Upload validation](#upload-validation) for more information. | **module-path** : specify the path to the file, directory, or compressed archive (with `.tar.gz` or `.tgz` extension) that contains your custom module code. |
| `reload` | Build a module locally and run it on a target device. Rebuild and restart if it is already running. | - |
| `build start` | Start a module build in a cloud runner using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand). | - |
| `build local` | Start a module build locally using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand). | - |
Expand Down Expand Up @@ -724,10 +724,10 @@ viam module upload --version=1.0.0 --platform=darwin/arm64 packaged-module.tar.g

All of the `module` commands accept either the `--org-id` or `--public-namespace` argument.

- Use the `--public-namespace` argument to supply the [namespace](/cloud/organizations/#create-a-namespace-for-your-organization) of your organization. This will upload your module to the Viam registry and share it with other users.
- Use the `--public-namespace` argument to supply the [namespace](/cloud/organizations/#create-a-namespace-for-your-organization) of your organization. This will upload your module to the Viam Registry and share it with other users.
- Use the `--org-id` to provide your organization ID instead, This will upload your module privately within your organization.

You may use either argument for the `viam module create` command, but must use `--public-namespace` for the `update` and `upload` commands when uploading as a public module (`"visibility": "public"`) to the Viam registry.
You may use either argument for the `viam module create` command, but must use `--public-namespace` for the `update` and `upload` commands when uploading as a public module (`"visibility": "public"`) to the Viam Registry.

##### Using the `--platform` argument

Expand Down Expand Up @@ -757,7 +757,7 @@ Use the _same version number_ when running multiple `upload` commands of the sam
If you specify a platform that includes `any` (such as `any`, `any/amd64`, or `linux/any`), a machine that deploys your module will select the _most restrictive_ architecture from the ones you have provided for your module.
For example, if you upload your module with support for `any/amd64` and then also upload with support for `linux/amd64`, a machine running the `linux/amd64` architecture deploys the `linux/amd64` version, while a machine running the `darwin/amd64` architecture deploys the `any/amd64` version.

The Viam registry page for your module displays the platforms your module supports for each version you have uploaded.
The Viam Registry page for your module displays the platforms your module supports for each version you have uploaded.

If you are using the `build logs` command, the `--platform` argument instead restricts the logs returned by the command to only those build jobs that match the specified platform.

Expand All @@ -766,7 +766,7 @@ If you are using the `build logs` command, the `--platform` argument instead res
The `--version` argument accepts a valid [semver 2.0](https://semver.org/) version (example: `1.0.0`).
You set an initial version for your custom module with your first `viam module upload` command for that module, and can later increment the version with subsequent `viam module upload` commands.

Once your module is uploaded, users can select which version of your module to use on their machine from your module's page on the Viam registry.
Once your module is uploaded, users can select which version of your module to use on their machine from your module's page on the Viam Registry.
Users can choose to pin to a specific patch version, permit upgrades within major release families or only within minor releases, or permit continuous updates.
When you `update` a module configuration and then `upload` it, the `entrypoint` for that module defined in the [`meta.json` file](#the-metajson-file) is associated with the specific `--version` for that `upload`.
Expand All @@ -784,7 +784,7 @@ The following criteria are checked for every `upload`:
##### The `meta.json` file
When uploading a custom module, the Viam registry tracks your module's metadata in a `meta.json` file.
When uploading a custom module, the Viam Registry tracks your module's metadata in a `meta.json` file.
This file is created for you when you run the `viam module generate` or `viam module create` command, with the `module_id` field pre-populated based on the `--name` you provided to `create`.
If you later make changes to this file, you can register those changes with the Viam registry by using the `viam module update` command.

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
2 changes: 1 addition & 1 deletion docs/cloud/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ You can also use the [Viam mobile app](/fleet/control/#control-interface-in-the-

### Create a namespace for your organization

When uploading [custom modules](/registry/) to the Viam registry, you must set a namespace for your organization to associate your module with.
When uploading [custom modules](/registry/) to the Viam Registry, you must set a namespace for your organization to associate your module with.

To create a new namespace for your organization, click on the Org's **Settings** in the top right of the navigation bar, then click the **Set a public namespace** button.
Enter a name or use the suggested name for your namespace, and then click **Set namespace**.
Expand Down
Loading

0 comments on commit 5d6d1cd

Please sign in to comment.