.. _tutorial:

********
Tutorial
********

.. version-string::


.. only:: html

    This document is also available as `pdf file.
    <http://downloads.sourceforge.net/mdp-toolkit/MDP-tutorial.pdf?download>`_

.. only:: latex

    This document is also available `online. <../../tutorial/tutorial.html>`_


This is a guide to basic and some more advanced features of
the MDP library. Besides the present tutorial, you can learn
more about MDP by using the standard Python tools.
All MDP nodes have doc-strings, the public
attributes and methods have telling names: All information about a
node can be obtained using  the ``help`` and ``dir`` functions within
the Python interpreter. In addition to that, an automatically generated
`API documentation
<../../api/index.html>`_
is available.

.. Note::
  Code snippets throughout the script will be denoted by::

      >>> print "Hello world!"
      Hello world!

  To run the following code examples don't forget to import ``mdp``
  and ``numpy`` in your Python session with::

     >>> import mdp
     >>> import numpy as np


.. only:: html

   You'll find all the code of this tutorial :ref:`here <code_snippets>`.

.. only:: latex

   You'll find all the code of this tutorial `online
   <../../code/code_snippets.html>`_.


.. toctree::

   quick_start.rst
   introduction.rst
   nodes.rst
   flows.rst
   iterables.rst
   checkpoints.rst
   extensions.rst
   hinet.rst
   parallel.rst
   caching.rst
   classifiers.rst
   wrappers.rst
   bimdp.rst
