
.. _libdoc:

=====================
Library 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

   tensor/index
   gradient
   config
   printing
   compile/index
   sparse/index
   scalar/index
   gof/index
   scan

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:`function.function`

.. function:: shared(...)
    
    Alias for :func:`shared.shared`

.. class:: Param

    Alias for :class:`function.Param`

.. function:: dot(x, y)

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


.. function:: __src_version__()

    Returns the mercurial (hg) identifier of the current tip.  
    
    If there are uncommitted modifications, this function raises an Exception.
    If the theano package is not under mercurial control, then again this function
    raises an Exception.

