Edit/api documentation (#179)

* Delete old evaluation notebook * Add local execution parameter * Update API Documentation
neuroinfo-os · Oct 24, 2018 · b86059d · b86059d
1 parent e410368
commit b86059d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 28 deletions.
diff --git a/docs/api_doc/deep_bottleneck.callbacks.rst b/docs/api_doc/deep_bottleneck.callbacks.rst
@@ -4,6 +4,14 @@ deep\_bottleneck.callbacks package
 Submodules
 ----------
 
+deep\_bottleneck.callbacks.activity\_logger module
+--------------------------------------------------
+
+.. automodule:: deep_bottleneck.callbacks.activity_logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 deep\_bottleneck.callbacks.activityprojector module
 ---------------------------------------------------
 
@@ -20,10 +28,10 @@ deep\_bottleneck.callbacks.earlystopping\_manual module
     :undoc-members:
     :show-inheritance:
 
-deep\_bottleneck.callbacks.loggingreporter module
--------------------------------------------------
+deep\_bottleneck.callbacks.gradient\_logger module
+--------------------------------------------------
 
-.. automodule:: deep_bottleneck.callbacks.loggingreporter
+.. automodule:: deep_bottleneck.callbacks.gradient_logger
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/api_doc/deep_bottleneck.datasets.rst b/docs/api_doc/deep_bottleneck.datasets.rst
@@ -5,7 +5,7 @@ Submodules
 ----------
 
 deep\_bottleneck.datasets.base\_dataset module
------------------------------------------------
+----------------------------------------------
 
 .. automodule:: deep_bottleneck.datasets.base_dataset
     :members:

diff --git a/docs/api_doc/modules.rst b/docs/api_doc/modules.rst
@@ -1,5 +1,5 @@
-API Documentation
-=================
+deep_bottleneck
+===============
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/literature_summary.rst b/docs/literature_summary.rst
@@ -54,29 +54,10 @@ Shwartz-Ziv, R., & Tishby, N. (2017). Opening the black box of deep neural netwo
 ^^^^^^^^^^^^^^
 
 
-
-4. ON THE INFORMATION BOTTLENECK THEORY OF DEEP LEARNING (Saxe 2018)
---------------------------------------------------------------------
-Saxe, A. M., Bansal, Y., Dapello, J., Advani, M., Kolchinsky, A., Tracey, B. D., & Cox, D. D. (2018, May). On the information bottleneck theory of deep learning. In International Conference on Learning Representations.
-
-4.1. Glossary
-^^^^^^^^^^^^^
-
-4.2. Structure
-^^^^^^^^^^^^^^
-
-4.3. Criticisim
-^^^^^^^^^^^^^^^
-
-4.4. Todo List
-^^^^^^^^^^^^^^
-
-
-
-5. ON THE INFORMATION BOTTLENECK THEORY OF DEEP LEARNING
+4. ON THE INFORMATION BOTTLENECK THEORY OF DEEP LEARNING
 --------------------------------------------------------
 
-:cite:`Andrew2017`
+Saxe, A. M., Bansal, Y., Dapello, J., Advani, M., Kolchinsky, A., Tracey, B. D., & Cox, D. D. (2018, May). On the information bottleneck theory of deep learning. In International Conference on Learning Representations.
 
 Key Points of the paper:
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -111,7 +92,7 @@ Key Points of the paper:
 |
 
 Most important Experiments:
-^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 #. Tishby's experiment reconstructed: 
 
     * 7 fully connected hidden layers of width 12-10-7-5-4-3-2