Skip to content

phausamann/sklearn-xarray

Repository files navigation

Travis Coverage PyPI Black

sklearn-xarray

sklearn-xarray is an open-source python package that combines the n-dimensional labeled arrays of xarray with the machine learning and model selection tools of scikit-learn. The package contains wrappers that allow the user to apply scikit-learn estimators to xarray types without losing their labels.

Documentation

The package documentation can be found at https://phausamann.github.io/sklearn-xarray/

Features

  • Makes sklearn estimators compatible with xarray DataArrays and Datasets.
  • Allows for estimators to change the number of samples.
  • Adds a large number of pre-processing transformers.

Installation

The package can be installed with pip:

$ pip install sklearn-xarray

or with conda:

$ conda install -c phausamann sklearn-xarray

Example

The activity recognition example demonstrates how to use the package for cross-validated grid search for an activity recognition task. You can also download the example as a jupyter notebook.

Contributing

Please read the contribution guide if you want to contribute to this project.