ColumnwiseTransformer#
- class ColumnwiseTransformer(transformer, columns=None)[source]#
将转换器逐列应用于多元时间序列。
概述:输入多元时间序列,将
transformer
参数中传入的转换器应用于指定的columns
。每列被视为一个单变量序列进行处理。转换后的数据与输入数据具有相同的形状。- 参数:
- transformer估计器
类似于 scikit-learn 或 sktime 的转换器,用于拟合并应用于序列。
- columnsstr 或 None 的列表
需要进行转换的列名。如果为 None,则转换所有列。
- 属性:
- transformers_{str转换器} 的字典
将列映射到转换器。
- columns_str 的列表
需要进行转换的列名。
另请参阅
示例
>>> from sktime.datasets import load_longley >>> from sktime.transformations.series.detrend import Detrender >>> from sktime.transformations.compose import ColumnwiseTransformer >>> _, X = load_longley() >>> transformer = ColumnwiseTransformer(Detrender()) >>> Xt = transformer.fit_transform(X)
方法
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])从类中获取类标签值,继承父类的标签级别。
从类中获取类标签,继承父类的标签级别。
获取 self 的配置标志。
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 进行逆转换并返回逆转换后的版本。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化的内存容器加载对象。
reset
()将对象重置到初始化的干净状态。
save
([path, serialization_format])将序列化的 self 保存到字节对象或 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为指定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为 self 设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别的标签覆盖设置为指定值。
transform
(X[, y])转换 X 并返回转换后的版本。
update
(X[, y, update_params])更新参数。
- update(X, y=None, update_params=True)[source]#
更新参数。
通过迭代指定列,使用新数据更新估计器的参数。仅当
self.transformer
具有update
方法时才有效。- 参数:
- Xpd.Series
新的时间序列。
- update_paramsbool,可选,默认为 True
- 返回值:
- selfself 的一个实例
- 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]#
获取具有相同超参数和配置的对象的克隆。
克隆是另一个没有共享引用的对象,处于初始化后的状态。此函数等效于返回
sklearn.clone
的self
。等效于构造一个
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。
- 状态变化
将状态更改为“已拟合”。
写入 self
设置以“_”结尾的拟合模型属性,拟合属性可以通过
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
中传递,而不是可选。有关所需格式,请参阅类 docstring 中的详细信息。
- X
- 返回值:
- self估计器的拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后对其进行转换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态变化
将状态更改为“已拟合”。
写入 self: _is_fitted : 标志设为 True。_X : X,如果 remember_data 标签为 True,则是 X 的强制转换副本
可能在可能的情况下,通过引用强制转换为内部类型或 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
中传递,而不是可选。有关所需格式,请参阅类 docstring 中的详细信息。
- 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
,则返回是具有与X
中实例数量相同行数的pd.DataFrame
。示例:返回的第 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 的配置标志。
配置是
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_params具有 str 类型键的字典
拟合参数字典,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)。
- 返回值:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则与它们在类__init__
中出现的顺序相同。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool,默认为 True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名 : 参数值dict
,包括组件 (=BaseObject
类型参数) 的参数。如果为
False
,将返回此对象的参数名 : 参数值dict
,但不包括组件的参数。
- 返回值:
- params具有 str 类型键的字典
参数字典,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 中的
以“_”结尾的拟合模型属性。
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
附加数据,例如用于转换的标签。某些转换器需要此数据,详情请参阅类 docstring。
- X
- 返回值:
- X 的逆转换版本
类型与 X 相同,并符合 mtype 格式规范
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回值:
- 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) 的结果
- 返回值:
- 反序列化的 self,结果输出到
path
,对应于cls.save(path)
- 反序列化的 self,结果输出到
- classmethod 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]#
将序列化的 self 保存到字节对象或 (.zip) 文件。
行为:如果
path
为 None,返回一个内存中的序列化对象自身;如果path
是文件位置,则将对象自身存储在该位置为一个 zip 文件保存的文件是 zip 文件,包含以下内容: _metadata - 包含对象自身的类,即 type(self);_obj - 序列化后的对象自身。此类使用默认的序列化格式 (pickle)。
- 参数:
- pathNone 或文件位置 (str or Path)
如果为 None,对象自身将被保存到内存对象中;如果是文件位置,对象自身将被保存到该文件位置。
如果 path=”estimator”,则会在当前工作目录 (cwd) 创建一个 zip 文件
estimator.zip
。如果 path=”/home/stored/estimator”,则会在
/home/stored/
中存储一个 zip 文件estimator.zip
。- serialization_format: str,默认值 = “pickle”
用于序列化的模块。可用的选项为 “pickle” 和 “cloudpickle”。注意,非默认格式可能需要安装其他软依赖项。
- 返回值:
- 如果
path
为 None - 内存中的序列化对象自身 - 如果
path
是文件位置 - 指向文件的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为指定值。
- 参数:
- config_dictdict
配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示
- displaystr,“diagram”(默认)或“text”
jupyter 内核如何显示对象自身实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认值=True
打印对象自身时是否只列出与默认值不同的自身参数 (False),或所有参数名称和值 (False)。不嵌套,即只影响对象自身而不影响组件估计器。
- 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
由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”;要使用的 logger 名称。
“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对自身的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。对于复合对象(即包含其他对象的对象),可以使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果引用是明确的,例如没有两个组件的参数同名<parameter>
,则也可以使用字符串<parameter>
,不带<component>__
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果在 get_params 键中是唯一的,__
后缀可以作为完整字符串的别名。
- 返回值:
- self对自身的引用 (设置参数后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
为 self 设置 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为从random_state
派生的整数。这些整数是通过sample_dependent_seed
从链式哈希中采样的,并保证种子随机生成器的伪随机独立性。根据
self_policy
,应用于对象自身的random_state
参数,当且仅当deep=True
时,也应用于剩余组件对象。注意:即使对象自身没有
random_state
参数,或者任何组件都没有random_state
参数,此方法也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState 实例或 None,默认值=None
用于控制随机整数生成的伪随机数生成器。传递 int 可在多次函数调用中获得可重现的输出。
- deepbool,默认为 True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则只设置对象自身的
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对自身的引用
- set_tags(**tag_dict)[source]#
将实例级别的标签覆盖设置为指定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。标签是特定于实例
self
的键值对,它们是静态标志,对象构建后不会改变。它们可用于元数据检查或控制对象行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中调用,在构建期间,或通过__init__
直接在构建后调用。当前标签值可以通过
get_tags
或get_tag
检查。- 参数:
- **tag_dictdict
标签名称 : 标签值 对的字典。
- 返回值:
- 返回值
对自身的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 所需状态
要求状态为“已拟合”。
访问 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
附加数据,例如用于转换的标签。某些转换器需要此数据,详情请参阅类 docstring。
- 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
,则返回是具有与X
中实例数量相同行数的pd.DataFrame
。示例:返回的第 i 行包含第 i 个序列的均值和方差如果
X
是Series
并且transform-output
是Panel
,
则返回一个类型为
pd-multiindex
的Panel
对象。示例:输出的第 i 个实例是运行在X
上的第 i 个窗口