Skip to content

Commit

Permalink
Fix more aliases and links (#3811)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Jan 8, 2025
1 parent 028ab84 commit eb3afc0
Show file tree
Hide file tree
Showing 75 changed files with 218 additions and 194 deletions.
2 changes: 1 addition & 1 deletion docs/data-ai/ai/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ aliases:
The Machine Learning (ML) model service allows you to deploy [machine learning models](/data-ai/ai/deploy/#deploy-your-ml-model) to your machine.
The service works with models trained inside and outside the Viam app:

- You can [train TFlite](/data-ai/ai/train-tflite/) or [other models](data-ai/ai/train/) on data from your machines.
- You can [train TFlite](/data-ai/ai/train-tflite/) or [other models](/data-ai/ai/train/) on data from your machines.
- You can upload externally trained models on the [**MODELS** tab](https://app.viam.com/data/models) in the **DATA** section of the Viam app.
- You can use [ML models](https://app.viam.com/registry?type=ML+Model) from the [Viam Registry](https://app.viam.com/registry).
- You can use a [model](/data-ai/ai/deploy/#deploy-your-ml-model) trained outside the Viam platform whose files are on your machine.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-ai/capture-data/advanced/how-sync-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ When the connection is restored and sync resumes, the service continues sync whe
If the interruption happens mid-file, sync resumes from the beginning of that file.

To avoid syncing files that are still being written to, the data management service only syncs arbitrary files that haven't been modified in the previous 10 seconds.
This default can be changed with the [`file_last_modified_millis` config attribute](/data-ai/capture-sync/#configure-the-data-management-service).
This default can be changed with the [`file_last_modified_millis` config attribute](/data-ai/capture-data/capture-sync/).

## Storage

Expand Down
2 changes: 1 addition & 1 deletion docs/data-ai/capture-data/conditional-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Also leave both **Capturing** and **Syncing** toggles in the "on" position.

{{% expand "Create a sensor module. Click to see instructions." %}}

Start by [creating a sensor module](/how-tos/sensor-module/).
Start by [creating a sensor module](/operate/get-started/other-hardware/).
Your sensor should have access to the information you need to determine if your machine should sync or not.
Based on that data, make the sensor return true when the machine should sync and false when it should not.
For example, if your want your machine to return data only during a specific time interval, your sensor needs to be able to access the time as well as be configured with the time interval during which you would like to sync data.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-ai/data/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Click **Copy export command**.
This copies the command, including your org ID and the filters you selected, to your clipboard.

{{% /tablestep %}}
{{% tablestep link="/cli/#data" %}}
{{% tablestep link="/dev/tools/cli/#data" %}}
**3. Run the command**

Run the copied command in a terminal:
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ aliases:

<div class="max-page frontpage">

Once you've set up your machine you can control your device and any attached physical hardware with [Viam APIs](/dev/reference/APIs), for example:
Once you've set up your machine you can control your device and any attached physical hardware with [Viam APIs](/dev/reference/apis/), for example:

{{< tabs class="horizontalheaders program" navheader="Examples">}}
{{% tab name="Drive a base" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/apis/fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The fleet management API supports the following methods:
To use the Viam fleet management API, you first need to instantiate a [`ViamClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient) and then instantiate an [`AppClient`](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient).
See the following example for reference.

You can create an [API key](/cloud/rbac/#api-keys) on your settings page.
You can create an [API key](/manage/manage/access/) on your settings page.

```python {class="line-numbers linkable-line-numbers"}
import asyncio
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/apis/ml-training-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The ML training client API supports the following methods:
To use the Viam ML training client API, you first need to instantiate a [`ViamClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient) and then instantiate an [`MLTrainingClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient.ml_training_client).
See the following example for reference.

You can create an [API key](/cloud/rbac/#api-keys) on your settings page.
You can create an [API key](/manage/manage/access/) on your settings page.

```python {class="line-numbers linkable-line-numbers"}
import asyncio
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/apis/services/vision.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ To get started using Viam's SDKs to connect to and control your machine, go to y

When executed, this sample code creates a connection to your machine as a client.

The following examples assume that you have a machine configured with a [camera](/operate/reference/components/camera/) and a vision service [detector](/operate/reference/services/vision/#detections), [classifier](/operate/reference/services/vision/#classifications) or [segmenter](/operate/reference/services/vision/#segmentations).
The following examples assume that you have a machine configured with a [camera](/operate/reference/components/camera/) and a vision service [detector](/dev/reference/apis/services/vision/#detections), [classifier](/dev/reference/apis/services/vision/#classifications) or [segmenter](/dev/reference/apis/services/vision/#segmentations).

{{< tabs >}}
{{% tab name="Python" %}}
Expand Down
12 changes: 6 additions & 6 deletions docs/dev/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ Users can now have [access to different fleet management capabilities](/manage/m

{{% changelog date="2023-11-30" color="added" title="Authenticate with location API key" %}}

You can now use [API keys for authentication](/sdks/#authentication).
You can now use [API keys for authentication](/dev/tools/cli/#authenticate).
API keys allow you to assign the minimum required permissions for usage.
Location secrets, the previous method of authentication, is deprecated and will be removed in a future release.

Expand Down Expand Up @@ -382,7 +382,7 @@ After you upload and train a machine learning model, you can test its results in

This allows you to refine models by iteratively tagging more images for training based on observed performance.

For more information, see [Test classification models with existing images in the cloud](/services/vision/mlmodel/#existing-images-in-the-cloud).
For more information, see [Test classification models with existing images in the cloud](/operate/reference/services/vision/mlmodel/#existing-images-in-the-cloud).

To use this update, the classifier must have been trained or uploaded after September 19, 2023.
The current version of this feature exclusively supports classification models.
Expand Down Expand Up @@ -968,7 +968,7 @@ You can replace existing Radius Clustering 3D segmenters by [configuring new one

#### Add and remove models using the machine config

You must add and remove models using the [machine config](/configure/).
You must add and remove models using the [machine config](/operate/get-started/supported-hardware/#configure-hardware-on-your-machine).
You will no longer be able to add or remove models using the SDKs.

#### Add machine learning vision models to a vision service
Expand All @@ -982,13 +982,13 @@ You will need to first register the machine learning model file with the [ML mod

You can now [train](/data-ai/ai/train-tflite/) and [deploy](/data-ai/ai/deploy/) image classification models with the [data management service](/data-ai/capture-data/capture-sync/) and use your machine's image data directly within Viam.
Additionally, you can upload and use existing [machine learning models](/data-ai/ai/deploy/#deploy-your-ml-model) with your machines.
For more information on using data synced to the cloud to train machine learning models, read [train a TFlite](/data-ai/ai/train-tflite/) or [another model](data-ai/ai/train/).
For more information on using data synced to the cloud to train machine learning models, read [train a TFlite](/data-ai/ai/train-tflite/) or [another model](/data-ai/ai/train/).

{{% /changelog %}}

{{% changelog date="2023-03-31" color="added" title="Motion planning with new `constraint` parameter" %}}

A new parameter, [`constraint`](/services/motion/constraints/), has been added to the [Motion service API](/dev/reference/apis/services/motion/#api), allowing you to define restrictions on the machine's movement.
A new parameter, [`constraint`](/operate/reference/services/motion/constraints/), has been added to the [Motion service API](/dev/reference/apis/services/motion/#api), allowing you to define restrictions on the machine's movement.
The constraint system also provides flexibility to specify that obstacles should only impact specific frames of a machine.

{{% /changelog %}}
Expand All @@ -999,7 +999,7 @@ You can now access {{< glossary_tooltip term_id="fragment" text="fragments" >}}
The configurations you added will now show up automatically in the **Builder** view on your machine's **CONFIGURE** tab.
This makes it easier to monitor what fragments you've added to your machine and how they're configured.

For more information, see [Fragments](/configure/#fragments).
For more information, see [Fragments](/manage/fleet/reuse-configuration/).

{{% /changelog %}}

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/glossary/type.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ In the {{< glossary_tooltip term_id="rdk" text="RDK" >}} architecture's {{< glos

However, the meaning of "type" can be context dependent across the Viam platform.

For example, when [configuring a machine](/configure/) in the [Viam app](https://app.viam.com), `"type"` is used in the JSON to indicate a particular implementation of a component or service, which is formally designated as the {{< glossary_tooltip term_id="subtype" text="subtype" >}}.
For example, when [configuring a machine](/operate/get-started/supported-hardware/#configure-hardware-on-your-machine) in the [Viam app](https://app.viam.com), `"type"` is used in the JSON to indicate a particular implementation of a component or service, which is formally designated as the {{< glossary_tooltip term_id="subtype" text="subtype" >}}.
6 changes: 3 additions & 3 deletions docs/dev/reference/try-viam/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,21 @@ The easiest way to try Viam is to [rent and remotely configure and control a Via
<tr>
<th>{{<imgproc src="/appendix/try-viam/try-viam-1.svg" class="fill alignright" style="width: 300px" declaredimensions=true alt="ALT">}}
<b>1. Click on TRY in Viam</b>
<p>Log into the Viam app and go to the <a href="https://app.viam.com/try">TRY tab</a>. Don’t have a Viam account? Follow the <a href="/cloud/account/#create-account-and-log-in">instructions to sign up</a> for an account.</p>
<p>Log into the Viam app and go to the <a href="https://app.viam.com/try">TRY tab</a>. Don’t have a Viam account? Follow the prompts to sign up for an account.</p>
</th>
</tr>
<tr>
<td>{{<imgproc src="/appendix/try-viam/try-viam-2.svg" class="fill alignleft" style="width: 300px" declaredimensions=true alt="ALT">}}
<b>2. Reserve your slot</b>
<p>If no one’s using a Viam Rover, you’ll take over immediately.
Otherwise, you’ll see an estimated time for the next slot, and we’ll send you an email when it’s your turn.
See <a href="/appendix/try-viam/reserve-a-rover/">detailed instructions</a>.</p>
See <a href="/dev/reference/try-viam/reserve-a-rover//">detailed instructions</a>.</p>
</td>
</tr>
<tr>
<td>{{<imgproc src="/appendix/try-viam/try-viam-3.svg" class="fill alignright" style="width: 300px" declaredimensions=true alt="ALT">}}
<b>3. Get started with Viam</b>
<p>Try a Viam Rover in our robotics lab. <a href="/cloud/machines/#control">Drive</a> or <a href="/tutorials/control/drive-rover/">program</a> the rover to see how you can build a machine with Viam.</a></p>
<p>Try a Viam Rover in our robotics lab. <a href="/manage/troubleshoot/teleoperate/default-interface/#viam-app">Drive</a> or <a href="/tutorials/control/drive-rover/">program</a> the rover to see how you can build a machine with Viam.</a></p>
</td>
</tr>
</table>
Expand Down
13 changes: 7 additions & 6 deletions docs/dev/reference/try-viam/reserve-a-rover.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ tags: ["try viam", "app"]
aliases:
- "/try-viam/reserve-a-rover/"
- "/get-started/try-viam/reserve-a-rover/"
- /appendix/try-viam/reserve-a-rover
toc_hide: true
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
Expand All @@ -18,7 +19,7 @@ date: "2022-01-01"
_Try Viam_ is a way to try out the Viam platform without setting up any hardware yourself.
You can take over a Viam Rover in our robotics lab to play around!

Watch this tutorial video for a walkthrough of Try Viam, including [how to reserve a Viam Rover](#using-the-reservation-system), [navigate the Viam platform](/fleet/), and [drive the rover](/components/base/wheeled/#test-the-base):
Watch this tutorial video for a walkthrough of Try Viam, including [how to reserve a Viam Rover](#using-the-reservation-system), [navigate the Viam platform](/operate/), and [drive the rover](/operate/reference/components/base/wheeled/#test-the-base):

{{<youtube embed_url="https://www.youtube-nocookie.com/embed/YYpZ9CVDwMU" max-width="600px">}}

Expand All @@ -38,7 +39,7 @@ Once your reservation starts and the system has configured your rover, click **T

### Limitations

When using a rented Viam rover, adding [modules](/registry/) is disabled for security purposes.
When using a rented Viam rover, adding {{< glossary_tooltip term_id="module" text="modules" >}} is disabled for security purposes.

### Extend your reservation

Expand Down Expand Up @@ -67,7 +68,7 @@ You can take over and play around with a Viam Rover in our robotics lab from any

1. Please notify Viam support on [our Community Discord](https://discord.gg/viam).
2. Use the **Add Viam Support** button on your machine's Location page to give Viam Support access to your _location_.
Refer to [Managing Locations and sub-locations](/cloud/locations/).
Refer to [Grant access](/manage/manage/access/#grant-access).

### Can I extend my time?

Expand Down Expand Up @@ -111,19 +112,19 @@ If you change the location, you must refresh the page.

### Which organization does this machine e belong to?

Your machine belongs to the [organization](/cloud/organizations/) you were in when you made the request.
Your machine belongs to the [organization](/manage/reference/organize/) you were in when you made the request.

### Can I share this Location with a friend to work on the machine together?

Sure, you can [invite other users to your organization](/cloud/locations/) to collaborate on your machine.
Sure, you can [invite other users to your organization](/manage/manage/access/#grant-access) to collaborate on your machine.
As members of your organization, those users have full control of your machine.
Another collaboration option is to use screen sharing in a Zoom or Webex session.

### How many active rentals can I have?

You can only borrow one rover at a time.
You cannot join the queue for another reservation while you have an active rental session.
If you would like to, you can [extend your reservation](/appendix/try-viam/reserve-a-rover/#can-i-extend-my-time).
If you would like to, you can [extend your reservation](/dev/reference/try-viam/reserve-a-rover/#extend-your-reservation).

### I loved my experience - can I play around more?

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/try-viam/rover-resources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you want a convenient mobile {{% glossary_tooltip term_id="base" text="base"%
The <a href="https://www.viam.com/resources/rover" target="_blank">Viam Rover 2</a> arrives preassembled with two encoded motors with suspension, a webcam with a microphone unit, a 6 axis IMU, power management and more.
It is primarily designed for use with a Raspberry Pi 4.
Featuring an anodized aluminum chassis with expandable mounting features, the rover can comfortably navigate indoor environments with a 20 lb payload.
You can customize your rover by mounting <a href="/components/sensor/">sensors</a>, <a href="/components/camera/">LiDAR</a>, and <a href="/components/arm/">arms</a>.
You can customize your rover by mounting <a href="/operate/reference/components/sensor/">sensors</a>, <a href="/operate/reference/components/camera/">LiDAR</a>, and <a href="/operate/reference/components/arm/">arms</a>.
</p>
</div>
</div>
Expand Down
15 changes: 8 additions & 7 deletions docs/dev/reference/try-viam/rover-resources/rover-tutorial-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ All together, your kit looks like this:
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/encoder-motors.jpg" resize="400x" declaredimensions=true alt="two motors with encoders" >}}

The motors come with integrated encoders.
For information on encoders, see [Encoder Component](/components/encoder/).
For more information on encoded DC motors, see [Encoded Motors](/components/motor/encoded-motor/).
For information on encoders, see [Encoder Component](/operate/reference/components/encoder/).
For more information on encoded DC motors, see [Encoded Motors](/operate/reference/components/motor/encoded-motor/).

The kit also includes stiffer suspension springs that you can substitute for the ones on the rover.
Generally, a stiff suspension helps with precise steering control.
Expand All @@ -90,7 +90,7 @@ L298 is a high voltage and high current motor drive chip, and H-Bridge is typica
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/webcam.jpg" resize="400x" declaredimensions=true alt="Webcam with cables" >}}

The webcam that comes with the kit is a standard USB camera device and the rover has a custom camera mount for it.
For more information, see [Camera Component](/components/camera/).
For more information, see [Camera Component](/operate/reference/components/camera/).

### 3D accelerometer

Expand All @@ -99,7 +99,7 @@ For more information, see [Camera Component](/components/camera/).
The [ADXL345](https://github.com/viam-modules/analog-devices/) sensor manufactured by Analog Devices is a digital 3-axis accelerometer that can read acceleration up to ±16g for high-resolution (13-bit) measurements.
You can access it with a SPI (3-wire or 4-wire) or I<sup>2</sup>C digital interface.

In Viam, you can configure it as a [movement sensor component](/components/movement-sensor/).
In Viam, you can configure it as a [movement sensor component](/operate/reference/components/movement-sensor/).

### Buck converter

Expand Down Expand Up @@ -167,7 +167,8 @@ This is the recommended order to assemble your rover:

### Install Raspberry Pi OS

Install a 64-bit Raspberry Pi OS onto your Pi following our [Raspberry Pi installation guide](/installation/prepare/rpi-setup/). Follow all steps as listed, including the final step, [Enable communication protocols](/installation/prepare/rpi-setup/#enable-communication-protocols), which is required to enable the accelerometer on your rover.
Install a 64-bit Raspberry Pi OS onto your Pi following our [Raspberry Pi installation guide](/operate/reference/prepare/rpi-setup/).
Follow all steps as listed, including the final step, [Enable communication protocols](/operate/reference/prepare/rpi-setup/#enable-communication-protocols), which is required to enable the accelerometer on your rover.

### Attach the Raspberry Pi to the Rover

Expand Down Expand Up @@ -280,8 +281,8 @@ The following are just a few ideas, but you can expand or modify the rover kit w

- For GPS navigation, we support NMEA (using serial and I<sup>2</sup>C) and RTK.
Make and model don't make a difference as long as you use these protocols.
See [Movement Sensor Component](/components/movement-sensor/) for more information.
- For [LiDAR laser range scanning](/services/slam/cartographer/), we recommend RPlidar (including A1, which is a sub-$100 LIDAR).
See [Movement Sensor Component](/operate/reference/components/movement-sensor/) for more information.
- For [LiDAR laser range scanning](/operate/reference/services/slam/cartographer/), we recommend RPlidar (including A1, which is a sub-$100 LIDAR).
- For robot arms, we tried the [Yahboom DOFBOT robotics arm](https://category.yahboom.net/products/dofbot-jetson_nano) with success.

### Mount an RPlidar to the rover
Expand Down
Loading

0 comments on commit eb3afc0

Please sign in to comment.