Add release notes for Acumos xAPP for Amber release
[ric-app/ml.git] / docs / overview.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3
4 RIC APP ML Overview
5 ======================
6
7 The O-RAN SC Machine Learning (ML) Common Services provides ML tools, adapters to integrate with a radio access network (RAN) controller.
8
9 Using Acumos ML models in the RIC:
10
11 * Goal is to support ML models in non-real time and near-real time RIC usecases.
12     ** quickly import an Acumos model into RIC and adapt it into as an xApp (near-real time).
13     ** deploy Acumos models as is into non-real time (mostly on ONAP side).
14 * Priority is to get something working with minimal changes possible on ML models
15     ** focus on performance in the later releases, since many ML models take some time to execute anyway.
16 * Build a standard xApp/Acumos microservice adapter
17     ** deployed along with the Acumos ML model in one Kubernetes pod.
18 * Adapter speaks RMR protocol to RIC
19     ** communicates with the Acumos ML model in the standard http / GRPC manner.
20 * Configuration needed for each deployment
21     ** to tell adapter how to speak with Acumos ML model.
22     ** can be auto generated using ML model protobuf definition.
23 * Consider writing custom RMR model runner
24     ** for performance in near-real time RIC xApps in the following releases.