Metadata-Version: 2.0
Name: picasso-viz
Version: 0.1.1
Summary: A CNN model visualizer
Home-page: https://github.com/merantix/picasso
Author: Ryan Henderson
Author-email: ryan@merantix.com
License: Eclipse Public License 1.0 (EPL-1.0)
Keywords: picasso
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Eclipse Public License 1.0 (EPL-1.0)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: click (>=6.7)
Requires-Dist: cycler (>=0.10.0)
Requires-Dist: Flask (>=0.12)
Requires-Dist: h5py (>=2.6.0)
Requires-Dist: itsdangerous (>=0.24)
Requires-Dist: Jinja2 (>=2.9.5)
Requires-Dist: Keras (>=1.2.2)
Requires-Dist: MarkupSafe (>=0.23)
Requires-Dist: matplotlib (>=2.0.0)
Requires-Dist: numpy (>=1.12.0)
Requires-Dist: olefile (>=0.44)
Requires-Dist: packaging (>=16.8)
Requires-Dist: Pillow (>=4.0.0)
Requires-Dist: protobuf (>=3.2.0)
Requires-Dist: pyparsing (>=2.1.10)
Requires-Dist: python-dateutil (>=2.6.0)
Requires-Dist: pytz (>=2016.10)
Requires-Dist: PyYAML (>=3.12)
Requires-Dist: requests (>=2.13.0)
Requires-Dist: scipy (>=0.18.1)
Requires-Dist: six (>=1.10.0)
Requires-Dist: tensorflow (>=1.0.0)
Requires-Dist: Werkzeug (>=0.11.15)
Provides-Extra: docs
Requires-Dist: Sphinx; extra == 'docs'
Requires-Dist: sphinxcontrib-napoleon; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-flask; extra == 'test'

===============================
Picasso
===============================


.. image:: https://img.shields.io/pypi/v/picasso-viz.svg
        :target: https://pypi.python.org/pypi/picasso-viz

.. image:: https://img.shields.io/travis/merantix/picasso.svg
        :target: https://travis-ci.org/merantix/picasso

.. image:: https://readthedocs.org/projects/picasso/badge/?version=latest
        :target: https://picasso.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://img.shields.io/codecov/c/github/merantix/picasso/master.svg   
        :target: https://codecov.io/github/merantix/picasso?branch=master


A CNN model visualizer

See the `Medium post`_ for an introduction to Picasso.

* Free software: Eclipse Public License
* Documentation: https://picasso.readthedocs.io.


Quickstart
----------

Picasso uses **Python 3.5+** so use a virtual environment if necessary (e.g. ``virtualenv env --python=python3``) and **activate it!**

#. Install with pip or from source.

   With pip:

   .. code::

        pip install picasso-viz

   From the repository:

   .. code::

        git clone git@github.com:merantix/picasso.git
        cd picasso
        pip install -e .

   Note: you'll need the Tensorflow backend for Keras for these examples to work.  Make sure your ``~/.keras/keras.json`` file looks like:

   .. code::

        {
            "backend": "tensorflow",
            "image_dim_ordering": "tf",
            "floatx": "float32",
            "epsilon": 1e-07
        }

#. Start the Flask server

   .. code::

        export FLASK_APP=picasso
        flask run

   Point your browser to ``127.0.0.1:5000`` and you should see the landing page!  When you're done, ``Ctrl+C`` in the terminal to kill your Flask server.

Building the docs
-----------------

The documentation is much more extensive than this README, and includes instructions on getting the Keras VGG16 and Tensorflow NMIST models working, as well as guides on building your own visualizations and using custom models. This assumes you've cloned the repository. First install the required packages:

.. code::

    pip install -e .[docs]

Then build them:

.. code::

    cd docs/
    make html

Then you can open ``_build/html/index.html`` in your browser of choice.

Notes
---------
#. Models generated on Keras using the Theano backend should in principle be supported.  The only difference is the array ordering of convolutions.  I haven't tried this yet though, so an extra config parameter may be needed.

Credits
---------
* Elias_ and Filippo_ for early code contributions and finding bugs and issues.
* John_, Josh_, Rasmus_, and Stefan_ for their careful code review and feedback.
* The favicon is a modification of this photograph_ of the painting "`Les Demoiselles d'Avignon`_", 1907 by Pablo Picasso. Photograph by Max Braun.
* This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _photograph: https://www.flickr.com/photos/maxbraun/4045020694
.. _`Les Demoiselles d'Avignon`: https://en.wikipedia.org/wiki/Les_Demoiselles_d%27Avignon
.. _Elias: https://github.com/Sylvus
.. _Filippo: https://github.com/scopelf
.. _John: https://github.com/JohnMcSpedon
.. _Josh: https://github.com/jwayne
.. _Rasmus: https://github.com/rrothe
.. _Stefan: https://github.com/knub
.. _`Medium post`: https://medium.com/merantix/picasso-a-free-open-source-visualizer-for-cnns-d8ed3a35cfc5


=======
History
=======

0.1.0 (2017-02-06)
------------------

* First release on PyPI.


