update readme, and docs

darwinbandoy · Jan 2, 2017 · b9bd936 · b9bd936
1 parent 13fdbe1
commit b9bd936
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ Current
 Enhancements
 ------------
 
+* Added the GridSearch feature, by Maher
 * Added a 'clip' option to the predict() method
 * Added NMF algorithm
 * Added entry point for better command line usage.

diff --git a/README.md b/README.md
@@ -123,7 +123,7 @@ the GNU [time](http://man7.org/linux/man-pages/man1/time.1.html) command.
 | [KNNBasic](http://surprise.readthedocs.io/en/latest/knn_inspired.html#surprise.prediction_algorithms.knns.KNNBasic)        |  .9789 |  .7732 |    27    |
 | [KNNWithMeans](http://surprise.readthedocs.io/en/latest/knn_inspired.html#surprise.prediction_algorithms.knns.KNNWithMeans)    |  .9514 |  .7500 |    30    |
 | [KNNBaseline](http://surprise.readthedocs.io/en/latest/knn_inspired.html#surprise.prediction_algorithms.knns.KNNBaseline)     |  .9306 |  .7334 |    44    |
-| [SVD](http://surprise.readthedocs.io/en/latest/matrix_factorization.html#surprise.prediction_algorithms.matrix_factorization.SVD)             |  .9392 |  .7409 |    46    |
+| [SVD](http://surprise.readthedocs.io/en/latest/matrix_factorization.html#surprise.prediction_algorithms.matrix_factorization.SVD)             |  .9396 |  .7412 |    46    |
 | [SVD++](http://surprise.readthedocs.io/en/latest/matrix_factorization.html#surprise.prediction_algorithms.matrix_factorization.SVDpp)             |  .9200 |  .7253 |    31min    |
 | [NMF](http://surprise.readthedocs.io/en/latest/matrix_factorization.html#surprise.prediction_algorithms.matrix_factorization.NMF)             |  .9634 |  .7572 |    55    |
 | [Slope One](http://surprise.readthedocs.io/en/latest/slope_one.html#surprise.prediction_algorithms.slope_one.SlopeOne)             |  .9454 |  .7430 |    25    |

diff --git a/TODO.md b/TODO.md
@@ -2,8 +2,6 @@ TODO
 ====
 
 * Profile code (mostly cython) to see what could be optimized
-* allow a 'clip' option to the predict method? Also, describe r_min and r_max
-* update SVD benchmark
 
 Maybe, Maybe not
 ----------------
@@ -14,6 +12,7 @@ Maybe, Maybe not
 Done:
 -----
 
+* allow a 'clip' option to the predict method? Also, describe r_min and r_max
 * configure entrypoints to use surprise directly from command line
 * Allow a 'biased' option in the SVD algo. If true, use baselines, if False,
   don't. It should be pretty easy to do.

diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
@@ -253,3 +253,18 @@ words, so here a few `jupyter <http://jupyter.org/>`_ notebooks:
     <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/>`_.
+
+Command line usage
+~~~~~~~~~~~~~~~~~~
+
+Surprise can also be used from the command line, for example:
+
+.. code::
+
+    surprise -algo SVD -params "{'n_epochs': 5, 'verbose': True}" -load-builtin ml-100k -n-folds 3
+
+See detailed usage by running:
+
+.. code::
+
+    surprise -h
diff --git a/surprise/__main__.py b/surprise/__main__.py
@@ -45,7 +45,7 @@ def error(self, message):
         'Please refer to the documentation page ' +
         '(http://surprise.readthedocs.io/) for more details.',
         epilog="""Example:\n
-        python -m surprise -algo SVD -params "{'n_epochs': 5, 'verbose': True}"
+        surprise -algo SVD -params "{'n_epochs': 5, 'verbose': True}"
         -load-builtin ml-100k -n-folds 3""")
 
     algo_choices = {