Merge pull request #11 from ruivieira/binder

Add Docker and binder support

Author: ruivieira

.dockerignore

@@ -0,0 +1,12 @@
+*.log
+__pycache__
+.pytest_cache
+.pynb_checkpoints
+.Rproj.user
+.vscode
+.idea
+.mypy_cache
+build
+dist
+trustyai.egg-info
+*.pyc

Dockerfile

@@ -0,0 +1,40 @@
+FROM openjdk:11.0.11-jdk
+
+RUN apt-get update
+RUN apt-get install -y python3-pip cmake maven
+
+COPY . .
+RUN pip3 install --no-cache-dir -r requirements.txt && \
+    pip3 install --no-cache-dir -r requirements-dev.txt
+
+# Install the python-trustyai bindings
+RUN python3 setup.py install
+
+USER root
+
+ENV NB_USER jovyan
+ENV NB_UID 1000
+ENV HOME /home/$NB_USER
+
+RUN adduser --disabled-password \
+    --gecos "Default user" \
+    --uid $NB_UID \
+    $NB_USER
+
+COPY . $HOME
+RUN chown -R $NB_UID $HOME
+
+USER $NB_USER
+
+WORKDIR $HOME
+
+RUN mvn org.apache.maven.plugins:maven-dependency-plugin:2.10:get \
+    -DremoteRepositories=https://repository.sonatype.org/content/repositories/central  \
+    -Dartifact=org.kie.kogito:explainability-core:1.8.0.Final \
+    -Dmaven.repo.local=dep -q && \
+    wget -O ./dep/org/kie/kogito/explainability-core/1.8.0.Final/explainability-core-1.8.0.Final-tests.jar \
+    https://repo1.maven.org/maven2/org/kie/kogito/explainability-core/1.8.0.Final/explainability-core-1.8.0.Final-tests.jar
+
+# Launch the notebook server
+WORKDIR $HOME/examples
+CMD ["jupyter", "notebook", "--ip", "0.0.0.0"]

README.md

@@ -5,6 +5,8 @@ Python bindings to [TrustyAI](https://kogito.kie.org/trustyai/)'s explainability
 
 ## Setup
 
+### Local
+
 The minimum dependencies can be installed with
 
 ```shell
@@ -17,6 +19,18 @@ If running the examples or developing, also install the development dependencies
 pip install -r requirements-dev.txt
 ```
 
+### Docker
+
+Alternatively create a container image and run it using
+
+```shell
+$ docker build -f Dockerfile -t ruivieira/python-trustyai:latest .
+$ docker run --rm -it -p 8888:8888 ruivieira/python-trustyai:latest
+```
+
+The Jupyter server will be available at `localhost:8888`.
+
+
 ## Getting started
 
 To initialise, import the module and specify the location of the `explainability-core` JAR.

notebooks/Counterfactuals.ipynb renamed to examples/Counterfactuals.ipynb

@@ -1,5 +1,6 @@
-black
+black==21.6b0
 joblib
+jupyter
 pandas
 scikit-learn
 pylint