Mercurial > pylearn

annotate doc/index.txt @ 1519:04d859714506

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clearer instructions on how to set PYTHONPATH
author Olivier Delalleau <delallea@iro>
date Sat, 29 Sep 2012 20:28:48 -0400
parents 9ce32a8252d2
children 0e0f9e8275a9
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
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
5 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
6 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
7 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
8
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
9 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
10 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
11 some modules.
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
12
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
13 Download
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
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
16 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
17
1519
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
18 .. code-block:: bash
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
19
908
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
20 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
21
1519
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
22 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
23 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
24 root folder to your ``PYTHONPATH`` environment varialble:
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
25
04d859714506 Clearer instructions on how to set PYTHONPATH
Olivier Delalleau <delallea@iro>
parents: 1222
diff changeset
26 .. code-block:: bash
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 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
29
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
30 Documentation
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
31 =============
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
32
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
33 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
34
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
35 * `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
36 * :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
37 * `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
38 * `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
39
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
40 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
41
9472d234db2e Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff changeset
42