提交 f464af14 authored 作者: carriepl's avatar carriepl

Merge pull request #3278 from abergeron/doc

Fix most warnings and errors in the doc.
:orphan:
.. _citation:
......@@ -13,7 +14,7 @@ required) to cite the following two papers:
`"Theano: new features and speed improvements"
<http://arxiv.org/pdf/1211.5590.pdf>`_.
NIPS 2012 deep learning workshop. (`BibTex
<http://www.iro.umontreal.ca/~lisa/publications2/index.php/export/publication/551/bibtex>`_)
<http://www.iro.umontreal.ca/~lisa/publications2/index.php/export/publication/551/bibtex>`__)
* J. Bergstra, O. Breuleux, F. Bastien, P. Lamblin, R.
Pascanu, G. Desjardins, J. Turian, D. Warde-Farley and Y.
......@@ -21,7 +22,7 @@ required) to cite the following two papers:
<http://www.iro.umontreal.ca/~lisa/pointeurs/theano_scipy2010.pdf>`_.
*Proceedings of the Python for Scientific Computing Conference (SciPy)
2010. June 30 - July 3, Austin, TX* (`BibTeX
<http://www.iro.umontreal.ca/~lisa/publications2/index.php/export/publication/461/bibtex>`_)
<http://www.iro.umontreal.ca/~lisa/publications2/index.php/export/publication/461/bibtex>`__)
Theano is primarily developed by academics, and so citations matter a lot to
us. As an added benefit, you increase Theano's exposure and potential user
......
:orphan:
Core Development Guide
=======================
......
:orphan:
.. _crei2013_index:
......
......@@ -886,7 +886,7 @@ To understand this profile here is some explanation of how optimizations work:
* 0.028s means it spent that time calls to ``fgraph.validate()``
* 0.131s means it spent that time for callbacks. This is a mechanism that can trigger other execution when there is a change to the FunctionGraph.
* ``time - (name, class, index) - validate time`` tells how the information for each sub-optimizer get printed.
* All other instances of ``SeqOptimizer`` are described like this. In particular, some sub-optimizer from OPT_FAST_RUN that are also ``SeqOptimizer``s.
* All other instances of ``SeqOptimizer`` are described like this. In particular, some sub-optimizer from OPT_FAST_RUN that are also ``SeqOptimizer``.
* The ``SeqOptimizer`` will print some stats at the start:
......@@ -965,7 +965,7 @@ To understand this profile here is some explanation of how optimizations work:
a total of .7s. Its name is ``'canonicalize'``. It is an
``EquilibriumOptimizer``. It was executed at index 4 by the
``SeqOptimizer``. It spent 0.004s in the *validate* phase.
* All other lines are from the profiler of the ``EquilibriumOptimizer`.
* All other lines are from the profiler of the ``EquilibriumOptimizer``.
* An ``EquilibriumOptimizer`` does multiple passes on the Apply nodes from
the graph, trying to apply local and global optimizations.
......
:orphan:
.. _faq:
......
......@@ -178,8 +178,8 @@ Community
Help!
=====
How to seek help
---------------
How to Seek Help
----------------
The appropriate venue for seeking help depends on the kind of question you have.
......@@ -245,7 +245,6 @@ StackOverflow, follow their guidance for `answering questions <http://stackoverf
glossary
links
internal/index
proposals/index
acknowledgement
LICENSE
......
......@@ -199,10 +199,13 @@ the Theano cache like this:
Bleeding-edge install instructions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Master Tests Status:
.. only:: html
.. image:: https://secure.travis-ci.org/Theano/Theano.png?branch=master
:target: http://travis-ci.org/Theano/Theano/builds
Master Tests Status:
.. raw:: html
<a href="http://travis-ci.org/Theano/Theano/builds"><img src="https://secure.travis-ci.org/Theano/Theano.png?branch=master" /></a>&nbsp;
If you are a developer of Theano, then check out the :ref:`dev_start_guide`.
......
:orphan:
.. _install_centos6:
......
:orphan:
.. _install_ubuntu:
Easy Installation of an Optimized Theano on Current Ubuntu
......@@ -174,11 +176,6 @@ Change to the Theano directory and run:
Manual Openblas instruction
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. comment::
I believe this is outdated, my machine seems to be using 8 threads
happily with the binary openblas...
The openblas included in some older Ubuntu version is limited to 2
threads. Ubuntu 14.04 do not have this limit. If you want to use more
cores at the same time, you will need to compile it yourself. Here is
......
:orphan:
.. _install_windows:
......@@ -120,7 +121,7 @@ dependencies is to install `Enthought Python Distribution (EPD) <http://enthough
If you are affiliated with a university (as student or employee), you can
download the installation for free.
EPD installation includes, in particular, Python (and the development headers),
NumPy, SciPy, nose, sphinx, easy_install, pydot (but *not* `Graphviz`_, which is
NumPy, SciPy, nose, sphinx, easy_install, pydot (but *not* Graphviz, which is
necessary for it to work), g++, and the MKL
implementation of blas.
......@@ -299,7 +300,7 @@ By default neither Python, GCC, nor Visual Studio was added to the
PATH. Save the following shell script as ``c:\scisoft\env.bat`` to
configure the system path:
.. code-block:: cmd
.. code-block:: none
REM configuration of paths
set VSFORPYTHON="C:\Program Files (x86)\Common Files\Microsoft\Visual C++ for Python\9.0"
......@@ -335,7 +336,7 @@ programs are found:
Finally we need to create a link library for GCC. Open up the Python
shell and ``cd`` to ``c:\SciSoft``. Then execute:
.. code-block:: cmd
.. code-block:: none
gendef WinPython-64bit-2.7.9.4\python-2.7.9.amd64\python27.dll
......
:orphan:
.. _opfromgraph:
===========
......
......@@ -129,23 +129,27 @@ Functions
=========
.. automodule:: theano.sandbox.cuda.dnn
:members: dnn_conv, dnn_pool
:noindex:
:members: dnn_conv, dnn_pool
Convolution Ops
===============
.. automodule:: theano.sandbox.cuda.dnn
:members: GpuDnnConvDesc, GpuDnnConv, GpuDnnConv3d, GpuDnnConvGradW,
GpuDnnConv3dGradW, GpuDnnConvGradI, GpuDnnConv3dGradI
:noindex:
:members: GpuDnnConvDesc, GpuDnnConv, GpuDnnConv3d, GpuDnnConvGradW,
GpuDnnConv3dGradW, GpuDnnConvGradI, GpuDnnConv3dGradI
Pooling Ops
===========
.. automodule:: theano.sandbox.cuda.dnn
:members: GpuDnnPoolDesc, GpuDnnPool, GpuDnnPoolGrad
:noindex:
:members: GpuDnnPoolDesc, GpuDnnPool, GpuDnnPoolGrad
Softmax Ops
===========
.. automodule:: theano.sandbox.cuda.dnn
:members: GpuDnnSoftmax, GpuDnnSoftmaxGrad
:noindex:
:members: GpuDnnSoftmax, GpuDnnSoftmaxGrad
......@@ -1652,6 +1652,7 @@ Linear Algebra
number, then the stop is not inclusive.
Example:
>>> a = T.mgrid[0:5, 0:3]
>>> a[0].eval()
array([[0, 0, 0],
......@@ -1675,6 +1676,7 @@ Linear Algebra
not a complex number, then the stop is not inclusive.
Example:
>>> b = T.ogrid[0:5, 0:3]
>>> b[0].eval()
array([[0],
......
:orphan:
"Thank YOU for correcting it so quickly. I wish all packages I worked
with would have such an active maintenance - this is as good as it
......
:orphan:
.. _proposals:
......@@ -7,9 +8,7 @@ Proposals for new/revised features
.. toctree::
:maxdepth: 1
:glob:
*
pfunc
noupdates
opt_patterns2
graphical_models
complex_gradient
:orphan:
=========================================================
Sandbox, this documentation may or may not be out-of-date
=========================================================
......
......@@ -465,9 +465,9 @@ There are :ref:`other distributions implemented <libdoc_tensor_raw_random>`.
Other Implementations
---------------------
There is 2 other implementations based on :ref:`MRG31k3p
There are 2 other implementations based on :ref:`MRG31k3p
<libdoc_rng_mrg>` and :class:`CURAND <theano.sandbox.cuda.rng_curand>`.
The RandomStream only work on the CPU, MRG31k3p
The RandomStream only work on the CPU, MRG31k3p
work on the CPU and GPU. CURAND only work on the GPU.
.. note::
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论