Metadata-Version: 2.1
Name: zca
Version: 0.1.0
Summary: ZCA whitening
Home-page: https://github.com/davebulaval/zca
Author: Maarten Versteegh, David Beauchemin
Author-email: maartenversteegh@gmail.com
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
License-File: LICENSE

===
zca
===

ZCA whitening in python with a sklearn-like interface

Usage
-----

.. code:: python

    from zca import ZCA
    import numpy as np
    X = np.random.random((10000, 15)) # data array
    trf = ZCA().fit(X)
    X_whitened = trf.transform(X)
    X_reconstructed = trf.inverse_transform(X_whitened)
    assert(np.allclose(X, X_reconstructed)) # True


Installation
------------

.. code:: bash

    git clone https://github.com/mwv/zca.git
    cd zca; python setup.py install

Requirements
^^^^^^^^^^^^

- numpy
- scipy
- scikit-learn


Licence
-------
GPLv3

Authors
-------

`zca` was written by `Maarten Versteegh <maartenversteegh@gmail.com>`_.
