ParamFitterPipeline

ParamFitterPipeline

class ParamFitterPipeline(param_est, transformers)[source]

Pipeline of transformers and a parameter estimator.

The ParamFitterPipeline compositor chains transformers and a single estimator. The pipeline is constructed with a list of sktime transformers, plus an estimator,

i.e., estimators following the BaseTransformer, ParamFitterPipeline interfaces.

The transformer list can be unnamed - a simple list of transformers -

or string named - a list of pairs of string, estimator.

For a list of transformers trafo1, trafo2, …, trafoN and an estimator est,

the pipeline behaves as follows:

fit(X) - changes state by running trafo1.fit_transform on X,

them trafo2.fit_transform on the output of trafo1.fit_transform, etc sequentially, with trafo[i] receiving the output of trafo[i-1], and then running est.fit with X being the output of trafo[N]

update(X) - changes state by running trafo1.update.transform on X,

them trafo2.update.transform on the output of trafo1.update.transform, etc sequentially, with trafo[i] receiving the output of trafo[i-1], and then running est.update with X being the output of trafo[N]

get_params, set_params uses sklearn compatible nesting interface

if list is unnamed, names are generated as names of classes if names are non-unique, f"_{str(i)}" is appended to each name string

where i is the total count of occurrence of a non-unique string inside the list of names leading up to it (inclusive)

ParamFitterPipeline can also be created by using the magic multiplication

on any parameter estimator, i.e., if est inherits from BaseParamFitter,

and my_trafo1, my_trafo2 inherit from BaseTransformer, then, for instance, my_trafo1 * my_trafo2 * est will result in the same object as obtained from the constructor ParamFitterPipeline(param_est=est, transformers=[my_trafo1, my_trafo2])

magic multiplication can also be used with (str, transformer) pairs,

as long as one element in the chain is a transformer

Parameters:

param_estparameter estimator, i.e., estimator inheriting from BaseParamFitter

this is a “blueprint” estimator, state does not change when fit is called

transformerslist of sktime transformers, or

list of tuples (str, transformer) of sktime transformers these are “blueprint” transformers, states do not change when fit is called

Attributes:

param_est_sktime estimator, clone of estimator in param_est

this clone is fitted in the pipeline when fit is called

transformers_list of tuples (str, transformer) of sktime transformers

clones of transformers in transformers which are fitted in the pipeline is always in (str, transformer) format, even if transformers is just a list strings not passed in transformers are unique generated strings i-th transformer in transformers_ is clone of i-th in transformers

Examples

>>> from sktime.param_est.compose import ParamFitterPipeline
>>> from sktime.param_est.seasonality import SeasonalityACF
>>> from sktime.transformations.difference import Differencer
>>> from sktime.datasets import load_airline
>>>
>>> X = load_airline()
>>> pipe = ParamFitterPipeline(SeasonalityACF(), [Differencer()])
>>> pipe.fit(X)
ParamFitterPipeline(...)
>>> pipe.get_fitted_params()["sp"]
12

Alternative construction via dunder method:

>>> pipe = Differencer() * SeasonalityACF()

Methods

check_is_fitted([method_name])	Check if the estimator has been fitted.
clone()	Obtain a clone of the object with same hyper-parameters and config.
clone_tags(estimator[, tag_names])	Clone tags from another object as dynamic override.
create_test_instance([parameter_set])	Construct an instance of the class, using first test parameter set.
create_test_instances_and_names([parameter_set])	Create list of all test instances and a list of names for them.
fit(X[, y])	Fit estimator and estimate parameters.
get_class_tag(tag_name[, tag_value_default])	Get class tag value from class, with tag level inheritance from parents.
get_class_tags()	Get class tags from class, with tag level inheritance from parent classes.
get_config()	Get config flags for self.
get_fitted_params([deep])	Get fitted parameters.
get_param_defaults()	Get object's parameter defaults.
get_param_names([sort])	Get object's parameter names.
get_params([deep])	Get parameters of estimator in transformers.
get_tag(tag_name[, tag_value_default, ...])	Get tag value from instance, with tag level inheritance and overrides.
get_tags()	Get tags from instance, with tag level inheritance and overrides.
get_test_params([parameter_set])	Return testing parameter settings for the estimator.
is_composite()	Check if the object is composite.
load_from_path(serial)	Load object from file location.
load_from_serial(serial)	Load object from serialized memory container.
reset()	Reset the object to a clean post-init state.
save([path, serialization_format])	Save serialized self to bytes-like object or to (.zip) file.
set_config(**config_dict)	Set config flags to given values.
set_params(**kwargs)	Set the parameters of estimator in transformers.
set_random_state([random_state, deep, ...])	Set random_state pseudo-random seed parameters for self.
set_tags(**tag_dict)	Set instance level tag overrides to given values.
update(X[, y])	Update fitted parameters on more data.