X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;fp=docs%2Frelease-notes.rst;h=7a4f90b6bd91830afea1584ea34bd166860f96c6;hb=2a2860f7ab79121d75647e73697e4c51168db350;hp=0000000000000000000000000000000000000000;hpb=ce9d4b284225c5d84a63729f96ef7fb5d5045ac7;p=ric-app%2Fml.git

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 0000000..7a4f90b
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,78 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2019 AT&T
+
+
+Release Notes
+=============
+
+
+This document provides the release notes for the Amber Release of the Acumos xAPP adapter.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-14         | 0.0.1              |  Guy Jacobson      | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+
+Summary
+-------
+
+The Amber release of the Acumos xAPP adapter contains the code needed to use an existing
+Acumos microservice as an O-RAN xAPP, by providing "glue" that listens and speaks RMR protocol
+and translates these into calls to the Acumos microservice, which is co-deployed in the
+same pod as the adapter.
+
+
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **Project**                          |      RAN Intelligent Controller      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   |              ric-app/ml              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              |                 Amber                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     |              2019-11-14              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | open-source adapter between Acumos   |
+|                                      | and xAPPs.                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+Components
+----------
+
+- *AcumosXappAdapter/* contains the source code and other items of interest. Under that directory :
+  
+  + *rmracumosadapter.py* is source code for the adapter itself.
+  + *iris_sklearn.py* is the source code for a generic Acumos model (iris classification).
+  + *config.json*  is a sample configuration file, needed to connect the Acumos model with the xAPP adapter during deployment.
+  + *Dokcerfile* is the Dockerfile that builds the xAPP adapter microservice.
+  + *testdata.csv* contains sample input data to test the iris_sklearn.py classifier
+ 
+
+Limitations
+-----------
+- This is a first release and needs some fixes to the Dockerfile function correctly, due to known problems with the build process to incorporate the required nng libraries.
+
+