dAIEdge-VLab API

dAIEdge-VLab API

This section describes the dAIEdge-VLab API.

⚠️
Warning : This dAIEdge-VLab API is in developpement and is currenlty not available to the VLab users.

What dose the API provide ?

The dAIEdge-VLab API provide a simple way to interact with the targets available in the dAIEdge-VLab using Python. This allows you to build developpement pipeline with hardware in the loop.

Here are the key points that the dAIEdge-VLab API allows you to do :

  • Run benchmark of your model on the availbles targets
  • Provide your pre-processed dataset for the benchmark
  • Retrive the report.json generated by the benchmark
  • Retrive the different logs files generated by the benchmark
  • Retrive the raw output generated by your model

Install

The API is available as a package Python. Run the following command to install the package :

pip install PydAIEdge-Vlab

How to use the dAIEdge-VLab API ?

To use the API you simply need to :

  • Import the API in your python script
  • Provide the configuration file (dAIEdge-VLab gateway, user credentials) to the API

Follow the next sections to setup the API and use it.