| Information element | Status | Description |
|---|---|---|
| Requestor Identity | M | The identity of the requestor performing the request. |
| Security Credentials | O
(NOTE 1) | Security credentials of the requestor performing the request. |
| ML model | O
(NOTE 2) | The ML model to be stored in the ML repository. |
| ML model address | O
(NOTE 2) | The address (e.g., a URL or an FQDN) of the ML model file. |
| ML model information | M | Provides information of the ML model, as described in Table 8.11.4.1-2. |
|
NOTE 1:
This information is needed if the requestor is at the VAL service provider domain.
NOTE 2:
At least one of these information elements shall be provided.
|
||
| Information element | Status | Description |
|---|---|---|
| ML model identifier | M | An identifier for the ML model. |
| ADAE Analytics ID | O | Represents ADAE analytics ID for which the model can be used. |
| ML model size | O | Indicates the size of the ML model. |
| ML model source identifier | O | The identifier of ML model source (e.g., VAL server ID, VAL client ID) that stored the model in the ML repository. |
| VAL service ID(s) | O | Identify the VAL service ID(s). |
| Domain | O | Specifies domain for which the model can be used (e.g., for speech recognition, image recognition, video processing, location prediction, etc.). |
| List of allowed vendors | O
(NOTE 1) | Indicates which vendors that are allowed to use the ML model and thereby also are interoperable to the model. |
| ML model interoperability information | O
(NOTE 1) | Represents the vendor-specific information that conveys, e.g., requested model file format, model execution environment, input/output parameters of the ML model, etc. The encoding, format, and value of ML Model Interoperable Information is not specified since it is vendor specific information, and is agreed between vendors, if necessary for sharing purposes. |
| ML Model phase | O
(NOTE 1) | Represents the ML model phase, e.g., in training, trained, re-training, deployed. |
| > Observed performance | O
(NOTE 2) | Provides information on the performance of the model e.g. accuracy, or application-specific performance metrics (if ML model is in trained or deployment phase). |
| > Training information | O
(NOTE 2) | If the ML model is in trained or deployed phase: Information on the data that has been used to train the model (e.g. data sources, volume, freshness), and the base model ID in case of Transfer Learning. |
| > Indication of continuous model training | O | Indicates whether the model can be continuously trained or not. |
| > Continuous model training parameter | O | Parameters required for continuous model training. |
| ML model storage and discovery requirements | O
(NOTE 1) | Represents the requirements for the ML repository for the ML model storage and discovery. |
| > Storage duration | O | Represents the ML model storage duration time. When the storage duration time is expired, the stored ML model and the related information shall be deleted. |
| > Security and access requirements | O | Represents the information on security requirements for storing the ML model information and the ML model access requirements (e.g., publicly available, private use only, or available for the list of VAL server IDs or VAL client IDs, time period and location access). If the access requirement is private use only, then the model is not discoverable by other consumers. |
| ML model usage requirements | O | Represents the requirements for using the ML model (e.g. for inference or for training). The requirements are used by the AIMLE server to determine whether an AIMLE client is capable of using the model based on comparing the requirements with information in the AIMLE client profile in Table 8.7.3.2-2. |
|
NOTE 1:
At least one of these information elements shall be provided.
NOTE 2:
This IE is included only if trained ML model is available.
|
||
| Information element | Status | Description |
|---|---|---|
| Result | M | Indicates success or failure of the request. |
| ML model profile identifier | O | The identifier of the ML model profile created as a result of a successful ML model storage request. |
| Information element | Status | Description |
|---|---|---|
| ML model profile identifier | M | The identifier of the ML model profile. |
| AIMLE server identifier | M | The identifier of the AIMLE server that stored the ML model. |
| ML repository identifier | M | The identifier of the ML repository where the ML model is stored. |
| ML model information | M | The information about the ML model, as described in Table 8.11.4.1-2. |
| ML model retrieval endpoint | O | Represents the ML model retrieval endpoint (e.g., URL, URI, IP address and Port) that can be used to download the ML model. |
| Information element | Status | Description |
|---|---|---|
| Requester Identity | M | The identity of the ML repository consumer performing the request. |
| Filtering criteria | M | Represents the filtering criteria, which can be any of the ML model information as in Table 8.11.4.1-2. |
| Information element | Status | Description |
|---|---|---|
| Successful response | O
(NOTE 1) | Indicates that the request was successful. |
| > ML model profile list | O
(NOTE 2) | Represents the ML model profile(s) of the discovered list of ML models, as described in Table 8.11.4.2-2. |
| >> ML model profile ID | M | Represents the ML model profile ID of the ML model profile. |
| > ML model list | O
(NOTE 2) | Represents the ML model(s) of the discovered list of ML models. |
| >> ML model ID | M | Represents the ML model ID of the ML model. |
| > Indication of continuous model training | O | Indicate whether the model needs to be continuously trained or not. |
| Failure response | O
(NOTE 1) | Indicates that the request failed. |
| > Cause | O | Indicates the failure cause. |
|
NOTE 1:
Only one of these information elements shall be provided.
NOTE 2:
Only one of these information elements shall be provided.
|
||
| Information element | Status | Description |
|---|---|---|
| Requestor identifier | M | The identifier of the requestor. |
| AI/ML model and model parameters | M | Information about the AI/ML model and model parameters for use in HFL training. |
| Dataset identifier | M | The dataset identifier associated with the dataset used for HFL training. |
| Number of data samples | M | The number of data samples required for a round of HFL training. |
| Operational schedule | O | A schedule for when training is to occur. |
| Notification settings | O | Settings for how often to send notifications providing status of HFL training. For example, periodic, event- triggered (e.g. based on percentage completion), upon completion of each training round. |
| Information element | Status | Description |
|---|---|---|
| Status | M | The status for the subscription request: success, fail. |
| Subscription ID | O | An identifier for the subscription only if the status is success. |
| VAL service ID | M | The VAL service identifier for the AIMLE HFL training operation. |
| Information element | Status | Description |
|---|---|---|
| Status | M | Status for the request: success, fail. |
| VAL service ID | M | The VAL service identifier for the AIMLE HFL training operation. |
| HFL training output | M | ML model parameters from HFL training. |
| Errors list | O | A list of errors encountered during a HFL training round. |
| Timestamp | O | A timestamp for the notification. |