Tutorials cross links added

MelJan · Apr 22, 2017 · 6706a73 · 6706a73
1 parent a616fdb
commit 6706a73
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 12 deletions.
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -5,11 +5,11 @@ Tutorials
 
    PCA 2D<tutorials/PCA_2D_example.rst>
 
-   Eigenfaces<tutorials/eigenfaces.rst>
+   PCA Eigenfaces<tutorials/PCA_eigenfaces.rst>
 
    ICA 2D<tutorials/ICA_2D_example.rst>
 
    ICA on natural images<tutorials/ICA_natural_images.rst>
 
-   Small centered binary RBM on MNIST<tutorials/Binary_RBM_MNIST_small.rst>
+   RBM binary small on MNIST<tutorials/Binary_RBM_MNIST_small.rst>
 
diff --git a/docs/tutorials/Binary_RBM_MNIST_small.rst b/docs/tutorials/Binary_RBM_MNIST_small.rst
@@ -1,4 +1,4 @@
-Binary RBM
+Small centered/normal binary RBM on MNIST
 ==========================================================
 
 Example for training a centered and normal Binary Restricted Boltzmann machine on the MNIST handwritten digit dataset and the flipped version.
@@ -125,6 +125,6 @@ Source code
 
 .. figure:: images/download_icon.png
    :scale: 20 %
-   :target: https://github.com/MelJan/PyDeep/blob/master/examples/ICA_natural_images.py
+   :target: https://github.com/MelJan/PyDeep/blob/master/examples/RBM_binary_MNIST_small.py
 
-.. literalinclude:: ../../examples/ICA_natural_images.py
+.. literalinclude:: ../../examples/.py
diff --git a/docs/tutorials/ICA_2D_example.rst b/docs/tutorials/ICA_2D_example.rst
@@ -1,3 +1,5 @@
+.. _ICA_2D_example:
+
 Independent Component Analysis on a 2D example.
 =======================================================
 
@@ -45,9 +47,7 @@ We can also back-project the ICA projection matrix back to the original space an
    :scale: 75 %
    :alt: Examples of ICA 2D
 
-For a real-world application see the ICA_Natural_Images example.
-
-.. _code:
+For a real-world application see the `ICA_natural_images <ICA_natural_images.html#_ICA_Natural_Images>`__ example.
 
 Source code
 ***********

diff --git a/docs/tutorials/ICA_natural_images.rst b/docs/tutorials/ICA_natural_images.rst
@@ -1,10 +1,12 @@
+.. _ICA_Natural_Images:
+
 Independent Component Analysis on a natural image patches
 ==========================================================
 
 Example for Independent Component Analysis (`ICA <https://en.wikipedia.org/wiki/Principal_component_analysis>`_)
 on natural image patches. The independent components (columns of the ICA projection matrix) of natural image patches are edge detector filters.
 
-See ICA_2D_example for a theoretical introduction.
+See  `ICA_2D_example <ICA_2D_example.html#ICA_2D_example>`__ for a theoretical introduction.
 
 Visualization of 100 examples of the gray scale natural image dataset.
 

diff --git a/docs/tutorials/PCA_2D_example.rst b/docs/tutorials/PCA_2D_example.rst
@@ -1,3 +1,5 @@
+.. _PCA_2D_example:
+
 Principal Component Analysis 2D example.
 ============================================
 
@@ -31,7 +33,7 @@ The PCA class can also perform whitening and data and extracted principal compon
    :scale: 50 %
    :alt: Examples of PCA 2D in whitened space
 
-For a real-world application see the eigenfaces example.
+For a real-world application see the `PCA_eigenfaces <PCA_eigenfaces.html#PCA_eigenfaces>`__ example.
 
 .. _code:
 

diff --git a/docs/tutorials/eigenfaces.rst → docs/tutorials/PCA_eigenfaces.rst b/docs/tutorials/eigenfaces.rst → docs/tutorials/PCA_eigenfaces.rst
@@ -1,8 +1,12 @@
+.. _PCA_eigenfaces:
+
 Eigenfaces
 ===========
 
 Example for Principal Component Analysis (PCA) on face images also known as `Eigenfaces <https://en.wikipedia.org/wiki/Eigenface>`_
 
+See  `PCA_2D_example <PCA_2D_example.html#PCA_2D_example>`__ for a theoretical introduction.
+
 The code_ given below produces the following output.
 
 Some examples of the face images of the olivetti face dataset.
@@ -44,6 +48,6 @@ Source code
 
 .. figure:: images/download_icon.png
    :scale: 20 %
-   :target: https://github.com/MelJan/PyDeep/blob/master/examples/eigenfaces.py
+   :target: https://github.com/MelJan/PyDeep/blob/master/examples/PCA_eigenfaces.py
 
-.. literalinclude:: ../../examples/Eigenfaces.py
+.. literalinclude:: ../../examples/PCA_eigenfaces.py
diff --git a/examples/Eigenfaces.py → examples/PCA_eigenfaces.py b/examples/Eigenfaces.py → examples/PCA_eigenfaces.py
diff --git a/examples/Binary_RBM_MNIST_small.py → examples/RBM_binary_MNIST_small.py b/examples/Binary_RBM_MNIST_small.py → examples/RBM_binary_MNIST_small.py