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.TransformerLike¶

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

Class for transformer-like.

fit(X, y, **fit_params)¶

Fit transformer.

Parameters:

X (ndarray | DataFrame | Series) – The features to use.
y (ndarray | DataFrame | Series) – The target to use (default None).
**fit_params (Any) – Fit parameters.

transform(X)¶

Transform.

Parameters:: X (ndarray | DataFrame | Series) – The features to use.
Returns:: The transformed data.

fit_transform(X, y=None)¶

Fit and transform.

Parameters:

X (ndarray | DataFrame | Series) – The features to use.
y (ndarray | DataFrame | Series | None, default: None) – The target to use (default None).

Returns:

The fit and transformed object.

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.