Metadata-Version: 2.1
Name: pytorch-lantern
Version: 0.11.0
Summary: Pytorch project template and related tools
Home-page: https://github.com/Aiwizo/pytorch-lantern
License: Apache-2.0
Keywords: pytorch,machine,learning
Author: Aiwizo
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: imgaug (>=0.4.0,<0.5.0)
Requires-Dist: numpy (>=1.19.4,<2.0.0)
Requires-Dist: opencv-python (>=4.4.0,<5.0.0)
Requires-Dist: pytorch-datastream (>=0.4.0,<0.5.0)
Requires-Dist: tensorboard (>=2.2.0,<3.0.0)
Requires-Dist: torch (>=1.6.0,<2.0.0)
Requires-Dist: tqdm (>=4.51.0,<5.0.0)
Project-URL: Documentation, https://pytorch-lantern.readthedocs.io
Project-URL: Repository, https://github.com/Aiwizo/pytorch-lantern
Description-Content-Type: text/x-rst

================
Pytorch Lantern
================

.. image:: https://badge.fury.io/py/pytorch-lantern.svg
       :target: https://badge.fury.io/py/pytorch-lantern

.. image:: https://img.shields.io/pypi/pyversions/pytorch-lantern.svg
       :target: https://pypi.python.org/pypi/pytorch-lantern

.. image:: https://readthedocs.org/projects/pytorch-lantern/badge/?version=latest
       :target: https://pytorch-lantern.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/pypi/l/pytorch-lantern.svg
       :target: https://pypi.python.org/pypi/pytorch-lantern

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

Lantern contains our process of bringing a project to fruition as
efficiently as possible. This is subject to change as we iterate and improve.
This package implements tools and missing features to help bridge the gap
between frameworks and libraries that we utilize.

The main packages and tools that we build around are:

- `pytorch <https://pytorch.org>`_
- `pytorch-datastream <https://github.com/Aiwizo/pytorch-datastream>`_
- `guild <https://guild.ai>`_


See the `documentation <https://pytorch-lantern.readthedocs.io/en/latest/>`_
for more information.

Create new project with template
================================

Install `cookiecutter <https://github.com/cookiecutter/cookiecutter>`_
and `poetry <https://github.com/python-poetry/poetry>`_:

.. code-block::

    pip install cookiecutter
    curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

Setup project:

.. code-block::

    cookiecutter https://github.com/aiwizo/pytorch-lantern-template.git
    cd <new-project>
    poetry install

You can now train the placeholder model and inspect the results:

.. code-block::

    guild run prepare
    guild run train
    guild tensorboard

Use lantern without templates
==============================

Install lantern from pypi using pip or poetry:

.. code-block::

    poetry add pytorch-lantern
    # pip install pytorch-lantern

