Test AutoAPI

MelJan · Apr 7, 2017 · b8573be · b8573be
1 parent 48be43c
commit b8573be
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/docs/__init__.py b/docs/__init__.py
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,6 +11,13 @@ Welcome to PyDeep's documentation!
    :maxdepth: 8
    :caption: Contents:
 
+Welcome
+================================================
+.. toctree::
+   :maxdepth: 2
+
+   Welcome<welcome.rst>
+
 Installation
 ================================================
 .. toctree::

diff --git a/docs/welcome.rst b/docs/welcome.rst
@@ -0,0 +1,25 @@
+Welcome
+##################################
+
+PyDeep is a machine learning / deep learning library with focus on unsupervised learning.
+The library has a modular design, is well documented and  purely written in Python/numpy.
+This allows you to understand, use, modify, and debug the code easily. Furthermore,
+its extensive use of unitests assures a high level of reliability and correctness.
+
+The library contains code I have written during my PhD research allowing you to reproduce
+the results described in the following publications.
+- `Gaussian-binary restricted Boltzmann machines for modeling natural image statistics. Melchior, J., Wang, N., & Wiskott, L.. (2017). PLOS ONE, 12(2), 1–24. <http://doi.org/10.1371/journal.pone.0171015>`_
+- `How to Center Deep Boltzmann Machines. Melchior, J., Fischer, A., & Wiskott, L.. (2016). Journal of Machine Learning Research, 17(99), 1–61. <http://jmlr.org/papers/v17/14-237.html>`_
+- `Gaussian-binary Restricted Boltzmann Machines on Modeling Natural Image statistics Wang, N., Melchior, J., & Wiskott, L.. (2014). (Vol. 1401.5900). arXiv.org e-Print archive. <http://arxiv.org/abs/1401.5900>`_
+- `How to Center Binary Restricted Boltzmann Machines (Vol. 1311.1354). Melchior, J., Fischer, A., Wang, N., & Wiskott, L.. (2013). arXiv.org e-Print archive. <http://arxiv.org/pdf/1311.1354.pdf>`_
+- `An Analysis of Gaussian-Binary Restricted Boltzmann Machines for Natural Images. Wang, N., Melchior, J., & Wiskott, L.. (2012). In Proc. 20th European Symposium on Artificial Neural Networks, Computational Intelligence and Machine Learning, Apr 25–27, Bruges, Belgium (pp. 287–292). <https://www.ini.rub.de/PEOPLE/wiskott/Reprints/WangMelchiorEtAl-2012a-ProcESANN-RBMImages.pdf>`_
+- `Learning Natural Image Statistics with Gaussian-Binary Restricted Boltzmann Machines. Melchior, J, 29.05.2012. Master’s thesis, Applied Computer Science, Univ. of Bochum, Germany. <https://www.ini.rub.de/PEOPLE/wiskott/Reprints/Melchior-2012-MasterThesis-RBMs.pdf>`_
+
+If
+|@misc{melchior2017pydeep,
+|  title={PyDeep},
+|  author={Melchior, Jan},
+|  year={2017},
+|  publisher={GitHub},
+|  howpublished={\url{https://github.com/MelJan/PyDeep.git}},
+|}