[docs][python] fix shape description of returned result for predict_p…

…roba (#3933) * Update dask.py * Update sklearn.py
microsoft · Feb 10, 2021 · 15916a9 · 15916a9
1 parent 18d5793
commit 15916a9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/python-package/lightgbm/dask.py b/python-package/lightgbm/dask.py
@@ -630,7 +630,7 @@ def fit(
     fit.__doc__ = (
         _base_doc[:_base_doc.find('callbacks :')]
         + '**kwargs\n'
-        + ' ' * 12 + 'Other parameters passed through to ``LGBMClassifier.fit()``\n'
+        + ' ' * 12 + 'Other parameters passed through to ``LGBMClassifier.fit()``.\n'
     )
 
     def predict(self, X: _DaskMatrixLike, **kwargs: Any) -> dask_Array:
@@ -664,7 +664,7 @@ def predict_proba(self, X: _DaskMatrixLike, **kwargs: Any) -> dask_Array:
         description="Return the predicted probability for each class for each sample.",
         X_shape="Dask Array or Dask DataFrame of shape = [n_samples, n_features]",
         output_name="predicted_probability",
-        predicted_result_shape="Dask Array of shape = [n_samples, n_classes]",
+        predicted_result_shape="Dask Array of shape = [n_samples] or shape = [n_samples, n_classes]",
         X_leaves_shape="Dask Array of shape = [n_samples, n_trees] or shape = [n_samples, n_trees * n_classes]",
         X_SHAP_values_shape="Dask Array of shape = [n_samples, n_features + 1] or shape = [n_samples, (n_features + 1) * n_classes]"
     )
@@ -781,7 +781,7 @@ def fit(
     fit.__doc__ = (
         _base_doc[:_base_doc.find('callbacks :')]
         + '**kwargs\n'
-        + ' ' * 12 + 'Other parameters passed through to ``LGBMRegressor.fit()``\n'
+        + ' ' * 12 + 'Other parameters passed through to ``LGBMRegressor.fit()``.\n'
     )
 
     def predict(self, X: _DaskMatrixLike, **kwargs) -> dask_Array:
@@ -922,7 +922,7 @@ def fit(
     fit.__doc__ = (
         _base_doc[:_base_doc.find('callbacks :')]
         + '**kwargs\n'
-        + ' ' * 12 + 'Other parameters passed through to ``LGBMRanker.fit()``\n'
+        + ' ' * 12 + 'Other parameters passed through to ``LGBMRanker.fit()``.\n'
     )
 
     def predict(self, X: _DaskMatrixLike, **kwargs: Any) -> dask_Array:

diff --git a/python-package/lightgbm/sklearn.py b/python-package/lightgbm/sklearn.py
@@ -933,7 +933,7 @@ def predict_proba(self, X, raw_score=False, start_iteration=0, num_iteration=Non
         description="Return the predicted probability for each class for each sample.",
         X_shape="array-like or sparse matrix of shape = [n_samples, n_features]",
         output_name="predicted_probability",
-        predicted_result_shape="array-like of shape = [n_samples, n_classes]",
+        predicted_result_shape="array-like of shape = [n_samples] or shape = [n_samples, n_classes]",
         X_leaves_shape="array-like of shape = [n_samples, n_trees] or shape = [n_samples, n_trees * n_classes]",
         X_SHAP_values_shape="array-like of shape = [n_samples, n_features + 1] or shape = [n_samples, (n_features + 1) * n_classes] or list with n_classes length of such objects"
     )