Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thededlier committed Jun 28, 2020
1 parent afbd71b commit cd554aa
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/usage/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ Initializing Auto-Surprise Engine

.. code-block:: python
engine = Engine(debug=True)
engine = Engine(verbose=True, algorithms=['svd', 'svdpp', 'knn_basic', 'knn_baseline'])
Currently only the parameter available is `debug`, which will raise any caught exceptions instead of trying to continue the process
* `verbose` : By default set to `True`. Controls the verbosity of Auto-Surprise.
* `algorithms` : The algorithms to be optimized. Must be in the form of an array of strings. Available choices are `['svd', 'svdpp', 'nmf', 'knn_basic', 'knn_baseline', 'knn_with_means', 'knn_with_z_score', 'co_clustering', 'slope_one', 'baseline_only']`

Starting the Optimization process
.................................
Expand Down

0 comments on commit cd554aa

Please sign in to comment.