Unverified Commit 858cc0a7 authored by James Lamb's avatar James Lamb Committed by GitHub
Browse files

[docs] [dask] Add return information to Dask fit() docs (fixes #4402) (#4716)

* [docs] [dask] Add return information to Dask fit() docs (fixes #4402)

* put return before note
parent 560a0350
...@@ -1213,6 +1213,11 @@ class DaskLGBMClassifier(LGBMClassifier, _DaskLGBMModel): ...@@ -1213,6 +1213,11 @@ class DaskLGBMClassifier(LGBMClassifier, _DaskLGBMModel):
fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs
Other parameters passed through to ``LGBMClassifier.fit()``. Other parameters passed through to ``LGBMClassifier.fit()``.
Returns
-------
self : lightgbm.DaskLGBMClassifier
Returns self.
{_lgbmmodel_doc_custom_eval_note} {_lgbmmodel_doc_custom_eval_note}
""" """
...@@ -1393,6 +1398,11 @@ class DaskLGBMRegressor(LGBMRegressor, _DaskLGBMModel): ...@@ -1393,6 +1398,11 @@ class DaskLGBMRegressor(LGBMRegressor, _DaskLGBMModel):
fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs
Other parameters passed through to ``LGBMRegressor.fit()``. Other parameters passed through to ``LGBMRegressor.fit()``.
Returns
-------
self : lightgbm.DaskLGBMRegressor
Returns self.
{_lgbmmodel_doc_custom_eval_note} {_lgbmmodel_doc_custom_eval_note}
""" """
...@@ -1556,6 +1566,11 @@ class DaskLGBMRanker(LGBMRanker, _DaskLGBMModel): ...@@ -1556,6 +1566,11 @@ class DaskLGBMRanker(LGBMRanker, _DaskLGBMModel):
fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs
Other parameters passed through to ``LGBMRanker.fit()``. Other parameters passed through to ``LGBMRanker.fit()``.
Returns
-------
self : lightgbm.DaskLGBMRanker
Returns self.
{_lgbmmodel_doc_custom_eval_note} {_lgbmmodel_doc_custom_eval_note}
""" """
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment