https://github.com/phausamann/sklearn-xarray

Metadata-aware machine learning.
https://github.com/phausamann/sklearn-xarray

framework machine-learning scikit-learn xarray

Last synced: 3 months ago
JSON representation

Metadata-aware machine learning.

• Host: GitHub
• URL: https://github.com/phausamann/sklearn-xarray
• Owner: phausamann
• License: bsd-3-clause
• Created: 2017-11-20T17:48:50.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-05-18T13:47:41.000Z (over 3 years ago)
• Last Synced: 2024-04-24T05:02:36.658Z (10 months ago)
• Topics: framework, machine-learning, scikit-learn, xarray
• Language: Python
• Homepage: http://bit.do/sklearn-xarray
• Size: 8.05 MB
• Stars: 102
• Watchers: 9
• Forks: 12
• Open Issues: 17
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-meteo - sklearn-xarray - learn estimators to xarray types without losing their labels. (Uncategorized / Uncategorized)

README

        
.. -*- mode: rst -*-

|Travis|_ |Coverage|_ |PyPI|_ |Black|_

.. |Travis| image:: https://travis-ci.org/phausamann/sklearn-xarray.svg?branch=master

.. _Travis: https://travis-ci.org/phausamann/sklearn-xarray

.. |Coverage| image:: https://coveralls.io/repos/github/phausamann/sklearn-xarray/badge.svg?branch=master

.. _Coverage: https://coveralls.io/github/phausamann/sklearn-xarray?branch=master

.. |PyPI| image:: https://badge.fury.io/py/sklearn-xarray.svg

.. _PyPI: https://badge.fury.io/py/sklearn-xarray

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg

.. _Black: https://github.com/psf/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.

.. _scikit-learn: http://scikit-learn.org/stable/

.. _xarray: http://xarray.pydata.org

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.

.. _activity recognition example: https://phausamann.github.io/sklearn-xarray/auto_examples/plot_activity_recognition.html

Contributing

------------

Please read the `contribution guide `_

if you want to contribute to this project.