Metadata-Version: 1.0
Name: sklearn-xarray
Version: 0.1.4
Summary: xarray integration with sklearn
Home-page: https://phausamann.github.io/sklearn-xarray/
Author: Peter Hausamann
Author-email: peter.hausamann@tum.de
License: UNKNOWN
Description-Content-Type: UNKNOWN
Description: .. -*- mode: rst -*-
        
        |Travis|_ |AppVeyor|_ |CircleCI|_ |Coverage|_ |PyPI|_
        
        .. |Travis| image:: https://travis-ci.org/phausamann/sklearn-xarray.svg?branch=master
        .. _Travis: https://travis-ci.org/phausamann/sklearn-xarray
        
        .. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/qe6ytlg0ja2mqcxr/branch/master?svg=true
        .. _AppVeyor: https://ci.appveyor.com/project/phausamann/sklearn-xarray/branch/master
        
        .. |Coverage| image:: https://coveralls.io/repos/github/phausamann/sklearn-xarray/badge.svg?branch=master
        .. _Coverage: https://coveralls.io/github/phausamann/sklearn-xarray?branch=master
        
        .. |CircleCI| image:: https://circleci.com/gh/phausamann/sklearn-xarray.svg?style=shield&circle-token=:circle-token
        .. _CircleCI: https://circleci.com/gh/phausamann/sklearn-xarray
        
        .. |PyPI| image:: https://badge.fury.io/py/sklearn-xarray.svg
        .. _PyPI: https://badge.fury.io/py/sklearn-xarray
        
        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/
        
        
        Highlights
        -------------
        
        - Makes sklearn estimators compatible with xarray DataArrays and Dataset.
        - Allows for estimators to change the number of samples.
        - Adds a large number of pre-processing transformers.
        
        
        Installation
        -------------
        
        Required dependencies:
        
        - Python 2.7, 3.4, 3.5, or 3.6
        - scikit-learn (0.19 or later, depends on numpy & scipy)
        - xarray (0.10 or later)
        - pandas (0.20 or later)
        
        The package can be installed from ``pip``::
        
            $ pip install sklearn-xarray
        
        For the latest version, you can also install from source::
        
            $ git clone https://github.com/phausamann/sklearn-xarray.git
            $ cd sklearn-xarray
            $ python setup.py install
        
        
        Example
        -------
        
        The `activity recognition example`_ demonstrates how to use the
        package for cross-validated grid search for an activity recognition task. The
        example is also present 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/phausamann/sklearn-xarray/blob/master/.github/CONTRIBUTING.rst>`_
        if you want to contribute to this project.
        
Platform: UNKNOWN
