Note

This page is a reference documentation. It only explains the class 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.JuEstimatorLike#

class julearn.utils.typing.JuEstimatorLike(*args, **kwargs)#

Class for juestimator-like.

__init__(*args, **kwargs)#
get_needed_types()#

Get the column types needed by the estimator.

Returns:
ColumnTypes

The column types needed by the estimator.

get_apply_to()#

Get the column types the estimator applies to.

Returns:
ColumnTypes

The column types the estimator applies to.

fit(X, y, **kwargs)#

Fit estimator.

Parameters:
XDataLike

The features to use.

ypd.Series

The target to use.

**kwargsdict

Extra keyword arguments.

Returns:
EstimatorLikeFit1

The fitted estimator.

get_params(deep=True)#

Get params.

Parameters:
deepbool, optional

Whether to get in a deep fashion (default True).

Returns:
dict

The parameters.

set_params(**params)#

Set params.

Parameters:
**paramsdict

The parameters to set.

Returns:
EstimatorLikeFit1

Estimator with set parameters.