Metadata-Version: 1.2
Name: torch-tweaks
Version: 0.1.2
Summary: Utility functions for PyTorch.
Home-page: http://github.com/ulf1/torch-tweaks
Author: Ulf Hamster
Author-email: 554c46@gmail.com
License: Apache License 2.0
Description: |PyPI version| |torch-tweaks| |Total alerts| |Language grade: Python|
        |deepcode|
        
        torch-tweaks
        ============
        
        Utility functions for PyTorch.
        
        Usage
        -----
        
        Check the `examples <http://github.com/ulf1/torch-tweaks/examples>`__
        folder for notebooks.
        
        Appendix
        --------
        
        Installation
        ~~~~~~~~~~~~
        
        The ``torch-tweaks`` `git repo <http://github.com/ulf1/torch-tweaks>`__
        is available as `PyPi package <https://pypi.org/project/torch-tweaks>`__
        
        .. code:: sh
        
           pip install torch-tweaks
           pip install git+ssh://git@github.com/ulf1/torch-tweaks.git
        
        Install a virtual environment
        -----------------------------
        
        .. code:: sh
        
           python3.6 -m venv .venv
           source .venv/bin/activate
           pip3 install --upgrade pip
           pip3 install -r requirements.txt
           pip3 install -r requirements-dev.txt
           pip3 install -r requirements-demo.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
        ~~~~~~~~
        
        .. code:: sh
        
           find . -type f -name "*.pyc" | xargs rm
           find . -type d -name "__pycache__" | xargs rm -r
           rm -r .pytest_cache
           rm -r .venv
        
        Support
        -------
        
        Please `open an
        issue <https://github.com/ulf1/torch-tweaks/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/torch-tweaks/compare/>`__.
        
        .. |PyPI version| image:: https://badge.fury.io/py/torch-tweaks.svg
           :target: https://badge.fury.io/py/torch-tweaks
        .. |torch-tweaks| image:: https://snyk.io/advisor/python/torch-tweaks/badge.svg
           :target: https://snyk.io/advisor/python/torch-tweaks
        .. |Total alerts| image:: https://img.shields.io/lgtm/alerts/g/ulf1/torch-tweaks.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/ulf1/torch-tweaks/alerts/
        .. |Language grade: Python| image:: https://img.shields.io/lgtm/grade/python/g/ulf1/torch-tweaks.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/ulf1/torch-tweaks/context:python
        .. |deepcode| image:: https://www.deepcode.ai/api/gh/badge?key=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwbGF0Zm9ybTEiOiJnaCIsIm93bmVyMSI6InVsZjEiLCJyZXBvMSI6InRvcmNoLXR3ZWFrcyIsImluY2x1ZGVMaW50IjpmYWxzZSwiYXV0aG9ySWQiOjI5NDUyLCJpYXQiOjE2MTk1NDA2NTF9.VIP7FQ94UVUiod1McmmDkAFIFvKv9YLbX5kkmIbAjLw
           :target: https://www.deepcode.ai/app/gh/ulf1/torch-tweaks/_/dashboard?utm_content=gh%2Fulf1%2Ftorch-tweaks
        
Platform: UNKNOWN
Requires-Python: >=3.6
