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.pipeline.JuTargetPipeline¶
- class julearn.pipeline.JuTargetPipeline(steps)¶
Class for pipelines that work on the target.
Unlike the
sklearn.pipeline.Pipeline, this pipeline fits and transforms using both X and y. This is useful for pipelines that work on the target but require information from the input data, such as thejulearn.transformers.target.TargetConfoundRemoveror a target encoder that requires one of the features to be present.IMPORTANT: Using any of the transformers that transforms the target based on the input data will result in data leakage if the features are not dropped after the transformation.
- Parameters:
- stepsList[Tuple[str, Union[JuTargetTransformer, TransformerLike]]]
List of steps to be performed on the target.
- __init__(steps)¶
- fit_transform(X, y)¶
Fit and transform the target.
- Parameters:
- Xpd.DataFrame
The input data.
- yDataLike
The target.
- Returns:
- yDataLike
The transformed target.
- fit(X, y)¶
Fit the target pipeline.
- Parameters:
- Xpd.DataFrame
The input data.
- yDataLike
The target.
- Returns:
- selfJuTargetPipeline
The fitted pipeline.
- transform(X, y)¶
Transform the target.
- Parameters:
- Xpd.DataFrame
The input data.
- yDataLike
The target.
- Returns:
- yDataLike
The transformed target.
- inverse_transform(X, y)¶
Inverse transform the target.
- Parameters:
- Xpd.DataFrame
The input data.
- yDataLike
The target.
- Returns:
- yDataLike
The inverse transformed target.
- can_inverse_transform()¶
Check if the pipeline can inverse transform.
- Returns:
- bool
True if the pipeline can inverse transform.
- property needed_types¶
Get the needed types for the pipeline.
- Returns:
- needed_typesSet of str or None
The needed types for the pipeline.