docs/overview.rst

   1 .. ===============LICENSE_START=======================================================
   2 .. O-RAN SC CC-BY-4.0
   3 .. %%
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5 .. %%
   6 .. Licensed under the Apache License, Version 2.0 (the "License");
   7 .. you may not use this file except in compliance with the License.
   8 .. You may obtain a copy of the License at
   9 ..
  10 ..      http://www.apache.org/licenses/LICENSE-2.0
  11 ..
  12 .. Unless required by applicable law or agreed to in writing, software
  13 .. distributed under the License is distributed on an "AS IS" BASIS,
  14 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 .. See the License for the specific language governing permissions and
  16 .. limitations under the License.
  17 .. ===============LICENSE_END=========================================================
  18
  19 RIC APP ML Overview
  20 ======================
  21
  22 The O-RAN SC Machine Learning (ML) Common Services provides ML tools, adapters to integrate with a radio access network (RAN) controller.
  23
  24 Using Acumos ML models in the RIC:
  25
  26 * Goal is to support ML models in non-real time and near-real time RIC usecases.
  27     ** quickly import an Acumos model into RIC and adapt it into as an xApp (near-real time).
  28     ** deploy Acumos models as is into non-real time (mostly on ONAP side).
  29 * Priority is to get something working with minimal changes possible on ML models
  30     ** focus on performance in the later releases, since many ML models take some time to execute anyway.
  31 * Build a standard xApp/Acumos microservice adapter
  32     ** deployed along with the Acumos ML model in one Kubernetes pod.
  33 * Adapter speaks RMR protocol to RIC
  34     ** communicates with the Acumos ML model in the standard http / GRPC manner.
  35 * Configuration needed for each deployment
  36     ** to tell adapter how to speak with Acumos ML model.
  37     ** can be auto generated using ML model protobuf definition.
  38 * Consider writing custom RMR model runner
  39     ** for performance in near-real time RIC xApps in the following releases.