From: Manoop Talasila Date: Tue, 15 Oct 2019 18:25:53 +0000 (-0400) Subject: Add Acumos xApp Adapter X-Git-Tag: 0.0.1~3 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=c3666f891060a0c6bf96129e81790a23ed6260eb;p=ric-app%2Fml.git Add Acumos xApp Adapter Patch to address comments about initializing a new repo for first time with all basic required files. Issue-Id: RICAPP-4 Signed-off-by: Manoop Talasila Change-Id: Icd18d928f58a601581ac35bafd12b24726e07802 --- diff --git a/AcumosXappAdapter/iris_sklearn.py b/AcumosXappAdapter/iris_sklearn.py index 7fd70fb..64740e7 100644 --- a/AcumosXappAdapter/iris_sklearn.py +++ b/AcumosXappAdapter/iris_sklearn.py @@ -1,20 +1,20 @@ -# ===============LICENSE_START======================================================= -# Acumos Apache-2.0 -# =================================================================================== -# Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. -# =================================================================================== -# This Acumos software file is distributed by AT&T and Tech Mahindra -# under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at +# ========================LICENSE_START================================= +# O-RAN-SC +# %% +# Copyright (c) 2019 AT&T Intellectual Property. +# %% +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# http://www.apache.org/licenses/LICENSE-2.0 # -# This file is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ===============LICENSE_END========================================================= +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ========================LICENSE_END=================================== from acumos.session import AcumosSession from acumos.modeling import Model, List, create_dataframe @@ -53,4 +53,4 @@ model = Model(classify=classify_iris) session = AcumosSession() -session.dump(model,'iris_sklearn','/Users/guy/Desktop') +session.dump(model,'iris_sklearn','/temp') diff --git a/INFO.yaml b/INFO.yaml new file mode 100644 index 0000000..d9b278e --- /dev/null +++ b/INFO.yaml @@ -0,0 +1,52 @@ +--- +project: 'ric-app/ml' +project_creation_date: '2019-10-15' +project_category: '' +lifecycle_state: 'Incubation' +project_lead: &ric_app_ml_ptl + name: 'Matti Hiltunen' + email: 'hiltunen@att.com' + id: 'hiltunen' + company: 'AT&T Labs-Research' + timezone: 'America/New_York' +primary_contact: *ric_app_ml_ptl +issue_tracking: + type: 'jira' + url: 'https://jira.o-ran-sc.org/projects/RICPLT' + key: 'ML' +mailing_list: + type: 'groups.io' + url: 'https://lists.o-ran-sc.org/g/main' + tag: '<[ric-app/ml]>' +realtime_discussion: + type: 'irc' + server: 'freenode.net' + channel: '#o-ran-sc' +meetings: + - type: 'zoom' + agenda: '' + url: '' + server: 'n/a' + channel: 'n/a' + repeats: 'weekly' + time: '' +repositories: + - 'ric-app/ml' +committers: + - name: 'Chris Lott' + email: 'clott@research.att.com' + company: 'AT&T Labs-Research' + id: 'cl778h' + timezone: 'America/New_York' + - name: 'Manoop Talasila' + email: 'talasila@research.att.com' + company: 'ATT' + id: 'talasila' + timezone: 'America/New_York' + - name: 'Guy Jacobson' + email: 'gj2418@att.com' + company: 'ATT' + id: 'gj2418' + timezone: 'America/New_York' +tsc: + approval: 'https://lists.o-ran-sc.org/g/toc' diff --git a/LICENSES.txt b/LICENSES.txt new file mode 100644 index 0000000..4ec6357 --- /dev/null +++ b/LICENSES.txt @@ -0,0 +1,30 @@ +LICENSES.txt + +Unless otherwise specified, all software contained herein is licensed +under the Apache License, Version 2.0 (the "Software License"); +you may not use this software except in compliance with the Software +License. You may obtain a copy of the Software License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the Software License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the Software License for the specific language governing permissions +and limitations under the Software License. + + + +Unless otherwise specified, all documentation contained herein is licensed +under the Creative Commons License, Attribution 4.0 Intl. (the +"Documentation License"); you may not use this documentation except in +compliance with the Documentation License. You may obtain a copy of the +Documentation License at + +https://creativecommons.org/licenses/by/4.0/ + +Unless required by applicable law or agreed to in writing, documentation +distributed under the Documentation License is distributed on an "AS IS" +BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied. See the Documentation License for the specific language governing +permissions and limitations under the Documentation License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5a072c7 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# O-RAN-SC Machine Learning Common Services + +The O-RAN SC Machine Learning (ML) Common Services provides ML tools, adapters to integrate with a radio access network (RAN) controller. + +Please see the documentation in the docs/ folder. + +## License + +Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..173f8dc --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +/_build +/out +/_build diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..c3b6ce5 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..922e22f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +from docs_conf.conf import * +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..5cc01df --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-app-ml diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..00b0fd0 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d711fa4 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,33 @@ +.. _ric-app-ml: + +.. ===============LICENSE_START======================================================= +.. O-RAN SC CC-BY-4.0 +.. %% +.. Copyright (C) 2019 AT&T Intellectual Property +.. %% +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. ===============LICENSE_END========================================================= + +.. RIC APP ML documentation master + +RIC APP ML +============= + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + +* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..a6dc231 --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,39 @@ +.. ===============LICENSE_START======================================================= +.. O-RAN SC CC-BY-4.0 +.. %% +.. Copyright (C) 2019 AT&T Intellectual Property +.. %% +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. ===============LICENSE_END========================================================= + +RIC APP ML Overview +====================== + +The O-RAN SC Machine Learning (ML) Common Services provides ML tools, adapters to integrate with a radio access network (RAN) controller. + +Using Acumos ML models in the RIC: + +* Goal is to support ML models in non-real time and near-real time RIC usecases. + ** quickly import an Acumos model into RIC and adapt it into as an xApp (near-real time). + ** deploy Acumos models as is into non-real time (mostly on ONAP side). +* Priority is to get something working with minimal changes possible on ML models + ** focus on performance in the later releases, since many ML models take some time to execute anyway. +* Build a standard xApp/Acumos microservice adapter + ** deployed along with the Acumos ML model in one Kubernetes pod. +* Adapter speaks RMR protocol to RIC + ** communicates with the Acumos ML model in the standard http / GRPC manner. +* Configuration needed for each deployment + ** to tell adapter how to speak with Acumos ML model. + ** can be auto generated using ML model protobuf definition. +* Consider writing custom RMR model runner + ** for performance in near-real time RIC xApps in the following releases. \ No newline at end of file