mlnext.pipeline.Clip¶

class mlnext.pipeline.Clip(*, columns: List[str] | None = None, lower: float | None = 0.0, upper: float | None = 1.0)[source]¶

Bases: BaseEstimator, TransformerMixin

Transformer that clips a columns to the treshold if the threshold is exceeded. Works with an upper and lower threshold. Wrapper for pd.DataFrame.clip.

Parameters:

columns (T.List[str], optional) – Name of columns. If not provided, all columns in the fitted dataframe are used.
lower (float, optional) – lower limit. Defaults to 0.
upper (float, optional) – upper limit. Defaults to 1.

Example

>>> data = pd.DataFrame({'a': [-0.1, 1.2], 'b': [0.5, 0.6]})
>>> Clip().transform(data)
pd.DataFrame({'a': [0, 1], 'b': [0.5, 0.6]})

Methods

`fit`
`fit_transform`	Fit to data, then transform it.
`get_metadata_routing`	Get metadata routing of this object.
`get_params`	Get parameters for this estimator.
`set_output`	Set output container.
`set_params`	Set the parameters of this estimator.
`transform`	Clips columns to a lower and upper threshold.

fit_transform(X, y=None, **fit_params)¶

Fit to data, then transform it.

Fits transformer to X and y with optional parameters fit_params and returns a transformed version of X.

Parameters:

X (array-like of shape (n_samples, n_features)) – Input samples.
y (array-like of shape (n_samples,) or (n_samples, n_outputs), default=None) – Target values (None for unsupervised transformations).
**fit_params (dict) – Additional fit parameters.

Returns:

X_new – Transformed array.

Return type:

ndarray array of shape (n_samples, n_features_new)

get_metadata_routing()¶

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:: routing – A MetadataRequest encapsulating routing information.
Return type:: MetadataRequest

get_params(deep=True)¶

Get parameters for this estimator.

Parameters:: deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.
Returns:: params – Parameter names mapped to their values.
Return type:: dict

set_output(*, transform=None)¶

Set output container.

See sphx_glr_auto_examples_miscellaneous_plot_set_output.py for an example on how to use the API.

Parameters:

transform ({"default", "pandas", "polars"}, default=None) –

Configure output of transform and fit_transform.

”default”: Default output format of a transformer
”pandas”: DataFrame output
”polars”: Polars output
None: Transform configuration is unchanged

Added in version 1.4: “polars” option was added.

Returns:

self – Estimator instance.

Return type:

estimator instance

set_params(**params)¶

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:: **params (dict) – Estimator parameters.
Returns:: self – Estimator instance.
Return type:: estimator instance

transform(X: DataFrame) → DataFrame[source]¶

Clips columns to a lower and upper threshold.

Parameters:: X (pd.DataFrame) – Dataframe.
Returns:: Returns the new dataframe.
Return type:: pd.DataFrame