Installation

Prerequisites

Gators requires the following dependencies:

• python >=3.6

• numpy

• cython

• sklearn

• pandas

• pyspark

• koalas

• xgboost

• lightgbm

• treelite

• treelite-runtime

Install

From PyPi or conda-forge

The default installation (in-memory data only):

>>> pip install gators
>>> conda install gators

To handle out-of-core data, you can choose to install Dask, Koalas, or both:

>>> pip install gators"[dask, koalas]"
>>> conda install gators"[dask, koalas]"

To install the dev gators environment: Extra packages

>>> git clone git@github.paypal.com:Simility-R/gators.git
>>> cd gators
>>> pip install -r requirements.txt
>>> python setup.py build_ext --inplace
>>> brew install libomp
>>> pip install .[dev]

Test and coverage

Test

>>> pytest gators -v

Test coverage

>>> pip install pytest-cov
>>> pytest -v --cov-report html:cov_html --cov=gators gators

Contribute

You can contribute to this code through Pull Request on GitHub. Please, make sure that your code is coming with unit tests to ensure full coverage and continuous integration in the API.