UPD: add parameter's description in docstring

scikit-learn-contrib · Jul 12, 2023 · bda371a · bda371a
1 parent 3d1b774
commit bda371a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/mapie/estimator/estimator.py b/mapie/estimator/estimator.py
@@ -470,7 +470,9 @@ def predict(
  By default ``False``.
 
  return_multi_pred: bool
-
+ If ``True`` the method returns the predictions and the multiple
+ predictions (3 arrays). If ``False`` the method return the
+ simple predictions only.
 
  Returns
  -------

diff --git a/mapie/estimator/interface.py b/mapie/estimator/interface.py
@@ -73,7 +73,9 @@ def predict(
  By default ``False``.
 
  return_multi_pred: bool
-
+ If ``True`` the method returns the predictions and the multiple
+ predictions (3 arrays). If ``False`` the method return the
+ simple predictions only.
 
  Returns
  -------