Mercurial > pylearn

annotate doc/index.txt @ 1531:88f361283a19 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix url/name to pylearn2.
author Frederic Bastien <nouiz@nouiz.org>
date Mon, 09 Sep 2013 10:08:05 -0400
parents 0e0f9e8275a9
children
rev   line source
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
1
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
2 Welcome
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
3 =======
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
4
1531
88f361283a19 Fix url/name to pylearn2.
Frederic Bastien <nouiz@nouiz.org>
parents: 1523
diff changeset
5 This library is **outdated**. We are working on new stuff currently in pylearn2 here: https://github.com/lisa-lab/pylearn2/
1523
0e0f9e8275a9 add link to the github pylearn.
Frederic Bastien <nouiz@nouiz.org>
parents: 1519
diff changeset
6
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
7 Pylearn is a Python library for machine learning, built on top of Theano, our
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
8 library for defining, optimizing and evaluating mathematical expressions
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
9 involving multi-dimensional arrays.
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
10
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
11 This documentation is under construction, but you can already access the
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
12 automatically-generated API doc, along with more extensive explanations for
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
13 some modules.
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
14
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
15 Download
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
16 ========
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
17
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
18 We recommend the latest development version, available via::
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
19
1519
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
20 .. code-block:: bash
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
21
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
22 hg clone http://hg.assembla.com/pylearn Pylearn
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
23
1519
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
24 The ``Pylearn/pylearn`` subfolder contains the Python package and must
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
25 be made available to Python programs, for instance by adding the ``Pylearn``
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
26 root folder to your ``PYTHONPATH`` environment varialble:
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
27
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
28 .. code-block:: bash
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
29
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
30 export PYTHONPATH=$PYTHONPATH:/path/to/Pylearn
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
31
1523
0e0f9e8275a9 add link to the github pylearn.
Frederic Bastien <nouiz@nouiz.org>
parents: 1519
diff changeset
32 Assembla project: https://www.assembla.com/spaces/pylearn/
0e0f9e8275a9 add link to the github pylearn.
Frederic Bastien <nouiz@nouiz.org>
parents: 1519
diff changeset
33
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
34 Documentation
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
35 =============
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
36
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
37 For the moment, the following documentation is available.
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
38
1122
be53f56b37b8 Added example cost formula with tags and created a formulas page in the doc
boulanni <nicolas_boulanger@hotmail.com>
parents: 910
diff changeset
39 * `Formulas <formulas.html>`_ -- Built-in math formulas optimized for speed and robustness
910
8837535006f1 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.
fsavard
parents: 908
diff changeset
40 * :doc:`io.SeriesTables module <seriestables>` -- Saves error series and other statistics during training
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
41 * `API <api/>`_ -- The automatically-generated API documentation
1177
b699d096e6cc add a link on the main page to the V2_planning page.
Frederic Bastien <nouiz@nouiz.org>
parents: 1122
diff changeset
42 * `V2 planning <v2_planning/index.html>`_ -- Some documentation about the planning of our next version of pylearn.
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
43
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
44 You can download the latest `PDF documentation <http://deeplearning.net/software/pylearn/pylearn.pdf>`_, rather than reading it online.
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
45
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
46