Content for TS 23.482 Word version: 19.3.0
9.3 ML repository APIs
9.3.1 MLR FL member Registration API
9.3.2 MLR FL Event API
9.3.3 MLR model management API
...
...
9.3 ML repository APIs p. 137
9.3.1 MLR FL member Registration API p. 137
9.3.1.1 General p. 137
Table 9.3.1.1-1 illustrates the API for FL member registration. This API enables the VAL server (candidate FL member) to communicate with the ML repository for registering as candidate FL member.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| MLR_FLMemberRegistration | Request | Request/Response | VAL Server |
| MLR_FLMemberRegistrationUpdate | Request | Request/Response | VAL Server |
| MLR_FLMemberRegistrationFetch | Request | Request/Response | VAL Server |
| MLR_FLMemberDeregistration | Request | Request/Response | VAL Server |
9.3.1.2 MLR_FLMemberRegistration_Request operation p. 137
API operation name:
MLR_FLMemberRegistration_Request
Description:
The consumer requests for registering as FL member.
Inputs:
See clause 8.4.4.1.
Outputs:
See clause 8.4.4.2.
See clause 8.4.2 for details of usage of this operation.
9.3.1.3 MLR_FLMemberRegistrationUpdate_Request operation p. 138
API operation name:
MLR_FLMemberRegistrationUpdate_Request
Description:
The consumer requests for updating the registration as FL member.
Inputs:
See clause 8.4.4.3.
Outputs:
See clause 8.4.4.4.
See clause 8.4.3 for details of usage of this operation.
9.3.1.4 MLR_FLMemberRegistrationFetch_Request operation p. 138
API operation name:
MLR_FLMemberRegistrationFetch_Request
Description:
The consumer requests for Fetching the registering as FL member.
Inputs:
Outputs:
See clause 8.17.2 for details of usage of this operation.
9.3.1.5 MLR_FLMemberDeregistration_Request operation p. 138
API operation name:
MLR_FLMemberDeregistration_Request
Description:
The consumer requests for deregistering a candidate registered FL member.
Inputs:
See clause 8.4.4.6.
Outputs:
See clause 8.4.4.7.
See clause 8.4.3a for details of usage of this operation.
9.3.2 MLR FL Event API p. 138
9.3.2.1 General p. 138
Table 9.3.2.1-1 illustrates the API for FL-related event subscription and notification. This API enables the AIMLE server to communicate with the ML repository for subscribing for FL related events.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| MLR_FLEvents | Subscribe | Subscribe/Notify | AIMLE Server |
| Notify |
9.3.2.2 Subscribe p. 138
API operation name:
_FLEvents_Subscribe
Description:
The consumer subscribes for FL-related events.
Inputs:
See clause 8.5.5.2.
Outputs:
See clause 8.5.5.3.
See clause 8.5.2 for details of usage of this operation.
9.3.2.3 Notify p. 139
API operation name:
FLEvents_Notify
Description:
The consumer is notified by ML repository on the FL-related events.
Inputs:
-
Outputs:
See clause 8.5.5.4.
See clause 8.5.3 for details of usage of this operation.
9.3.3 MLR model management API p. 139
9.3.3.1 General p. 139
Table 9.3.3.1-1 illustrates the APIs for MLR model management to enable an AIMLE server to discover and store ML models in an ML repository.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| MLR_ModelInformationStorage | Request | Request/Response | AIMLE server |
| MLR_ModelInformationDiscovery | Request | Request/Response | AIMLE server |
9.3.3.2 MLR_ModelInformationStorage_Request operation p. 139
API operation name:
MLR_MLModelInformationStorage_Request
Description:
The consumer requests to perform storage of ML models.
Inputs:
See clause 8.11.4.1.
Outputs:
See clause 8.11.4.2.
See clause 8.11.2 for details of usage of this operation.
9.3.3.3 MLR_ModelInformationDiscovery_Request operation p. 139
API operation name:
MLR_MLModelInformationDiscovery_Request
Description:
The consumer requests to perform discovery of ML models.
Inputs:
See clause 8.11.4.3.
Outputs:
See clause 8.11.4.4.
See clause 8.11.3 for details of usage of this operation.
