Register a Target

To register a target using the API, you can use the Python client provided by the dAIEdge-VLab to interact with the API. Have a look at the Python client here to understand how to set it up and use it. You can use the following code snippet to register a target using the API. Make sure to fill in the necessary information for your target and to provide the correct path to the setup.yaml file that contains the API credentials.

Create the ResourceConfigurator class that will be used to register the target as follows:

from daiedge_vlab import dAIEdgeVLabAPI
from daiedge_vlab.resources import ResourceConfigurator

api = dAIEdgeVLabAPI("setup.yaml")
configurator = ResourceConfigurator(api)

Then, check if the target family and runtime already exist with the following code snippet. You will need to use the family and runtime name to register your target.

configurator.get_available_edge_device_families()
configurator.get_available_runtimes_families()

This output two tables with the available families and runtimes. If you find a family and runtime that match your target, you can use them to register your target. If not, you can create a new family and runtime using the following code snippet :

configurator.create_edge_device_family("test_family", "Test family", "Test family description")
configurator.create_runtime_family("test_runtime", "Test runtime", "Test runtime description", supported_file_extensions=["onnx", "tflite"])

Finally, you can register your target using the following code snippet :

configurator.create_edge_device_instance(
  "test_family", 
  ["test_runtime"], # Multiple runtimes can be associated to the same target if needed
  "My personal notes for this instance", 
  "The target serial number this is optional."
)

This will create the new target instance and will return the target UID that you will need to use in the target.json file of your host configuration file.

You can list all the registered targets using the following code snippet :

r = configurator.get_my_edge_device_instances()
for instance in r:
    print(instance["inventory_id"])

Go to the dAIEdge-VLab website and login with your account. If you don’t have an account, you can create one here.

Once you are logged in, go to your profile and click on My Targets. Then click on the button register a new target. You will be redirected to a form where you will need to fill in the mandatory information that you gathered in the previous step.

Lookup for the target family that best match your target. If you don’t find any, you can add a new family by clicking on the button Add a new family. The family is used to group targets that are similar in terms of hardware.

The same goes for the runtime, if you don’t find the runtime you are looking for, you can add a new runtime by clicking on the button Add a new runtime. You can associate multiple runtimes to a target if needed.

Once you have filled the form, click on the button register.

Once the target is registered, you will need to fill in the target.json file with the necessary information for your target. The most important information is the target_uid (or inventory_id) that you will get from the registration process. This UID is used to identify your target in the dAIEdge-VLab and to link the results produced by your target to the correct target in the inventory.

To retrive a template of the target.json file, you can use the following code snippet. This will provide you with a template that you can fill in with the necessary information for your target.

import json
config = configurator.get_default_configuration("inventory_id") 
print(json.dumps(config, indent=4))

Once you have the template, have a look at the target configuration file documentation to understand how to fill in the necessary information for your target.

Once you have filled the form and submitted it, the system will then provide you with a target UID that you will need to store in the target.json file of your host configuration file. This is the only place where you will need to use this target UID.

The system also provides you with a template of the target.json file that you can use to fill in the necessary information for your target. Have a look at the target configuration file documentation to understand how to use it.

{
"family": [
    {
      "target_uid": "string",
      "engines": {
        "engine1": {
          "image": "string",
          "supported_types": [
            "TYPE1"
          ],
          "volumes": [
            "string"
          ],
          "devices": [
            "string"
          ],
          "env": {
            "V_ENV_1": "string",
            "V_ENV_2": "string",
          },
          "auth": {
            "registry": "string",
            "username": "string",
            "password": "string"
          }
        }
      }
    }
  ]
}