tng-vnv-dsm

Decision Support Mechanism/Matrix Factorization-based Recommender System

This repository includes the tng-vnv-dsm component, which incorporates the Decision Support Mechanism of the 5GTANGO Catalogues, both of which are part of the European H2020 project 5GTANGO. The component is responsible for delivering test recommendations to the end-users of the 5GTANGO ecosystem, through the deployment of matrix-factorization techniques.

Documentation

Besides this README file, more documentation is available in the wiki belonging to this repository.

Installation and Dependencies

This component is implemented in Python3. Its requirements are specified in the packages.txt in the root folder as follows here. In general, a new virtual environment would be beneficial in the installation.

Automated installation:

The automated installation requires pip (more specifically pip3).

$ pip install git+https://github.com/sonata-nfv/tng-vnv-dsm

Manual installation:

$ git clone [email protected]:sonata-nfv/tng-vnv.dsm.git
$ cd tng-vnv-dsm
$ python setup.py install

Usage

The Decision Support mechanism is delivered to be deployed as a micro service, offering a REST API to provide recommendations on top of the 5GTANGO Catalogues. However, it can be utilized as a standalone service to provide recommendations based on SVD matrix factorization technique.

Run tng-vnv-dsm as a service:

Bare metal

In this option, a functional mongoDB is essential for the core functionality of the service.

python src/decsup/app.py

Docker-based

In this option, a functional mongoDB is essential for the core functionality of the service.

# build Docker container
sudo docker build .

# run Docker container
docker run --rm -d -p 4010:4010 --name tng-vnv-dsm registry.sonata-nfv.eu:5000/tng-vnv-dsm

Docker-compose-based

In this option, a functional mongoDB is included in the docker-compose script

# build Docker containers of MongoDB and tng-vnv-dsm
sudo docker-compose build

# run Docker containers
sudo docker-compose up

Development

To contribute to the development of this 5GTANGO component, you may use the very same development workflow as for any other 5GTANGO Github project. That is, you have to fork the repository and create pull requests.

Setup development environment

$ python setup.py develop

CI Integration

All pull requests are automatically tested by Jenkins and will only be accepted if no test is broken.

License

This 5GTANGO component is published under Apache 2.0 license. Please see the LICENSE file for more details.

---

Lead Developers

The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.

• Panagiotis Stavrianos (@panstav1)

Feedback-Chanel

• Please use the GitHub issues to report bugs.