Mercurial > pylearn

view doc/index.txt @ 910:8837535006f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added SeriesTables module (which I had placed originally in the IFT6266 repository) and its doc. Added a logo for the doc and changed conf.py to reflect correct title.
author fsavard
date Thu, 18 Mar 2010 12:23:14 -0400
parents 9472d234db2e
children be53f56b37b8
line wrap: on
line source


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.