Metadata-Version: 2.4
Name: sklearn-xarray-ext
Version: 0.5.0
Summary: xarray integration with sklearn (maintained fork)
Author-email: mmann1123 <mmann1123@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/mmann1123/sklearn-xarray
Project-URL: Repository, https://github.com/mmann1123/sklearn-xarray
Project-URL: Issues, https://github.com/mmann1123/sklearn-xarray/issues
Keywords: scikit-learn,xarray,machine-learning
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: scikit-learn
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: numpy-groupies
Dynamic: license-file

.. -*- mode: rst -*-

|PyPI|_ |Black|_

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

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

sklearn-xarray-ext
==================

**sklearn-xarray-ext** is a maintained fork of `sklearn-xarray
<https://github.com/phausamann/sklearn-xarray>`_ by Peter Hausamann.

It 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 original 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-ext


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 <https://github.com/mmann1123/sklearn-xarray/blob/master/.github/CONTRIBUTING.rst>`_
if you want to contribute to this project.
