提交 b6b5f4d1 authored 作者: Pascal Lamblin's avatar Pascal Lamblin 提交者: GitHub

Merge pull request #5016 from slefrancois/readme-to-rst

Convert Github readme.txt to .rst
To install the package, see this page: To install the package, see this page:
http://deeplearning.net/software/theano/install.html http://deeplearning.net/software/theano/install.html
For the documentation, see the project website: For the documentation, see the project website:
http://deeplearning.net/software/theano/ http://deeplearning.net/software/theano/
Related Projects: Related Projects:
https://github.com/Theano/Theano/wiki/Related-projects https://github.com/Theano/Theano/wiki/Related-projects
It is recommended that you look at the documentation on the website, as it will be more current than the documentation included with the package. It is recommended that you look at the documentation on the website, as it will be more current than the documentation included with the package.
In order to build the documentation yourself, you will need sphinx. Issue the following command: In order to build the documentation yourself, you will need sphinx. Issue the following command:
python ./doc/scripts/docgen.py
Documentation is built into html/ ::
The PDF of the documentation can be found at html/theano.pdf python ./doc/scripts/docgen.py
Documentation is built into ``html/``
The PDF of the documentation can be found at ``html/theano.pdf``
================
DIRECTORY LAYOUT DIRECTORY LAYOUT
================
``Theano`` (current directory) is the distribution directory.
* ``Theano/theano`` contains the package
* ``Theano/theano`` has several submodules:
* ``gof`` + ``compile`` are the core
* ``scalar`` depends upon core
* ``tensor`` depends upon ``scalar``
* ``sparse`` depends upon ``tensor``
* ``sandbox`` can depend on everything else
Theano (current directory) is the distribution directory. * ``Theano/examples`` are copies of the example found on the wiki
* Theano/theano contains the package * ``Theano/benchmark`` and ``Theano/examples`` are in the distribution, but not in
* Theano/theano has several submodules:
* gof + compile are the core
* scalar depends upon core
* tensor depends upon scalar
* sparse depends upon tensor
* sandbox can depend on everything else
* Theano/examples are copies of the example found on the wiki
* Theano/benchmark and Theano/examples are in the distribution, but not in
the Python package the Python package
* Theano/bin contains executable scripts that are copied to the bin folder * ``Theano/bin`` contains executable scripts that are copied to the bin folder
when the Python package is installed when the Python package is installed
* Tests are distributed and are part of the package, i.e. fall in * Tests are distributed and are part of the package, i.e. fall in
the appropriate submodules the appropriate submodules
* Theano/doc contains files and scripts used to generate the documentation * ``Theano/doc`` contains files and scripts used to generate the documentation
* Theano/html is where the documentation will be generated * ``Theano/html`` is where the documentation will be generated
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论