Services
This section describes the different services that can be implemented by the developer of a target platform to be integrated into the dAIEdge-VLab.
Services Types
You may implement one or more of the following service types:
-
Benchmarking service with random data (TYPE1):
Runs the model on the target using randomly generated input data and returns performance metrics (e.g., latency, power consumption). -
Benchmarking service with custom data (TYPE2):
Runs the model on the target using user-provided input data and returns performance metrics. -
On-device training (TYPE3):
Allows users to train the model on the target using custom input data.
This service is more complex to implement as it requires handling the full training process. -
Federated learning service (TYPE4):
No additional implementation is required.
If TYPE2 and TYPE3 are supported, the target is automatically compatible with federated learning.
Environment variables
The following environment variables are provided to the docker container running the target scripts. These variables are set by the dAIEdge-VLab’s and allows the target scripts to identify the type of service requested and to access the input files provided by the user.
Variables describing the requested job
| Variable name | Description |
|---|---|
$TARGET |
The target name |
$RUNTIME |
The runtime name |
$NB_INFERENCE |
The number of inferences that should be performed to create the benchmark. This variable should be ignored if $BENCHMARK_TYPE is set to TYPE2. |
$BENCHMARK_TYPE |
Define the service type requested by the user. |
$MODEL_FILENAME |
Provide the file name of the model provided by the user. Note that a timestamp is added to it automatically to ensure uniqueness. |
$PARAMETERS_FILENAME |
Provide the file name of the parameters file containing parameters linked to the runtime. Only if one was provided. |
$DATASET_FILENAME |
Provide the file name of the dataset provided by the user. Only if one was provided. |
$ODT_CONFIG_FILENAME |
Provide the file name of the on device training configuration file. Only if the benchmark type is set to TYPE3. |
Variables for the dAIEdge-VLab
| Variable name | Description |
|---|---|
$FUNCTIONS_PATH |
Path of the exit_functions.sh script. This scipt helps handeling errors and wranings. |
$LOG_PATH |
Path of the location of the .log files. This is handeled automatically by the exit_functions.sh. |
Services details
Find more details about the different service types in the following pages: