Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the What you really need to know section for the big picture.

julearn.utils.typing.ModelLike¶

class julearn.utils.typing.ModelLike(*args, **kwargs)¶

Class for model-like.

classes_: ndarray¶

predict(X)¶

Predict using the model.

Parameters:: X (DataFrame) – The data to predict on.
Returns:: The predictions.

score(X, y, sample_weight=None)¶

Score the model.

Parameters:

X (DataFrame) – The data to predict on.
y (ndarray | DataFrame | Series) – The true target values.
sample_weight (ndarray | DataFrame | Series | None, default: None) – Sample weights to use when computing the score (default None).

Returns:

The score.

fit(X, y, **kwargs)¶

Fit estimator.

Parameters:

X (ndarray | DataFrame | Series) – The features to use.
y (Series) – The target to use.
**kwargs (Any) – Extra keyword arguments.

Returns:

The fitted estimator.

get_params(deep=True)¶

Get params.

Parameters:: deep (bool, default: True) – Whether to get in a deep fashion (default True).
Returns:: The parameters.

set_params(**params)¶

Set params.

Parameters:: **params (Any) – The parameters to set.
Returns:: Estimator with set parameters.