Updated notebooks

darwinbandoy · May 3, 2017 · 4862135 · 4862135
1 parent 23d1965
commit 4862135
Show file tree

Hide file tree

Showing 5 changed files with 259 additions and 300 deletions.
diff --git a/TODO.md b/TODO.md
@@ -1,9 +1,6 @@
 TODO
 ====
 
-* Complete FAQ
-
-* Rewright stuff on prediction dumping for analysis (l.40 building_on_algo)
 * Allow to discount similarities (see aggarwal)
 * Support conda?
 * Allow incremental updates for some algorithms
@@ -18,6 +15,7 @@ Maybe, Maybe not
 Done:
 -----
 
+* Complete FAQ
 * Change the dumping machinery to be more consistent 
 * Allow to test on the trainset
 * make bibtex entry

diff --git a/doc/source/FAQ.rst b/doc/source/FAQ.rst
@@ -75,6 +75,17 @@ serialized. It is then reloaded and can be used again for making predictions:
     :name: serialize_algorithm.py
     :lines: 9-
 
+.. _further_analysis:
+
+Algorithms can be serialized along with their predictions, so that can be
+further analyzed or compared with other algorithms, using pandas dataframes.
+Some examples are given in the two following notebooks:
+
+    * `Dumping and analysis of the KNNBasic algorithm
+      <http://nbviewer.jupyter.org/github/NicolasHug/Surprise/tree/master/examples/notebooks/KNNBasic_analysis.ipynb/>`_.
+    * `Comparison of two algorithms
+      <http://nbviewer.jupyter.org/github/NicolasHug/Surprise/tree/master/examples/notebooks/Compare.ipynb/>`_.
+
 How to build my own prediction algorithm
 ----------------------------------------
 

diff --git a/doc/source/building_custom_algo.rst b/doc/source/building_custom_algo.rst
@@ -37,7 +37,7 @@ return a dictionary with given details: ::
 
 This dictionary will be stored in the :class:`prediction
 <surprise.prediction_algorithms.predictions.Prediction>` as the ``details``
-field and can be used for later analysis.
+field and can be used for :ref:`later analysis <further_analysis>`.