TimeBinAggregate#
- class TimeBinAggregate(bins, aggfunc=None, return_index='bin_start')[source]#
对时间序列进行分箱并按箱进行聚合。
在
transform
中,在时间坐标上应用带有aggfunc
的groupby
操作。更准确地说:
bins
编码了箱 \(B_1, \dots, B_k\),其中 \(B_i\) 是区间,在实数或时间(时间戳)范围内。在
transform
中,估算器TimeBinAggregate
收集X
中落入 \(B_i\) 区间的时间戳上的值作为样本 \(S_i\),然后将aggfunc
应用于 \(S_i\) 以获得聚合值 \(v_i\)。转换后的序列是时间戳 \(t_i\) 上的值 \(v_i\),根据return_index
中的规则由 \(B_i\) 确定。- 参数:
- bins一维数组类型或 pd.IntervalIndex
如果是一维数组类型,则解释为箱的边界,这些边界定义了由 aggfunc 考虑的区间
- aggfunc可调用对象 (*一维数组类型 -> float), 可选, 默认=np.mean
用于聚合区间值的函数。签名应为 一维 -> float,如果为 None 则默认为 mean
- return_indexstr, 以下之一; 可选, 默认=”range”
“range” = 带有按
bins
中相同顺序索引的箱的 RangeIndex “bin_start” = 转换后的 pd.DataFrame 将按箱的起始索引 “bin_end” = 转换后的 pd.DataFrame 将按箱的末尾索引 “bin_mid” = 转换后的 pd.DataFrame 将按箱的中点索引 “bin” = 转换后的 pd.DataFrame 将具有bins
作为IntervalIndex
- 属性:
is_fitted
是否已调用
fit
。
示例
from sktime.datatypes import get_examples from sktime.transformations.series.binning import TimeBinAggregate
bins = [0, 2, 4] X = get_examples(“pd.DataFrame”)[0]
t = TimeBinAggregate([-1, 2, 10])
方法
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。
- check_is_fitted(method_name=None)[source]#
检查估算器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,is_fitted
属性应设置为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 或 list of 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])
- nameslist of str, 长度与 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
中传递,不是可选的。有关所需格式,请参阅类文档字符串了解详细信息。
- X符合
- 返回:
- self估算器的已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后进行转换。
将转换器拟合到 X 和 y,并返回转换后的 X 版本。
- 状态变更
将状态更改为“已拟合”。
写入 self:_is_fitted:标志设置为 True。_X: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 | type of return |
|----------|————–|------------------------| | 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
,则返回是具有与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
的键值对,通常用作控制行为的瞬时标志。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 类型的 dict
拟合参数字典,参数名称:参数值 的键值对包括
总是:此对象的所有拟合参数,通过 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 类型的 dict
参数字典,参数名称:参数值 的键值对包括
总是:此对象的所有参数,通过
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
额外数据,例如用于转换的标签。一些转换器需要此项,详见类文档字符串。
- 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) 的结果
- 返回:
- 反序列化自身,结果是
cls.save(path)
在path
的输出
- 反序列化自身,结果是
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第1个元素
- serial
- 返回:
- 反序列化自身,结果是
cls.save(None)
输出的serial
- 反序列化自身,结果是
- reset()[source]#
将对象重置为初始化后的干净状态。
将
self
设置为构造函数调用后直接的状态,具有相同的超参数。通过set_config
设置的配置值也会保留。调用
reset
会删除任何对象属性,除了超参数 =
__init__
的参数,写入到self
,例如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,则将自身保存到内存对象;如果是文件位置,则将自身保存到该文件位置。如果
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
控制。如果未传递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>
,也可以使用不带<component>__
的字符串<parameter>
,只要这使得引用明确。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果__
后缀在 get_params 键中是唯一的,则可以作为完整字符串的别名。
- 返回:
- 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 对象值参数(即组件估计器)中的随机状态。
如果为 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自身引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
每个与
scikit-base
兼容的对象都有一个标签字典,用于存储有关对象的元数据。Tag 是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。它们可用于元数据检查或控制对象的行为。set_tags
将动态 tag 覆盖设置为tag_dict
中指定的值,其中键是 tag 名称,字典值是要将 tag 设置为的值。set_tags
方法应仅在对象构造期间或通过__init__
构造后直接在对象的__init__
方法中调用。当前的标签值可以通过
get_tags
或get_tag
查看。- 参数:
- **tag_dictdict
tag 名称: tag 值 对的字典。
- 返回:
- 自身
对自身的引用。
- 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
额外数据,例如用于转换的标签。一些转换器需要此项,详见类文档字符串。
- 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 个窗口
- update(X, y=None, update_params=True)[source]#
使用 X 更新转换器,可选地使用 y。
- 所需状态
要求状态为“已拟合”。
在 self 中访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
写入 self
以“_”结尾的拟合模型属性。
如果
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估算器的已拟合实例
- classmethod get_test_params(parameter_set='default')[source]#
返回估算器的测试参数设置。
- 参数:
- parameter_setstr, 默认=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回
"default"
集。目前转换器没有保留值。
- 返回:
- paramsdict 或 dict 列表, 默认 = {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。