.. TFSnippet documentation master file, created by
   sphinx-quickstart on Wed Nov 29 11:03:04 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to TFSnippet
====================

TFSnippet is a set of utilities for writing and testing TensorFlow models.

The design philosophy of TFSnippet is `non-interfering`.  It aims to provide a
set of useful utilities, possible to be used along with any other TensorFlow
libraries and frameworks.

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

.. code-block:: bash

    pip install git+https://github.com/thu-ml/zhusuan.git
    pip install git+https://github.com/haowen-xu/tfsnippet.git


API Docs
--------

.. toctree::
   :maxdepth: 1

   api/tfsnippet.applications
   api/tfsnippet.bayes
   api/tfsnippet.dataflow
   api/tfsnippet.distributions
   api/tfsnippet.evaluation
   api/tfsnippet.examples
   api/tfsnippet.flows
   api/tfsnippet.mathops
   api/tfsnippet.modules
   api/tfsnippet.preprocessing
   api/tfsnippet.scaffold
   api/tfsnippet.stochastic
   api/tfsnippet.trainer
   api/tfsnippet.utils
   api/tfsnippet.variational

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`