Mercurial > pylearn
comparison doc/index.txt @ 908:9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
| author | fsavard |
|---|---|
| date | Thu, 18 Mar 2010 11:33:49 -0400 |
| parents | |
| children | 8837535006f1 |
comparison
equal
deleted
inserted
replaced
| 904:08b37147dec1 | 908:9472d234db2e |
|---|---|
| 1 | |
| 2 Welcome | |
| 3 ======= | |
| 4 | |
| 5 Pylearn is a Python library for machine learning, built on top of Theano, our | |
| 6 library for defining, optimizing and evaluating mathematical expressions | |
| 7 involving multi-dimensional arrays. | |
| 8 | |
| 9 This documentation is under construction, but you can already access the | |
| 10 automatically-generated API doc, along with more extensive explanations for | |
| 11 some modules. | |
| 12 | |
| 13 Download | |
| 14 ======== | |
| 15 | |
| 16 We recommend the latest development version, available via:: | |
| 17 | |
| 18 hg clone http://hg.assembla.com/pylearn Pylearn | |
| 19 | |
| 20 The ``pylearn`` subfolder should be on your ``$PYTHONPATH``. | |
| 21 | |
| 22 Documentation | |
| 23 ============= | |
| 24 | |
| 25 For the moment, the following documentation is available. | |
| 26 | |
| 27 * `API <api/>`_ -- The automatically-generated API documentation | |
| 28 | |
| 29 You can download the latest `PDF documentation <http://deeplearning.net/software/pylearn/pylearn.pdf>`_, rather than reading it online. | |
| 30 | |
| 31 |