Installation#

Requirements#

  • Python >= 3.10

Installing from PyPI#

The easiest way to install Gators is via pip:

pip install gators

With ONNX export support:

pip install "gators[onnx]"

With tree-based discretizer support (LightGBM):

pip install "gators[tree]"

With all optional dependencies:

pip install "gators[all]"

Installing from Source#

To install the latest development version:

git clone https://github.com/paypal/gators.git
cd gators
pip install -e .

For development (includes testing and documentation dependencies):

pip install -e ".[dev]"

Verifying Installation#

To verify that Gators is installed correctly:

import gators
print(gators.__version__)

You should see the version number printed without any errors.

Core Dependencies#

Gators automatically installs the following core dependencies:

  • polars >= 1.0 - High-performance DataFrame library

  • pydantic >= 2.0 - Data validation and settings management

  • pyarrow >= 12.0 - Efficient data serialization

  • scikit-learn >= 1.0 - Base estimator classes and sklearn API compatibility

  • holidays >= 0.30 - Public holiday detection for HolidayFeatures

Optional Dependencies#

  • onnx >= 1.14 + onnxruntime >= 1.16 — ONNX export (pip install "gators[onnx]")

  • lightgbm >= 4.0 — TreeBasedDiscretizer (pip install "gators[tree]")