Merge pull request #121 from nginyc/v0.1.0

Release `v0.1.0`

Author: nginyc

.dockerignore

@@ -1,4 +1,6 @@
 *.pyc
 __pycache__
 
-**/node_modules
+**/node_modules
+
+.cache/**

.env.sh

@@ -1,21 +1,27 @@
+# Core secrets for Rafiki - change these in production!
+export POSTGRES_PASSWORD=rafiki
+export SUPERADMIN_PASSWORD=rafiki
+export APP_SECRET=rafiki
+
 # Core external configuration for Rafiki
 export DOCKER_NETWORK=rafiki
 export DOCKER_SWARM_ADVERTISE_ADDR=127.0.0.1
-export RAFIKI_VERSION=0.0.9
+export RAFIKI_VERSION=0.1.0
 export RAFIKI_ADDR=127.0.0.1
 export ADMIN_EXT_PORT=3000
 export ADMIN_WEB_EXT_PORT=3001
 export ADVISOR_EXT_PORT=3002
 export POSTGRES_EXT_PORT=5433
 export REDIS_EXT_PORT=6380
-export DATA_WORKDIR_PATH=$PWD/data # Shares a data folder with containers
-export LOGS_WORKDIR_PATH=$PWD/logs # Shares a folder with containers that stores components' logs
+export HOST_WORKDIR_PATH=$PWD
 export APP_MODE=DEV # DEV or PROD
+export POSTGRES_DUMP_FILE_PATH=$PWD/db_dump.sql # PostgreSQL database dump file
+export DOCKER_NODE_LABEL_AVAILABLE_GPUS=available_gpus # Docker node label for no. of services currently running on the node
+export DOCKER_NODE_LABEL_NUM_SERVICES=num_services # Docker node label for no. of services currently running on the node
 
 # Internal credentials for Rafiki's components
 export POSTGRES_USER=rafiki
 export POSTGRES_DB=rafiki
-export POSTGRES_PASSWORD=rafiki
 
 # Internal hosts & ports and configuration for Rafiki's components 
 export POSTGRES_HOST=rafiki_db
@@ -28,9 +34,10 @@ export REDIS_HOST=rafiki_cache
 export REDIS_PORT=6379
 export PREDICTOR_PORT=3003
 export ADMIN_WEB_HOST=rafiki_admin_web
-export DATA_DOCKER_WORKDIR_PATH=/root/rafiki/data
-export LOGS_DOCKER_WORKDIR_PATH=/root/rafiki/logs
-export DOCKER_WORKDIR_PATH=/root/rafiki
+export DOCKER_WORKDIR_PATH=/root
+export DATA_DIR_PATH=data # Shares a data folder with containers, relative to workdir
+export LOGS_DIR_PATH=logs # Shares a folder with containers that stores components' logs, relative to workdir
+export PARAMS_DIR_PATH=params # Shares a folder with containers that stores model parameters, relative to workdir
 export CONDA_ENVIORNMENT=rafiki
 
 # Docker images for Rafiki's custom components
@@ -46,7 +53,4 @@ export IMAGE_REDIS=redis:5.0.3-alpine3.8
 
 # Utility configuration
 export PYTHONPATH=$PWD # Ensures that `rafiki` module can be imported at project root
-
-# Set alias for correct PIP & python
-alias pip='pip3.6'
-alias python='python3.6'
+export PYTHONUNBUFFERED=1 # Ensures logs from Python appear instantly ``

.gitignore

@@ -10,6 +10,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# PIP cache
+.cache/
+
 # MacOS
 .DS_Store
 
@@ -27,6 +30,13 @@ data/*
 logs/*
 !logs/.gitkeep
 
+# Params
+params/*
+!params/.gitkeep
+
 # IPython notebooks
 .ipynb_checkpoints/*
-*.ipynb
+*.ipynb
+
+# SQL dump files
+*.sql

README.md

@@ -20,11 +20,11 @@ Prerequisites: MacOS or Linux environment
     bash scripts/start.sh
     ```
 
-To destroy Rafiki's complete stack:
+To completely destroy Rafiki's stack:
 
-    ```sh
-    bash scripts/stop.sh
-    ```
+```sh
+bash scripts/stop.sh
+```
 
 More instructions are available in [Rafiki's Developer Guide](https://nginyc.github.io/rafiki/docs/latest/docs/src/dev).
 

dockerfiles/admin.Dockerfile

@@ -15,21 +15,21 @@ RUN pip install --upgrade pip
 ENV PYTHONUNBUFFERED 1
 
 ARG DOCKER_WORKDIR_PATH
-RUN mkdir $DOCKER_WORKDIR_PATH
+RUN mkdir -p $DOCKER_WORKDIR_PATH
 WORKDIR $DOCKER_WORKDIR_PATH
 ENV PYTHONPATH $DOCKER_WORKDIR_PATH
 
 # Install python dependencies
-COPY rafiki/utils/requirements.txt utils/requirements.txt
-RUN pip install -r utils/requirements.txt
-COPY rafiki/db/requirements.txt db/requirements.txt
-RUN pip install -r db/requirements.txt
-COPY rafiki/model/requirements.txt model/requirements.txt
-RUN pip install -r model/requirements.txt
-COPY rafiki/container/requirements.txt container/requirements.txt
-RUN pip install -r container/requirements.txt
-COPY rafiki/admin/requirements.txt admin/requirements.txt
-RUN pip install -r admin/requirements.txt
+COPY rafiki/requirements.txt rafiki/requirements.txt
+RUN pip install -r rafiki/requirements.txt
+COPY rafiki/utils/requirements.txt rafiki/utils/requirements.txt
+RUN pip install -r rafiki/utils/requirements.txt
+COPY rafiki/db/requirements.txt rafiki/db/requirements.txt
+RUN pip install -r rafiki/db/requirements.txt
+COPY rafiki/container/requirements.txt rafiki/container/requirements.txt
+RUN pip install -r rafiki/container/requirements.txt
+COPY rafiki/admin/requirements.txt rafiki/admin/requirements.txt
+RUN pip install -r rafiki/admin/requirements.txt
 
 COPY rafiki/ rafiki/
 COPY scripts/ scripts/

dockerfiles/admin_web.Dockerfile

@@ -1,8 +1,8 @@
-FROM node:11.1
+FROM node:11.1-alpine
 
 ARG DOCKER_WORKDIR_PATH
 
-RUN mkdir $DOCKER_WORKDIR_PATH
+RUN mkdir -p $DOCKER_WORKDIR_PATH
 WORKDIR $DOCKER_WORKDIR_PATH
 
 COPY web/package.json web/package.json

dockerfiles/advisor.Dockerfile

@@ -15,17 +15,17 @@ RUN pip install --upgrade pip
 ENV PYTHONUNBUFFERED 1
 
 ARG DOCKER_WORKDIR_PATH
-RUN mkdir $DOCKER_WORKDIR_PATH
+RUN mkdir -p $DOCKER_WORKDIR_PATH
 WORKDIR $DOCKER_WORKDIR_PATH
 ENV PYTHONPATH $DOCKER_WORKDIR_PATH
 
 # Install python dependencies
-COPY rafiki/utils/requirements.txt utils/requirements.txt
-RUN pip install -r utils/requirements.txt
-COPY rafiki/model/requirements.txt model/requirements.txt
-RUN pip install -r model/requirements.txt
-COPY rafiki/advisor/requirements.txt advisor/requirements.txt
-RUN pip install -r advisor/requirements.txt
+COPY rafiki/requirements.txt rafiki/requirements.txt
+RUN pip install -r rafiki/requirements.txt
+COPY rafiki/utils/requirements.txt rafiki/utils/requirements.txt
+RUN pip install -r rafiki/utils/requirements.txt
+COPY rafiki/advisor/requirements.txt rafiki/advisor/requirements.txt
+RUN pip install -r rafiki/advisor/requirements.txt
 
 COPY rafiki/ rafiki/
 COPY scripts/ scripts/

dockerfiles/predictor.Dockerfile

@@ -15,19 +15,21 @@ RUN pip install --upgrade pip
 ENV PYTHONUNBUFFERED 1
 
 ARG DOCKER_WORKDIR_PATH
-RUN mkdir $DOCKER_WORKDIR_PATH
+RUN mkdir -p $DOCKER_WORKDIR_PATH
 WORKDIR $DOCKER_WORKDIR_PATH
 ENV PYTHONPATH $DOCKER_WORKDIR_PATH
 
 # Install python dependencies
-COPY rafiki/utils/requirements.txt utils/requirements.txt
-RUN pip install -r utils/requirements.txt
-COPY rafiki/db/requirements.txt db/requirements.txt
-RUN pip install -r db/requirements.txt
-COPY rafiki/cache/requirements.txt cache/requirements.txt
-RUN pip install -r cache/requirements.txt
-COPY rafiki/predictor/requirements.txt predictor/requirements.txt
-RUN pip install -r predictor/requirements.txt
+COPY rafiki/requirements.txt rafiki/requirements.txt
+RUN pip install -r rafiki/requirements.txt
+COPY rafiki/utils/requirements.txt rafiki/utils/requirements.txt
+RUN pip install -r rafiki/utils/requirements.txt
+COPY rafiki/db/requirements.txt rafiki/db/requirements.txt
+RUN pip install -r rafiki/db/requirements.txt
+COPY rafiki/cache/requirements.txt rafiki/cache/requirements.txt
+RUN pip install -r rafiki/cache/requirements.txt
+COPY rafiki/predictor/requirements.txt rafiki/predictor/requirements.txt
+RUN pip install -r rafiki/predictor/requirements.txt
 
 COPY rafiki/ rafiki/
 COPY scripts/ scripts/

dockerfiles/worker.Dockerfile

@@ -42,23 +42,21 @@ RUN pip install --upgrade pip
 ENV PYTHONUNBUFFERED 1
 
 ARG DOCKER_WORKDIR_PATH
-RUN mkdir $DOCKER_WORKDIR_PATH
+RUN mkdir -p $DOCKER_WORKDIR_PATH
 WORKDIR $DOCKER_WORKDIR_PATH
 ENV PYTHONPATH $DOCKER_WORKDIR_PATH
 
 # Install python dependencies
-COPY rafiki/utils/requirements.txt utils/requirements.txt
-RUN pip install -r utils/requirements.txt
-COPY rafiki/db/requirements.txt db/requirements.txt
-RUN pip install -r db/requirements.txt
-COPY rafiki/cache/requirements.txt cache/requirements.txt
-RUN pip install -r cache/requirements.txt
-COPY rafiki/model/requirements.txt model/requirements.txt
-RUN pip install -r model/requirements.txt
-COPY rafiki/client/requirements.txt client/requirements.txt
-RUN pip install -r client/requirements.txt
-COPY rafiki/worker/requirements.txt worker/requirements.txt
-RUN pip install -r worker/requirements.txt
+COPY rafiki/requirements.txt rafiki/requirements.txt
+RUN pip install -r rafiki/requirements.txt
+COPY rafiki/utils/requirements.txt rafiki/utils/requirements.txt
+RUN pip install -r rafiki/utils/requirements.txt
+COPY rafiki/db/requirements.txt rafiki/db/requirements.txt
+RUN pip install -r rafiki/db/requirements.txt
+COPY rafiki/cache/requirements.txt rafiki/cache/requirements.txt
+RUN pip install -r rafiki/cache/requirements.txt
+COPY rafiki/worker/requirements.txt rafiki/worker/requirements.txt
+RUN pip install -r rafiki/worker/requirements.txt
 
 COPY rafiki/ rafiki/
 COPY scripts/ scripts/

conf.py renamed to docs/conf.py

@@ -179,6 +179,8 @@
 
 # -- Extension configuration -------------------------------------------------
 
+autodoc_member_order = 'bysource'
+
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.