.. _libdoc:
.. _Library documentation:

=================
API Documentation
=================

This documentation covers Theano module-wise.  This is suited to finding the
Types and Ops that you can use to build and compile expression graphs.

.. toctree::
   :maxdepth: 1

   compile/index
   config
   d3viz/index
   gof/index
   gpuarray/index
   gradient
   misc/pkl_utils
   printing
   sandbox/index
   scalar/index
   scan
   sparse/index
   sparse/sandbox
   tensor/index
   typed_list
   tests

There are also some top-level imports that you might find more convenient:


.. module:: theano
   :platform: Unix, Windows
   :synopsis: Theano top-level import
.. moduleauthor:: LISA

.. function:: function(...)
    
    Alias for :func:`theano.compile.function.function`


.. function:: function_dump(...)

    Alias for :func:`theano.compile.function.function_dump`

.. function:: shared(...)
    
    Alias for :func:`theano.compile.sharedvalue.shared`

.. class:: In

    Alias for :class:`function.In`

.. function:: dot(x, y)

    Works like :func:`tensor.dot` for both sparse and dense matrix products

.. autofunction:: theano.clone

.. autofunction:: theano.sparse_grad