diff --git a/README.md b/README.md index 1ad09081..7d0e9028 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,9 @@ pip install fairgbm/python-package/ ``` > **Note** -> Compatibility is only maintained with **Linux OS**. +> Compatibility is only maintained with **Ubuntu OS**. > -> If you don't have access to a Linux machine we advise using the free Google +> If you don't have access to a Ubuntu machine we advise using the free Google > Colab service ([example Colab notebook here](https://colab.research.google.com/github/AndreFCruz/fairgbm-fork/blob/add-colab-example/examples/FairGBM-python-notebooks/FairGBM_example_for_equalized_odds_%5Bgoogle_colab%5D.ipynb)). > > We also provide a docker image that can be useful for non-linux platforms, run: ```docker run -p 8888:8888 ndrcrz/fairgbm-miniconda``` for a jupyter notebook environment with `fairgbm` installed. @@ -75,6 +75,8 @@ using this docker image is an option for users on other platforms (docker image The Dockerfile is available [here](examples/FairGBM-python-notebooks/Dockerfile). +You can also set up your own environment as long as you build a docker image like this [here](examples/Dockerfile) + ## Getting started diff --git a/examples/Dockerfile b/examples/Dockerfile new file mode 100644 index 00000000..61ce11fa --- /dev/null +++ b/examples/Dockerfile @@ -0,0 +1,10 @@ +# Basic image setup +# FROM ubuntu:latest +FROM --platform=linux/amd64 ubuntu:latest + +RUN apt-get update && apt-get install -y wget +RUN apt-get update && apt-get install vim -y + +# Install Miniconda +# RUN wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh +# Recommend: do that after getting into the container