• Java version 1.8.0_102
• Maven version 3.6.0
• Python version >= 3.6
• MongoDB version 3.6.3
• Docker Desktop

Useful links to help to install requirements on Ubuntu OS, you can search for installation on different OS.

https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-on-ubuntu-18-04

https://linuxize.com/post/how-to-install-apache-maven-on-ubuntu-18-04/

Install Python via Conda, refer to https://www.digitalocean.com/community/tutorials/how-to-install-the-anaconda-python-distribution-on-ubuntu-18-04

https://www.digitalocean.com/community/tutorials/how-to-install-mongodb-on-ubuntu-18-04

https://docs.docker.com/install/linux/docker-ce/ubuntu/

wi-uservice/
├── README.md             // this file
├── clean.sh              // command lines to remove all generated services
├── generate.sh           // command lines to start generating services code (execute this file to generate services)
├── install-model.sh      // command lines to generate each services (called by generate.sh)
├── install.py            // python file to load model and file name (called by generate.sh)
├── model-list.sh         // list of model-services to generate (called by generate.sh)
├── model-specs           // specification for each model-service
├── openapi-generator     // openapi codegen tools (submodule)
├── pm2                   // configuration for deployment by PM2
├── services              // folder storing generated services
└── wi-generators         // generator and template for generating services.
└── docker-compose.yaml   // docker-compose file for services

Run the command

git clone --recursive https://github.com/tunghoang/wi-uservice.git

Note: Using --recursive flag to clone openapi-generator submodules.

Go to folder openapi-generator (which contains pom.xml file) and run command mvn package. Then go to folder wi-generators/generators/wipm (which contains pom.xml file) and run command mvn package.
You may need to run bellow command to use wipm generator as an option for generating code.

java -cp wi-generators/generators/wipm/target/wipm-openapi-generator-1.0.0.jar:openapi-generator/modules/openapi-generator-cli/target/openapi-generator-cli.jar org.openapitools.codegen.OpenAPIGenerator

Refer to https://openapi-generator.tech/docs/customization.html for more details.

Specification and model files are in subfolders of model-specs folder. Each subfolders is used for a service. For example decision_tree subfolder.

decision_tree/
├── decision_tree_estimator.py    // machine learning model class
├── info.json                     // model name and filename
└── spec.yaml                     // shortened version of specification for service

List of services to generate is in model-list.sh.

Run the command to generate services listed in model-list.sh.

$ ./generate.sh

Generated services are in services folder. Each services contains its own README.md which guide to run the services.

Configuration to deploy services with PM2 are specified in pm2/ecosystem.config.js. Go to pm2 folder and run the command to deploy services.

pm2 start ecosystem.config.js

Refer to https://pm2.io/doc/en/runtime/overview/ for more details about dealing with PM2.

Config to deploy services which Docker are specified in Dockerfile At wi-uservice run command:

Create a docker volume:

docker volume create wi_volume

Create a docker network:

docker network create wi_network

Build a mongo container with command:

docker run -dit -p 27017:27017 -v wi_volume:/data/db --network=wi_network --name wi_mongodb mongo:latest

Inspect mongo container and get ip of mongo container then in dev.config.py, modify DB_HOST as mongo ip

At wi-uservice run :

docker-compose build
docker-compose up

Now you ready to move on

Generator is in WipmGenerator.java file in wi-uservice/wi-generators/generators/wipm/src/main/java/wi/gen/ml folder.
Template files are in wi-generators/generators/wipm/src/main/resources/wipm.

Refer to README.md of each generated code.

OpenAPI Generator: https://openapi-generator.tech
OpenAPI Specification: https://swagger.io/specification/