填充器#
- class Imputer(method='drift', random_state=None, value=None, forecaster=None, missing_values=None)[source]#
缺失值填充。
Imputer 通过根据
method
指定的填充策略替换缺失值来转换输入时间序列。- 参数:
- methodstr, 默认值=”drift”
填充缺失值的方法。并非所有方法都可以外推,因此在应用
method
后,剩余的缺失值将通过ffill
填充,然后通过bfill
填充。“drift”:首先使用 sktime.PolynomialTrendForecaster(degree=1) 进行漂移/趋势值填充,transform() 中的 X 会先用 ffill 再用 bfill 填充,然后使用 PolynomialTrendForecaster(degree=1) 拟合填充后的 X,并在有缺失值的索引处查询预测值。
- “linear”线性插值,使用 pd.Series.interpolate()
警告:此方法无法外推,因此它始终在提供给 transform() 的数据上进行拟合。
“nearest”:使用最近的值,使用 pd.Series.interpolate()
“constant”:对所有 NaN 使用相同的常量值(在参数 value 中给出)
“mean”:使用
fit
中数据的 pd.Series.mean() 来处理 transform 中的数据,将此估计器封装在FitInTransform
中“median”:使用
fit
中数据的 pd.Series.median() 来处理 transform 中的数据,将此估计器封装在FitInTransform
中“backfill” 到 “bfill”:将
pd.Series.bfill
应用于所有数据“pad” 或 “ffill”:将
pd.Series.ffill
应用于所有数据“random”:使用 fit 数据中 pd.Series.min() 和 .max() 之间的随机值;如果 pd.Series dtype 是 int,则样本为均匀离散;如果 pd.Series dtype 是 float,则样本为均匀连续
“forecaster”:使用参数
forecaster
中给定的 sktime 预测器。首先,fit
中的 X 种子会先用ffill
再用bfill
填充,然后预测器会拟合填充后的 X,并在transform
中具有缺失值的 X 数据索引处查询predict
值。forecaster
总是按变量和实例应用。
以下方法非平凡地拟合
fit
中看到的数据:“drift”、“mean”、“median”、“random”。所有其他方法不依赖于fit
中看到的值。- missing_valuesstr, int, float, regex, list, 或 None, 默认值=None
要被视为 np.nan 并进行插补的值,传递给
DataFrame.replace
。如果为 str, int, float,则除了np.nan
外,所有等于missing_values
的条目都将被插补。如果为 regex,则除了np.nan
外,所有匹配 regex 的条目都将被插补。如果为 list,则必须是 str, int, float 或 regex 的列表。除了np.nan
外,根据上述规则匹配列表中任何元素的条目都将被插补。如果为 None,则只对np.nan
值进行插补。- valueint/float, 默认值=None
当 method=”constant” 时,用于填充缺失值的值。仅当
method="constant"
时使用,否则忽略。- forecaster任何基于 sktime.BaseForecaster 的预测器, 默认值=None
当
method="forecaster"
时,使用给定的预测器通过样本内预测进行插补。在拟合之前,缺失数据将通过method="ffill"
或"bfill"
作为启发式方法进行插补。如果是多元 X,则对每列应用forecaster
的克隆。仅当method="forecaster"
时使用,否则忽略。- random_stateint/float/str, 可选
如果 method=”random”,用于设置 random.seed() 的值,默认值 None。
- 属性:
is_fitted
fit
是否已被调用。
示例
>>> from sktime.transformations.series.impute import Imputer >>> from sktime.datasets import load_airline >>> from sktime.split import temporal_train_test_split >>> y = load_airline() >>> y_train, y_test = temporal_train_test_split(y) >>> transformer = Imputer(method="drift") >>> transformer.fit(y_train) Imputer(...) >>> import numpy as np >>> y_test.iloc[3] = np.nan >>> y_hat = transformer.transform(y_test)
方法
check_is_fitted
([method_name])检查估计器是否已拟合。
clone
()获取具有相同超参数和配置的对象的克隆。
clone_tags
(estimator[, tag_names])将另一个对象的标签克隆为动态覆盖。
create_test_instance
([parameter_set])使用第一个测试参数集构建类的实例。
create_test_instances_and_names
([parameter_set])创建所有测试实例的列表以及它们的名称列表。
fit
(X[, y])将转换器拟合到 X,可选地拟合到 y。
fit_transform
(X[, y])拟合数据,然后对其进行转换。
get_class_tag
(tag_name[, tag_value_default])从类获取类标签值,具有从父类继承的标签级别。
从类获取类标签,具有从父类继承的标签级别。
获取自身的配置标志。
get_fitted_params
([deep])获取拟合参数。
获取对象的默认参数。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,具有标签级别继承和覆盖。
get_tags
()从实例获取标签,具有标签级别继承和覆盖。
get_test_params
([parameter_set])返回估计器的测试参数设置。
inverse_transform
(X[, y])逆转换 X 并返回逆转换后的版本。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化的内存容器加载对象。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的自身保存到字节类对象或 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])设置自身的 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别标签覆盖设置为给定值。
transform
(X[, y])转换 X 并返回转换后的版本。
update
(X[, y, update_params])使用 X(可选地使用 y)更新转换器。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则返回
"default"
集。
- 返回:
- paramsdict 或 dict 列表, 默认值 = {}
用于创建类的测试实例的参数。每个 dict 都是用于构建“有趣”测试实例的参数,例如,
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果没有,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用、处于初始化后状态的独立对象。此函数相当于返回
self
的sklearn.clone
。相当于构造
type(self)
的一个新实例,并使用self
的参数,即type(self)(**self.get_params(deep=False))
。如果在
self
上设置了配置,克隆也将具有与原始对象相同的配置,相当于调用cloned_self.set_config(**self.get_config())
。其值也等同于调用
self.reset
,区别在于clone
返回一个新对象,而不是像reset
那样修改self
。- 引发:
- 如果克隆不符合规范,由于
__init__
错误,则引发 RuntimeError。
- 如果克隆不符合规范,由于
- clone_tags(estimator, tag_names=None)[source]#
将另一个对象的标签克隆为动态覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self`
的键值对,它们是静态标志,在对象构造后不会更改。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中,在构造期间,或通过__init__
直接在构造后调用。动态标签被设置为
estimator
中标签的值,其名称在tag_names
中指定。tag_names
的默认设置是将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
查看。- 参数:
- estimatorAn instance of :class:BaseObject or derived class
- tag_namesstr 或 str 列表, 默认值 = None
要克隆的标签名称。默认值(
None
)克隆estimator
中的所有标签。
- 返回:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构建类的实例。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- instanceinstance of the class with default parameters
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表以及它们的名称列表。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- objslist of instances of cls
第 i 个实例是
cls(**cls.get_test_params()[i])
- nameslist of str, same length as objs
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定是
{cls.__name__}-{i}
,否则是{cls.__name__}
- fit(X, y=None)[source]#
将转换器拟合到 X,可选地拟合到 y。
- 状态变化
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的拟合模型属性,拟合属性可通过
get_fitted_params
查看。将
self.is_fitted
标志设置为True
。如果
self.get_tag("remember_data")
为True
,则将 X 记忆为self._X
,并强制转换为self.get_tag("X_inner_mtype")
。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合和转换的数据。
sktime
中的各种数据格式称为 mtype 规范,每种 mtype 实现一种抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)。Panel
scitype = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
list
。Hierarchical
scitype = 分层时间序列集合。带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选, sktime 兼容数据格式的数据, 默认值=None
附加数据,例如用于转换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,不是可选的。有关所需格式的详细信息,请参阅类文档字符串。
- X
- 返回:
- self估计器的一个已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后对其进行转换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态变化
将状态更改为“已拟合”。
写入自身:_is_fitted:标志设置为 True。_X:X 的强制复制,如果 remember_data 标签为 True
如果可能,通过引用强制转换为内部类型或 update_data 兼容类型
模型属性(以“_”结尾):取决于估计器
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合和转换的数据。
sktime
中的各种数据格式称为 mtype 规范,每种 mtype 实现一种抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)。Panel
scitype = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
list
。Hierarchical
scitype = 分层时间序列集合。带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选, sktime 兼容数据格式的数据, 默认值=None
附加数据,例如用于转换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,不是可选的。有关所需格式的详细信息,请参阅类文档字符串。
- X
- 返回:
- X 的转换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
- X | tf-output | 返回类型 |
|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1-row) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |
- 返回中的实例对应于 X 中的实例
- 表中未列出的组合目前不支持
- 明确地说,举例说明
如果
X
是Series
(例如,pd.DataFrame
)
并且
transform-output
是Series
,则返回的是同一 mtype 的单个 Series。示例:对单个时间序列进行去趋势。如果
X
是Panel
(例如,pd-multiindex
)并且transform-output
是
Series
,则返回的 Panel 与X
具有相同数量的实例(转换器应用于每个输入的 Series 实例)。示例:面板中的所有时间序列都被单独去趋势。如果
X
是Series
或Panel
并且transform-output
是
Primitives
,则返回的是一个pd.DataFrame
,其行数与X
中的实例数相同。示例:返回值的第 i 行包含第 i 个时间序列的均值和方差。如果
X
是Series
并且transform-output
是Panel
,
则返回的是一个
pd-multiindex
类型的Panel
对象。示例:输出的第 i 个实例是运行在X
上的第 i 个窗口。
- classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
从类获取类标签值,具有从父类继承的标签级别。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。get_class_tag
方法是一个类方法,它只考虑类级别的标签值和覆盖来检索标签的值。它从对象中返回名称为
tag_name
的标签值,考虑标签覆盖,优先级递减顺序如下在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索可能带有实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_default任意类型
如果未找到标签,则使用的默认/回退值。
- 返回:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类获取类标签,具有从父类继承的标签级别。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self`
的键值对,它们是静态标志,在对象构造后不会更改。get_class_tags
方法是一个类方法,它只考虑类级别的标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中设置的任何
_tags
属性的键。值是相应的标签值,按优先级递减顺序进行覆盖
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能带有实例覆盖的标签,请改用
get_tags
方法。不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。对于包含来自动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集。不会被set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的临时标志。get_config
返回动态配置,它们覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回:
- config_dictdict
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后应用 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deepbool, 默认值=True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的拟合参数。
- 返回:
- fitted_paramskey 为 str 类型的 dict
拟合参数的字典,包含 paramname : paramvalue 键值对
始终:此对象的所有拟合参数,如通过 get_param_names 获取的,值是该键的拟合参数值,属于此对象,值始终与构造时传递的值相同
如果 deep=True,还包含组件参数的键/值对,组件的参数以 [componentname]__[paramname] 的形式索引,componentname 的所有参数以 paramname 及其值的形式出现
如果 deep=True,还包含任意级别的组件递归,例如 [componentname]__[componentcomponentname]__[paramname] 等
- classmethod get_param_defaults()[source]#
获取对象的默认参数。
- 返回:
- default_dict: dict[str, Any]
键是
cls
中在__init__
中定义了默认值的所有参数。值是默认值,如在__init__
中定义的。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sortbool, 默认值=True
是否按字母顺序返回参数名称 (True),或按它们在类
__init__
中出现的顺序返回 (False)。不进行嵌套,即只影响 self,不影响组件 estimator。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, 默认值=True
是否返回组件的参数。
如果
True
,将返回此对象的参数名称:值字典,包括组件(=BaseObject
类型参数)的参数。如果
False
,将返回此对象的参数名称:值字典,但不包括组件的参数。
- 返回:
- paramskey 为 str 类型的 dict
参数的字典,包含 paramname : paramvalue 键值对
始终:此对象的所有参数,如通过
get_param_names
获取的,值是该键的参数值,属于此对象,值始终与构造时传递的值相同如果
deep=True
,还包含组件参数的键/值对,组件的参数以[componentname]__[paramname]
的形式索引,componentname
的所有参数以paramname
及其值的形式出现如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等
- get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
从实例获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self`
的键值对,它们是静态标志,在对象构造后不会更改。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级递减顺序如下通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型, 可选; 默认值=None
如果未找到标签,则使用的默认/回退值
- raise_errorbool
当未找到标签时是否引发
ValueError
- 返回:
- tag_valueAny
self
中tag_name
标签的值。如果未找到,且raise_error
为 True,则引发错误,否则返回tag_value_default
。
- 引发:
- ValueError,如果
raise_error
为True
。 如果
tag_name
不在self.get_tags().keys()
中,则引发ValueError
。
- ValueError,如果
- get_tags()[source]#
从实例获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self`
的键值对,它们是静态标志,在对象构造后不会更改。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的任何_tags
属性的键,或通过set_tags
或clone_tags
设置的标签。值是相应的标签值,按优先级递减顺序进行覆盖
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性以及_tags_dynamic
对象属性中的任何覆盖和新标签收集。
- inverse_transform(X, y=None)[source]#
逆转换 X 并返回逆转换后的版本。
- 当前假定只有具有以下标签的转换器
“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,
具有 inverse_transform。
- 所需状态
要求状态为“已拟合”。
在自身中的访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合和转换的数据。
sktime
中的各种数据格式称为 mtype 规范,每种 mtype 实现一种抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)。Panel
scitype = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
list
。Hierarchical
scitype = 分层时间序列集合。带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选, sktime 兼容数据格式的数据, 默认值=None
附加数据,例如用于转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X
- 返回:
- X 的逆转换版本
与 X 类型相同,并符合 mtype 格式规范
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象是否有任何参数的值是
BaseObject
的后代实例。
- property is_fitted[source]#
fit
是否已被调用。检查对象的
_is_fitted`
属性,该属性应在对象构造期间初始化为``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化的自身,结果输出到
path
,来自cls.save(path)
- 反序列化的自身,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的自身,结果输出
serial
,来自cls.save(None)
- 反序列化的自身,结果输出
- reset()[source]#
将对象重置为干净的初始化后状态。
结果是将
self
设置为构造函数调用后直接的状态,具有相同的超参数。通过set_config
设置的配置值也保留。reset
调用会删除任何对象属性,除了超参数 = 写入
self
的__init__
参数,例如self.paramname
,其中paramname
是__init__
的参数。包含双下划线(即字符串“__”)的对象属性。例如,保留名为“__myattr”的属性。
配置属性,配置保持不变。也就是说,
reset
前后get_config
的结果相等。
类和对象方法,以及类属性也不受影响。
相当于
clone
,区别在于reset
修改self
而不是返回一个新对象。在调用
self.reset()
后,self
在值和状态上与构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获得的对象相等。- 返回:
- self
类实例重置为干净的初始化后状态,但保留当前超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中序列化的自身;如果path
是文件位置,则将自身以 zip 文件形式存储在该位置保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即 type(self);_obj - 序列化的自身。此类使用默认序列化(pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则 self 保存到内存对象;如果为文件位置,则 self 保存到该文件位置。如果
path=”estimator”,则将在当前工作目录创建 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则将在
存储在
/home/stored/
中。- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项是“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中序列化的自身 - 如果
path
是文件位置 - 指向文件的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示
- displaystr, “diagram” (默认值), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认值=True
打印 self 时是否只列出与默认值不同的 self 参数 (True),或列出所有参数名称和值 (False)。不进行嵌套,即只影响 self,不影响组件 estimator。
- warningsstr, “on” (默认值), 或 “off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 不会引发来自 sktime 的警告
- backend:parallelstr, optional, default=”None”
广播/向量化时用于并行的后端,可选之一:
“None”: 按顺序执行循环,简单的列表推导式
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”: 自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要环境中安装dask
包“ray”: 使用
ray
,需要环境中安装ray
包
- backend:parallel:paramsdict, 可选, 默认值={} (不传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
backend:parallel
的值。“None”: 没有附加参数,
backend_params
被忽略“loky”, “multiprocessing” 和 “threading”: 默认的
joblib
后端。任何有效的joblib.Parallel
键都可以作为参数传递,例如n_jobs
,但backend
除外,因为它由backend
直接控制。如果未传递n_jobs
,它将默认为-1
,其他参数将默认为joblib
的默认值。“joblib”: 自定义和第三方
joblib
后端,例如spark
。任何有效的joblib.Parallel
键都可以作为参数传递,例如n_jobs
。backend
在这种情况下必须作为backend_params
的一个键传递。如果未传递n_jobs
,它将默认为-1
,其他参数将默认为joblib
的默认值。“dask”: 可以传递
dask.compute
的任何有效键,例如scheduler
“ray”: 可以传递以下键:
“ray_remote_args”:
ray.init
的有效键的字典- “shutdown_ray”: bool, 默认值=True; False 防止
ray
在并行化后 关闭。
- “shutdown_ray”: bool, 默认值=True; False 防止
“logger_name”: str, 默认值=”ray”; 要使用的日志记录器的名称。
“mute_warnings”: bool, 默认值=False; 如果为 True,则抑制警告
- input_conversionstr, 可选之一:“on” (默认值), “off”, 或有效的 mtype 字符串
控制输入检查和转换,用于
_fit
,_transform
,_inverse_transform
,_update
"on"
- 执行输入检查和转换"off"
- 在将数据传递给内部方法之前,不执行输入检查和转换有效的 mtype 字符串 - 输入假定为指定的 mtype,执行转换但不进行检查
- output_conversionstr, 可选之一:“on”, “off”, 有效的 mtype 字符串
控制
_transform
,_inverse_transform
的输出转换"on"
- 如果 input_conversion 为 “on”,则执行输出转换"off"
- 直接返回_transform
,_inverse_transform
的输出有效的 mtype 字符串 - 输出转换为指定的 mtype
- 返回:
- self指向 self 的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象和复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确,不使用<component>__
的字符串<parameter>
也可使用,例如组件中没有两个参数名称相同。- 参数:
- \*\*paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。
- 返回:
- self指向 self 的引用(设置参数后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
设置自身的 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为派生自random_state
的整数。这些整数通过sample_dependent_seed
从链式哈希中采样,保证伪随机生成器的独立性。根据
self_policy
,适用于self
中的random_state
参数;并且当且仅当deep=True
时,适用于剩余的组件对象。注意:即使
self
没有random_state
,或没有组件有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState 实例或 None, 默认值=None
伪随机数生成器,用于控制随机整数的生成。传递 int 以在多次函数调用中获得可重复的输出。
- deepbool, 默认值=True
是否在 skbase 对象值的参数中设置随机状态,即组件 estimator 中。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会在组件对象中设置
random_state
参数。
- self_policystr, 可选之一:{“copy”, “keep”, “new”}, 默认值=”copy”
“copy” :
self.random_state
设置为输入的random_state
“keep” :
self.random_state
保持不变“new” :
self.random_state
设置为一个新的随机状态,
派生自输入的
random_state
,通常与输入不同
- 返回:
- self指向 self 的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。标签是特定于实例
self
的键值对,它们是静态标志,在对象构建后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法只能在对象的__init__
方法中,在构建期间调用,或在__init__
后直接调用。当前标签值可以通过
get_tags
或get_tag
查看。- 参数:
- \*\*tag_dictdict
标签名称:标签值对的字典。
- 返回:
- Self
指向 self 的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 所需状态
要求状态为“已拟合”。
在自身中的访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X
sktime
兼容数据容器格式的时间序列 要转换的数据。
sktime
中的各种数据格式称为 mtype 规范,每种 mtype 实现一种抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)。Panel
scitype = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
list
。Hierarchical
scitype = 分层时间序列集合。带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选, sktime 兼容数据格式的数据, 默认值=None
附加数据,例如用于转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X
- 返回:
- X 的转换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
transform
X
-输出
返回类型
序列
原语
pd.DataFrame (1行)
面板
原语
pd.DataFrame
序列
序列
序列
面板
序列
面板
序列
面板
面板
- 返回中的实例对应于 X 中的实例
- 表中未列出的组合目前不支持
- 明确地说,举例说明
如果
X
是Series
(例如,pd.DataFrame
)
并且
transform-output
是Series
,则返回的是同一 mtype 的单个 Series。示例:对单个时间序列进行去趋势。如果
X
是Panel
(例如,pd-multiindex
)并且transform-output
是
Series
,则返回的 Panel 与X
具有相同数量的实例(转换器应用于每个输入的 Series 实例)。示例:面板中的所有时间序列都被单独去趋势。如果
X
是Series
或Panel
并且transform-output
是
Primitives
,则返回的是一个pd.DataFrame
,其行数与X
中的实例数相同。示例:返回值的第 i 行包含第 i 个时间序列的均值和方差。如果
X
是Series
并且transform-output
是Panel
,
则返回的是一个
pd-multiindex
类型的Panel
对象。示例:输出的第 i 个实例是运行在X
上的第 i 个窗口。
- update(X, y=None, update_params=True)[source]#
使用 X(可选地使用 y)更新转换器。
- 所需状态
要求状态为“已拟合”。
在自身中的访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
写入自身
以“_”结尾的拟合模型属性。
如果
remember_data
标签为 True,则通过update_data
将数据写入self._X
,并根据X
中的值进行更新。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于更新转换的数据
sktime
中的各种数据格式称为 mtype 规范,每种 mtype 实现一种抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)。Panel
scitype = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
list
。Hierarchical
scitype = 分层时间序列集合。带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选, sktime 兼容数据格式的数据, 默认值=None
附加数据,例如用于转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X
- 返回:
- self估计器的一个已拟合实例