Improve documentation

kranthi-nord · Sep 4, 2018 · 0989bb2 · 0989bb2
1 parent 6119b27
commit 0989bb2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -82,7 +82,10 @@ detection utility functions.
      2. **Feature Bagging** [9]
 
   5. Neural Networks and Deep Learning Models (implemented in Keras)
-     1. **AutoEncoder with Fully Connected NN** [16, Chapter 3]
+     1. **AutoEncoder with Fully Connected NN** [16, Chapter 3] 
+
+        FAQ regarding AutoEncoder in PyOD and debugging advices:
+        [known issues](https://github.com/yzhao062/Pyod/issues/19) 
 
 ***Outlier Detector/Scores Combination Frameworks***:
   1. **Feature Bagging**: build various detectors on random selected features [9]

diff --git a/docs/figs/KNN.png b/docs/figs/KNN.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -74,7 +74,7 @@ detection utility functions.
 
 3. Probabilistic Models for Outlier Detection:
 
-  i. **ABOD: Angle-Based Outlier Detection** cite:`a-kriegel2008angle`: :class:`pyod.models.abod.ABOD`
+  i. **ABOD: Angle-Based Outlier Detection** :cite:`a-kriegel2008angle`: :class:`pyod.models.abod.ABOD`
   ii. **FastABOD: Fast Angle-Based Outlier Detection using approximation** cite:`a-kriegel2008angle`: :class:`pyod.models.abod.ABOD`
 
 4. Outlier Ensembles and Combination Frameworks
@@ -84,6 +84,7 @@ detection utility functions.
 
 5. Neural Networks and Deep Learning Models (implemented in Keras):
   i. **AutoEncoder with Fully Connected NN** :cite:`a-aggarwal2015outlier`: :class:`pyod.models.auto_encoder.AutoEncoder`
+     FAQ regarding AutoEncoder in PyOD and debugging advices: `known issues <https://github.com/yzhao062/Pyod/issues/19>`_
 
 **Outlier Detector/Scores Combination Frameworks**: