First version with ML prediction code
[ric-app/qp.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 .. Copyright (C) 2020 AT&T Intellectual Property
4 .. Copyright (C) 2021 HCL Technologies Limited.
5
6 QoE Predictor Overview
7 ======================
8
9 QoE Predictor (QP) is an Xapp in the Traffic Steering O-RAN use case,
10 which uses the following Xapps:
11
12 #. Traffic Steering, which sends prediction requests to QP.
13 #. QoE Predictor, which predicts and sends that prediction back to Traffic Steering
14 #. KPIMONN, which populates UE and Cell metrics into the influxdb.
15
16 Expected Input
17 --------------
18
19 The QP Xapp expects a prediction-request JSON message via RMR with the following structure::
20 {"UEPredictionSet": ["Car-1"]}
21
22 Expected Output
23 ---------------
24
25 The QP Xapp should send a prediction for both downlink and uplink throughput
26 as a JSON message via RMR with the following structure::
27
28  {"Car-1":{
29  "c6/B2": [12650, 12721],
30  "c6/N77": [12663, 12739],
31  "c1/B13": [12576, 12655],
32  "c7/B13": [12649, 12697],
33  "c5/B13": [12592, 12688]
34  }}