Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Correct the compatibility description #47

Open
wants to merge 1 commit into
base: main-fairgbm
Choose a base branch
from
Open

Correct the compatibility description #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down
10 changes: 10 additions & 0 deletions examples/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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