mlnext.pipeline.TimeframeExtractor¶

class mlnext.pipeline.TimeframeExtractor(*, time_column: str, start_time: str | time, end_time: str | time, invert: bool = False, verbose: bool = False)[source]¶

Bases: BaseEstimator, TransformerMixin

Drops samples that are not between a given start_time and end_time. Limits are inclusive.

Parameters:

time_column (str) – Column name of the datetime column.
start_time (str, datetime.time) – Start time. Can be parsed from a str.
end_time (str, datetime.time) – End time. Can be parsed from a str.
invert (bool) – Whether to invert the range. If True, then rows between start_time and end_time are removed.
verbose (bool, optional) – Whether to be verbose.

Example

>>> data = pd.DataFrame(
    {'dates': [datetime.datetime(2021, 7, 2, 9, 50, 0),
               datetime.datetime(2021, 7, 2, 11, 0, 0),
               datetime.datetime(2021, 7, 2, 12, 10, 0)],
     'values': [0, 1, 2]})
>>> TimeframeExtractor(time_column='dates',
                       start_time= datetime.time(10, 0, 0),
                       end_time=datetime.time(12, 0, 0)
                       ).transform(data)
pd.DataFrame({'dates': datetime.datetime(2021, 7, 2, 11, 0, 0),
              'values': [1]})

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`	Drops rows from the dataframe if they are not in between start_time and end_time.

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]¶

Drops rows from the dataframe if they are not in between start_time and end_time. Limits are inclusive. Reindexes the dataframe.

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