Metadata-Version: 1.2
Name: sklearn-fracdiff
Version: 0.2.2
Summary: sklearn wrapper for numpy-fracdiff
Home-page: http://github.com/ulf1/sklearn-fracdiff
Author: Ulf Hamster
Author-email: 554c46@gmail.com
License: Apache License 2.0
Description: |PyPI version| |sklearn-fracdiff| |Total alerts| |Language grade:
        Python| |deepcode|
        
        sklearn-fracdiff
        ================
        
        Usage
        -----
        
        .. code:: python
        
           from sklearn_fracdiff import FracDiff
           obj = FracDiff(order=0.7)
           obj.fit(X)
           Z = obj.transform(X)
        
        Check the
        `examples <http://github.com/ulf1/sklearn-fracdiff/examples>`__ folder
        for notebooks.
        
        Appendix
        --------
        
        Installation
        ------------
        
        The ``sklearn-fracdiff`` `git
        repo <http://github.com/ulf1/sklearn-fracdiff>`__ is available as `PyPi
        package <https://pypi.org/project/sklearn-fracdiff>`__
        
        ::
        
           pip install sklearn-fracdiff
           pip install git+ssh://git@github.com/ulf1/sklearn-fracdiff.git
        
        Install a virtual environment
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ::
        
           python3.6 -m venv .venv
           source .venv/bin/activate
           pip3 install --upgrade pip
           pip3 install -r requirements.txt
        
        (If your git repo is stored in a folder with whitespaces, then don’t use
        the subfolder ``.venv``. Use an absolute path without whitespaces.)
        
        Python commands
        ~~~~~~~~~~~~~~~
        
        -  Jupyter for the examples: ``jupyter lab``
        -  Check syntax:
           ``flake8 --ignore=F401 --exclude=$(grep -v '^#' .gitignore | xargs | sed -e 's/ /,/g')``
        -  Run Unit Tests: ``pytest``
        
        Publish
        
        .. code:: sh
        
           pandoc README.md --from markdown --to rst -s -o README.rst
           python setup.py sdist 
           twine upload -r pypi dist/*
        
        Clean up
        ~~~~~~~~
        
        ::
        
           find . -type f -name "*.pyc" | xargs rm
           find . -type d -name "__pycache__" | xargs rm -r
           rm -r .venv
        
        Support
        ~~~~~~~
        
        Please `open an
        issue <https://github.com/ulf1/sklearn-fracdiff/issues/new>`__ for
        support.
        
        Contributing
        ~~~~~~~~~~~~
        
        Please contribute using `Github
        Flow <https://guides.github.com/introduction/flow/>`__. Create a branch,
        add commits, and `open a pull
        request <https://github.com/ulf1/sklearn-fracdiff/compare/>`__.
        
        .. |PyPI version| image:: https://badge.fury.io/py/sklearn-fracdiff.svg
           :target: https://badge.fury.io/py/sklearn-fracdiff
        .. |sklearn-fracdiff| image:: https://snyk.io/advisor/python/sklearn-fracdiff/badge.svg
           :target: https://snyk.io/advisor/python/sklearn-fracdiff
        .. |Total alerts| image:: https://img.shields.io/lgtm/alerts/g/ulf1/sklearn-fracdiff.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/ulf1/sklearn-fracdiff/alerts/
        .. |Language grade: Python| image:: https://img.shields.io/lgtm/grade/python/g/ulf1/sklearn-fracdiff.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/ulf1/sklearn-fracdiff/context:python
        .. |deepcode| image:: https://www.deepcode.ai/api/gh/badge?key=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwbGF0Zm9ybTEiOiJnaCIsIm93bmVyMSI6InVsZjEiLCJyZXBvMSI6InNrbGVhcm4tZnJhY2RpZmYiLCJpbmNsdWRlTGludCI6ZmFsc2UsImF1dGhvcklkIjoyOTQ1MiwiaWF0IjoxNjE5NTQwNDUwfQ.KgIRPr_d9Lea36sOqfnkKHr-KOtkhiuZN3JwqV3JCQA
           :target: https://www.deepcode.ai/app/gh/ulf1/sklearn-fracdiff/_/dashboard?utm_content=gh%2Fulf1%2Fsklearn-fracdiff
        
Platform: UNKNOWN
Requires-Python: >=3.6
