Update doc

NicolasHug · Dec 17, 2016 · c6492b6 · c6492b6
1 parent 8e2a41c
commit c6492b6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/surprise/accuracy.py b/surprise/accuracy.py
@@ -29,8 +29,8 @@ def rmse(predictions, verbose=True):
     Args:
         predictions (:obj:`list` of :obj:`Prediction\
             <surprise.prediction_algorithms.predictions.Prediction>`):
-            A list of predictions, as returned by the :meth:`test
-            <surprise.prediction_algorithms.bases.AlgoBase.test>` method.
+            A list of predictions, as returned by the :meth:`test()
+            <surprise.prediction_algorithms.algo_base.AlgoBase.test>` method.
         verbose: If True, will print computed value. Default is ``True``.
 
 
@@ -64,8 +64,8 @@ def mae(predictions, verbose=True):
     Args:
         predictions (:obj:`list` of :obj:`Prediction\
             <surprise.prediction_algorithms.predictions.Prediction>`):
-            A list of predictions, as returned by the :meth:`test
-            <surprise.prediction_algorithms.bases.AlgoBase.test>` method.
+            A list of predictions, as returned by the :meth:`test()
+            <surprise.prediction_algorithms.algo_base.AlgoBase.test>` method.
         verbose: If True, will print computed value. Default is ``True``.
 
 
@@ -98,8 +98,8 @@ def fcp(predictions, verbose=True):
     Args:
         predictions (:obj:`list` of :obj:`Prediction\
             <surprise.prediction_algorithms.predictions.Prediction>`):
-            A list of predictions, as returned by the :meth:`test
-            <surprise.prediction_algorithms.bases.AlgoBase.test>` method.
+            A list of predictions, as returned by the :meth:`test()
+            <surprise.prediction_algorithms.algo_base.AlgoBase.test>` method.
         verbose: If True, will print computed value. Default is ``True``.
 
 

diff --git a/surprise/evaluate.py b/surprise/evaluate.py
@@ -24,7 +24,7 @@ def evaluate(algo, data, measures=['rmse', 'mae'], with_dump=False,
     perform cross validation.
 
     Args:
-        algo(:obj:`AlgoBase <surprise.prediction_algorithms.bases.AlgoBase>`):
+        algo(:obj:`AlgoBase <surprise.prediction_algorithms.algo_base.AlgoBase>`):
             The algorithm to evaluate.
         data(:obj:`Dataset <surprise.dataset.Dataset>`): The dataset on which
             to evaluate the algorithm.

diff --git a/surprise/prediction_algorithms/algo_base.py b/surprise/prediction_algorithms/algo_base.py
@@ -1,5 +1,5 @@
 """
-The :mod:`surprise.prediction_algorithms.bases` module defines the base class
+The :mod:`surprise.prediction_algorithms.algo_base` module defines the base class
 :class:`AlgoBase` from
 which every single prediction algorithm has to inherit.
 """