Mercurial > pylearn
diff doc/index.txt @ 943:0181459b53a1
merge
author | James Bergstra <bergstrj@iro.umontreal.ca> |
---|---|
date | Wed, 11 Aug 2010 13:16:05 -0400 |
parents | 8837535006f1 |
children | be53f56b37b8 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/index.txt Wed Aug 11 13:16:05 2010 -0400 @@ -0,0 +1,32 @@ + +Welcome +======= + +Pylearn is a Python library for machine learning, built on top of Theano, our +library for defining, optimizing and evaluating mathematical expressions +involving multi-dimensional arrays. + +This documentation is under construction, but you can already access the +automatically-generated API doc, along with more extensive explanations for +some modules. + +Download +======== + +We recommend the latest development version, available via:: + + hg clone http://hg.assembla.com/pylearn Pylearn + +The ``pylearn`` subfolder should be on your ``$PYTHONPATH``. + +Documentation +============= + +For the moment, the following documentation is available. + +* :doc:`io.SeriesTables module <seriestables>` -- Saves error series and other statistics during training +* `API <api/>`_ -- The automatically-generated API documentation + +You can download the latest `PDF documentation <http://deeplearning.net/software/pylearn/pylearn.pdf>`_, rather than reading it online. + +