Skip to content

Commit 2cfb883

Browse files
committed
chore: rework docstring of MultiOutputRegressor
closes freqtrade#11309
1 parent 0130060 commit 2cfb883

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

freqtrade/freqai/base_models/FreqaiMultiOutputRegressor.py

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,21 @@
66
class FreqaiMultiOutputRegressor(MultiOutputRegressor):
77
def fit(self, X, y, sample_weight=None, fit_params=None):
88
"""Fit the model to data, separately for each output variable.
9-
Parameters
10-
----------
11-
X : {array-like, sparse matrix} of shape (n_samples, n_features)
9+
:param X: {array-like, sparse matrix} of shape (n_samples, n_features)
1210
The input data.
13-
y : {array-like, sparse matrix} of shape (n_samples, n_outputs)
11+
:param y: {array-like, sparse matrix} of shape (n_samples, n_outputs)
1412
Multi-output targets. An indicator matrix turns on multilabel
1513
estimation.
16-
sample_weight : array-like of shape (n_samples,), default=None
14+
:param sample_weight: array-like of shape (n_samples,), default=None
1715
Sample weights. If `None`, then samples are equally weighted.
1816
Only supported if the underlying regressor supports sample
1917
weights.
20-
fit_params : A list of dicts for the fit_params
18+
19+
:param fit_params: A list of dicts for the fit_params
2120
Parameters passed to the ``estimator.fit`` method of each step.
2221
Each dict may contain same or different values (e.g. different
2322
eval_sets or init_models)
24-
.. versionadded:: 0.23
25-
Returns
26-
-------
27-
self : object
28-
Returns a fitted instance.
23+
2924
"""
3025

3126
if not hasattr(self.estimator, "fit"):

0 commit comments

Comments
 (0)