Upload external data for training

1. Organize your data

Put the data you want to sync in a directory on your machine. All of the data in the folder will be synced, so be sure that you want to upload all of the contents of the folder.

2. Configure sync from the additional folder

In the Additional paths, enter the full path to the directory where the data you want to upload is stored, for example, /Users/Artoo/my_cat_photos.

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

Click Save in the top right corner of the page.

3. Confirm that your data uploaded

Navigate to your DATA page in the Viam app and confirm that your data appears there. If you don’t see your files yet, wait a few moments and refresh the page.

4. Remove the folder path

Once the data has uploaded, navigate back to your data service config. You can now delete the additional path you added. You can also turn off Syncing unless you have other directories you’d like to continue to sync from.

1. Get API key

Go to your organization’s setting page and create an API key for your individual machine part, machine, location, or organization.

2. Add a file_upload_from_path API call

Create a Python script and use the file_upload_from_path method to upload your data, depending on whether you are uploading one or multiple files:

import asyncio

from viam.rpc.dial import DialOptions, Credentials
from viam.app.viam_client import ViamClient


async def connect() -> ViamClient:
    dial_options = DialOptions(
      credentials=Credentials(
        type="api-key",
        # Replace "<API-KEY>" (including brackets) with your machine's API key
        payload='<API-KEY>',
      ),
      # Replace "<API-KEY-ID>" (including brackets) with your machine's
      # API key ID
      auth_entity='<API-KEY-ID>'
    )
    return await ViamClient.create_from_dial_options(dial_options)


async def main():
    # Make a ViamClient
    viam_client = await connect()
    # Instantiate a DataClient to run data client API methods on
    data_client = viam_client.data_client
    await data_client.file_upload_from_path(
      # The ID of the machine part the file should be associated with
      part_id="abcdefg-1234-abcd-5678-987654321xyzabc",
      # Any tags you want to apply to this file
      tags=["cat", "animals", "brown"],
      # Path to the file
      filepath="/Users/Artoo/my_cat_photos/brown-cat-on-a-couch.png"
    )

    viam_client.close()

if __name__ == "__main__":
    asyncio.run(main())

import asyncio
import os

from viam.rpc.dial import DialOptions, Credentials
from viam.app.viam_client import ViamClient


async def connect() -> ViamClient:
    dial_options = DialOptions(
      credentials=Credentials(
        type="api-key",
        # Replace "<API-KEY>" (including brackets) with your machine's API key
        payload='<API-KEY>',
      ),
      # Replace "<API-KEY-ID>" (including brackets) with your machine's
      # API key ID
      auth_entity='<API-KEY-ID>'
    )
    return await ViamClient.create_from_dial_options(dial_options)


async def main():
    # Make a ViamClient
    viam_client = await connect()
    # Instantiate a DataClient to run data client API methods on
    data_client = viam_client.data_client
    # Specify directory from which to upload data
    my_data_directory = "/Users/Artoo/my_cat_photos"

    for file_name in os.listdir(my_data_directory):
        await data_client.file_upload_from_path(
          part_id="abcdefg-1234-abcd-5678-987654321xyzabc",
          tags=["cat", "animals", "brown"],
          filepath=os.path.join(my_data_directory, file_name)
        )

    viam_client.close()

if __name__ == "__main__":
    asyncio.run(main())

3. Run your code

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.

1. Navigate to your machine

In the Viam mobile app, select an organization by clicking on the menu icon in the top left corner and tapping an organization.

Tap the Locations tab and select a location, then select the machine you want your data to be associated with.

2. Upload images

Tap the menu button marked “…” in the upper right corner. Tap Upload Images.

Select each image you want to upload, then tap Add.

The uploaded images metadata will contain the machine part you selected. However, the uploaded images will not be associated with a component or method.