FeatureUnion#
- class FeatureUnion(transformer_list, n_jobs=None, transformer_weights=None, flatten_transform_index=True)[source]#
连接多个转换器对象的结果。
此估计器将转换器对象列表并行应用于输入数据,然后连接结果。这对于将多种特征提取机制组合到单个转换器中非常有用。转换的参数可以使用其名称和由“__”分隔的参数名称来设置。通过将其参数设置为另一个转换器,可以将转换器完全替换;或者通过设置为“drop”或
None
来删除。- 参数:
- transformer_listlist,元素为 (string, transformer) 元组
要应用于数据的转换器对象列表。每个元组的第一部分是转换器的名称。
- n_jobsint 或 None,可选 (默认为 None)
并行运行的作业数。
None
表示 1,除非在joblib.parallel_backend
上下文中。-1
表示使用所有处理器。- transformer_weightsdict,可选
每个转换器特征的乘法权重。键是转换器名称,值是权重。
- flatten_transform_indexbool,可选 (默认为 True)
如果为 True,返回 DataFrame 的列是平铺的,格式为“transformer__variablename”;如果为 False,列是 MultiIndex (transformer, variablename)。如果返回 mtype 是没有列名的类型,则此参数无效。
- 属性:
is_fitted
是否已调用
fit
方法。
方法
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])FeatureUnion 的测试参数。
inverse_transform
(X[, y])对 X 进行逆变换并返回逆变换后的版本。
检查对象是否是复合对象。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的对象自身保存到字节类对象或到 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**kwargs)设置估计器的参数。
set_random_state
([random_state, deep, ...])为对象自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别标签覆盖设置为给定值。
transform
(X[, y])变换 X 并返回变换后的版本。
update
(X[, y, update_params])使用 X 更新转换器,可选地使用 y。
- 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
进行检查。- 参数:
- estimator:class:BaseObject 或派生类的一个实例
- tag_namesstr 或 str 列表,默认为 None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的一个实例。
- 参数:
- parameter_setstr,默认为“default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类的实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例及其名称的列表。
- 参数:
- parameter_setstr,默认为“default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 的实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,与 objs 长度相同
第 i 个元素是测试中 obj 的第 i 个实例的名称。命名约定为
{cls.__name__}-{i}
如果实例多于一个,否则为{cls.__name__}
- fit(X, y=None)[source]#
将转换器拟合到 X,可选拟合到 y。
- 状态改变
将状态更改为“已拟合”("fitted")。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
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 = 时间序列集合。pd.DataFrame
带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
包含Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 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 的变换版本。
- 状态改变
将状态更改为“已拟合”("fitted")。
写入自身: _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 = 时间序列集合。pd.DataFrame
带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
包含Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 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 行) |
| 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
,则返回是与X
具有相同实例数的 Panel(转换器应用于每个输入的 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
tag_name
标签在self
中的值。如果未找到,则返回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]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”("fitted")。
- 参数:
- deepbool,默认为 True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名 : 值 字典,包括可拟合组件(= BaseEstimator 值的参数)的已拟合参数。
如果为 False,将返回此对象的参数名 : 值 字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为 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__
中定义的默认值。
- 类方法 get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sortbool,默认值为 True
是否按字母顺序返回参数名称(True),或按它们在类
__init__
中出现的顺序返回(False)。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取估计器的参数。
- 参数:
- deepboolean,可选
如果为 True,将返回此估计器和包含的子对象(如果它们是估计器)的参数。
- 返回:
- params字符串到任意类型的映射
参数名称映射到其值。
- 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 方法。
- 所需状态
要求状态为“已拟合”("fitted")。
在 self 中访问
以 “_” 结尾的已拟合模型属性。
self.is_fitted
,必须为 True。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合和变换的数据。
sktime
中的个体数据格式是所谓的 mtype 规范,每种 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。pd.DataFrame
带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
包含Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X
- 返回:
- X 的逆变换版本。
与 X 类型相同,并符合 mtype 格式规范。
- is_composite()[source]#
检查对象是否是复合对象。
复合对象是指包含其他对象作为参数的对象。由于这可能因实例而异,因此在其上调用此方法。
- 返回:
- composite: bool,self 是否包含一个参数是 BaseObject。
- 属性 is_fitted[source]#
是否已调用
fit
方法。检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已进行 fit。
- 类方法 load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object”) 的结果
- 返回:
- 反序列化后的 self,其结果位于
path
,是cls.save(path)
的输出。
- 反序列化后的 self,其结果位于
- 类方法 load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化后的 self,其结果是
serial
,是cls.save(None)
的输出。
- 反序列化后的 self,其结果是
- 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,则返回内存中的序列化 self;如果path
是文件位置,则将 self 存储在该位置作为 zip 文件保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化后的 self。此类别使用默认序列化(pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则将 self 保存到内存对象;如果是文件位置,则将 self 保存到该文件位置。如果
path="estimator" 则会在当前工作目录创建一个 zip 文件
estimator.zip
。path="/home/stored/estimator" 则会在
/home/stored/
中创建一个 zip 文件estimator.zip
。
存储在
/home/stored/
中。- serialization_format: str, 默认值 = “pickle”
用于序列化的模块。可用选项有 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
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 而不影响组件估计器。
- warningsstr,“on”(默认)或“off”
是否引发警告,仅影响 sktime 的警告。
“on” = 将引发来自 sktime 的警告。
“off” = 不会引发来自 sktime 的警告。
- backend:parallelstr,可选,默认值 = “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 的引用。
Notes
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
为对象自身设置 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为从random_state
派生的整数,通过链式哈希 (chain hashing) 使用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 对象的参数中设置随机状态,即组件估计器。
如果为 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 并返回变换后的版本。
- 所需状态
要求状态为“已拟合”("fitted")。
在 self 中访问
以 “_” 结尾的已拟合模型属性。
self.is_fitted
,必须为 True。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 要转换的数据。
sktime
中的个体数据格式是所谓的 mtype 规范,每种 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。pd.DataFrame
带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
包含Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X
- 返回:
- X 的变换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
transform
X
-输出
返回类型
Series
Primitives
pd.DataFrame (1行)
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
,则返回是与X
具有相同实例数的 Panel(转换器应用于每个输入的 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。
- 所需状态
要求状态为“已拟合”("fitted")。
在 self 中访问
以 “_” 结尾的已拟合模型属性。
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 = 时间序列集合。pd.DataFrame
带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
包含Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X
- 返回:
- self估计器的一个已拟合实例