PandasTransformAdaptor#

class PandasTransformAdaptor(method, kwargs=None, apply_to='call')[source]#

将 pandas 转换器适配到 sktime 接口。

transform 方法中,对数据执行名为 methodpd.DataFrame 方法,可选地通过 kwargs 超参数传递关键字参数。apply_to 参数控制调用 method 时使用的数据:“call” = 仅对 transform 中传入的 X 应用,“all”/”all_subset” = 对迄今为止看到的所有数据应用。详情见下。

对于分层时间序列,操作按实例应用。

参数:
methodstr,可选,默认为 None = 恒等转换

在 transform 中应用的 DataFrame 方法的名称

kwargsdict,可选,默认为空字典(不向方法传递 kwargs)

传递给 DataFrame.method 的参数

apply_tostr,可选,取值为 “call”, “all”, “all_subset” 之一,默认为 “call”

“call” = 方法仅应用于 transform 中传入的 X。“all” = 方法应用于 fit, update, transform 中看到的所有 X

更精确地说,返回应用于 self._X 的结果

“all_subset” = 方法应用于所有 X (如 “all” 值所述),

但在返回之前,结果会根据 transform 中 X 的索引进行子集化

在 “all”, “all_subset” 模式下,transform 中传入的 X 不会更新 self._X

属性:
is_fitted

是否已调用 fit 方法。

示例

>>> from sktime.transformations.series.adapt import PandasTransformAdaptor
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = PandasTransformAdaptor("diff")
>>> y_hat = transformer.fit_transform(y)
>>> transformer = PandasTransformAdaptor("diff", apply_to="all_subset")
>>> y_hat = transformer.fit(y.iloc[:12])
>>> y_hat = transformer.transform(y.iloc[12:])

方法

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_class_tags()

从类中获取类标签,包含来自父类的标签继承。

get_config()

获取对象的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的默认参数。

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 进行逆转换并返回逆转换后的版本。

is_composite()

检查对象是否由其他 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 属性是否存在且为 Trueis_fitted 属性应在调用对象的 fit 方法时设置为 True

如果未拟合,则引发 NotFittedError

参数:
method_namestr,可选

调用此方法的函数名称。如果提供,错误消息将包含此信息。

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回 sklearn.cloneself

等同于使用 self 的参数构造一个新的 type(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__ 方法中调用。

动态标签设置为 estimator 中指定名称 tag_names 的标签值。

tag_names 的默认值是将 estimator 的所有标签写入 self

当前标签值可通过 get_tagsget_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 个元素是测试中第 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") 指定的类型。

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一种抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list of Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认为 None

附加数据,例如用于转换的标签。如果 self.get_tag("requires_y")True,则必须在 fit 中传递,非可选。有关所需格式,请参阅类文档字符串。

返回:
self估计器的已拟合实例
fit_transform(X, y=None)[source]#

拟合数据,然后进行转换。

将转换器拟合到 X 和 y,并返回 X 的转换版本。

状态变更

状态变为“已拟合”。

写入 self: _is_fitted : 标志设为 True。_X : X,X 的强制转换副本(如果 remember_data 标签为 True)

如果可能,可能通过引用强制转换为内部类型或 update_data 兼容类型

模型属性(以 “_” 结尾):取决于估计器

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据,以及要转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一种抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list of Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认为 None

附加数据,例如用于转换的标签。如果 self.get_tag("requires_y")True,则必须在 fit 中传递,非可选。有关所需格式,请参阅类文档字符串。

返回:
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 中的实例
表中未列出的组合当前不受支持
具体说明,含示例
  • 如果 XSeries (例如,pd.DataFrame)

并且 transform-outputSeries,则返回是相同 mtype 的单个 Series。示例:对单个序列进行去趋势

  • 如果 XPanel (例如,pd-multiindex) 并且 transform-output

Series,则返回是与 X 具有相同实例数的 Panel(转换器应用于每个输入的 Series 实例)。示例:面板中的所有序列都被单独去趋势

  • 如果 XSeriesPanel 并且 transform-output

Primitives,则返回是 pd.DataFrame,其行数与 X 中的实例数相同。示例:返回的第 i 行包含第 i 个序列的均值和方差

  • 如果 XSeries 并且 transform-outputPanel

则返回类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是 X 上运行的第 i 个窗口

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值,包含来自父类的标签继承。

每个兼容 scikit-base 的对象都有一个标签字典,用于存储对象的元数据。

get_class_tag 方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。

它从对象中返回名为 tag_name 的标签值,按以下降序优先级考虑标签覆盖

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序排列。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

要检索具有潜在实例覆盖的标签值,请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果找不到标签,则为默认/回退值。

返回:
tag_value

selftag_name 标签的值。如果找不到,返回 tag_value_default

classmethod get_class_tags()[source]#

从类中获取类标签,包含来自父类的标签继承。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对,它们是静态标志,在对象构造后不会改变。

get_class_tags 方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。

它返回一个字典,其键是类或其任何父类中设置的 _tags 的任何属性的键。

值是相应的标签值,按以下降序优先级考虑覆盖

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序排列。

实例可以根据超参数覆盖这些标签。

要检索具有潜在实例覆盖的标签,请改用 get_tags 方法。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

对于包含动态标签的覆盖,请使用 get_tags

collected_tagsdict

标签名 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不受通过 set_tagsclone_tags 设置的动态标签覆盖。

get_config()[source]#

获取对象的配置标志。

Configs 是 self 的键值对,通常用作控制行为的瞬态标志。

get_config 返回动态配置,这些配置会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置,并被通过 set_config 设置的动态配置覆盖。

Configs 在 clonereset 调用后保留。

返回:
config_dictdict

配置名 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool,默认为 True

是否返回组件的已拟合参数。

  • 如果为 True,将返回此对象的参数名 : 值字典,包括可拟合组件(= BaseEstimator 值的参数)的已拟合参数。

  • 如果为 False,将返回此对象的参数名 : 值字典,但不包括组件的已拟合参数。

返回:
fitted_params键为 str 的 dict

已拟合参数字典,paramname : paramvalue 键值对包括

  • 始终:此对象的所有已拟合参数,如通过 get_param_names 获取;值是该键对应的已拟合参数值,属于此对象

  • 如果 deep=True,还包含组件参数的键/值对;组件参数以 [组件名]__[参数名] 索引;组件名 的所有参数以 参数名 形式出现,附带其值

  • 如果 deep=True,还包含任意级别的组件递归,例如 [组件名]__[组件组件名]__[参数名]

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

参数字典,paramname : paramvalue 键值对包括

  • 始终:此对象的所有参数,如通过 get_param_names 获取;值是该键对应的参数值,属于此对象;值始终与构造时传递的值相同

  • 如果 deep=True,还包含组件参数的键/值对;组件参数以 [组件名]__[参数名] 索引;组件名 的所有参数以 参数名 形式出现,附带其值

  • 如果 deep=True,还包含任意级别的组件递归,例如 [组件名]__[组件组件名]__[参数名]

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值,包含标签级别的继承和覆盖。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对,它们是静态标志,在对象构造后不会改变。

get_tag 方法从实例中检索名为 tag_name 的单个标签的值,按以下降序优先级考虑标签覆盖

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时设置。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型,可选;默认为 None

如果找不到标签,则为默认/回退值

raise_errorbool

当找不到标签时是否引发 ValueError

返回:
tag_valueAny

selftag_name 标签的值。如果找不到,且 raise_error 为 True,则引发错误,否则返回 tag_value_default

引发:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则引发 ValueError

get_tags()[source]#

从实例获取标签,包含标签级别的继承和覆盖。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对,它们是静态标志,在对象构造后不会改变。

get_tags 方法返回一个标签字典,其键是类或其任何父类中设置的 _tags 的任何属性的键,或者通过 set_tagsclone_tags 设置的标签。

值是相应的标签值,按以下降序优先级考虑覆盖

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时设置。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _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

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一种抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list of Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认为 None

附加数据,例如用于转换的标签。某些转换器需要此参数,详情请参阅类文档字符串。

返回:
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]#

从序列化内存容器加载对象。

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的对象,结果输出 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,则将对象保存到内存中的对象;如果是文件位置,则将对象保存到该文件位置。如果

  • path=”estimator”,则在当前工作目录创建 zip 文件 estimator.zip

  • path=”/home/stored/estimator”,则 zip 文件 estimator.zip 将保存到

/home/stored/ 中。

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”:布尔值,默认为True;设置为False可以阻止 ray 在并行化后

      关闭。

    • “logger_name”:字符串,默认为”ray”;要使用的日志记录器的名称。

    • “mute_warnings”:布尔值,默认为False;如果为True,则抑制警告

input_conversion字符串,以下之一:“on”(默认)、“off”或有效的mtype字符串

控制 _fit_transform_inverse_transform_update 的输入检查和转换

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前,不执行输入检查和转换

  • 有效的mtype字符串 - 假定输入为指定的mtype,执行转换但不执行检查

output_conversion字符串,以下之一:“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>。如果引用明确(例如,没有两个组件的参数名为 <parameter>),也可以使用字符串 <parameter> 而不带 <component>__

参数:
**params字典

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_state整数、RandomState实例或None,默认为None

伪随机数生成器,用于控制随机整数的生成。传入整数可在多次函数调用中获得可复现的输出。

deepbool,默认为 True

是否在skbase对象值参数(即组件估计器)中设置随机状态。

  • 如果为False,则只设置 selfrandom_state 参数(如果存在)。

  • 如果为True,则同时设置组件对象中的 random_state 参数。

self_policy字符串,以下之一:{“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_tagsget_tag 进行检查。

参数:
**tag_dict字典

标签名: 标签值对的字典。

返回:
Self

指向self的引用。

transform(X, y=None)[source]#

转换 X 并返回转换后的版本。

所需状态

要求状态为“已拟合”。

访问 self 中的内容

  • 以 “_” 结尾的已拟合模型属性。

  • self.is_fitted,必须为 True

参数:
Xsktime 兼容数据容器格式的时间序列

要转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一种抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list of Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认为 None

附加数据,例如用于转换的标签。某些转换器需要此参数,详情请参阅类文档字符串。

返回:
X 的转换版本
类型取决于 X 的类型和 scitype:transform-output 标签

transform

X

-output

返回类型

Series

Primitives

pd.DataFrame (1行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel

返回中的实例对应于 X 中的实例
表中未列出的组合当前不受支持
具体说明,含示例
  • 如果 XSeries (例如,pd.DataFrame)

并且 transform-outputSeries,则返回是相同 mtype 的单个 Series。示例:对单个序列进行去趋势

  • 如果 XPanel (例如,pd-multiindex) 并且 transform-output

Series,则返回是与 X 具有相同实例数的 Panel(转换器应用于每个输入的 Series 实例)。示例:面板中的所有序列都被单独去趋势

  • 如果 XSeriesPanel 并且 transform-output

Primitives,则返回是 pd.DataFrame,其行数与 X 中的实例数相同。示例:返回的第 i 行包含第 i 个序列的均值和方差

  • 如果 XSeries 并且 transform-outputPanel

则返回类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是 X 上运行的第 i 个窗口

update(X, y=None, update_params=True)[source]#

用 X 更新转换器,可选地用 y。

所需状态

要求状态为“已拟合”。

访问 self 中的内容

  • 以 “_” 结尾的已拟合模型属性。

  • self.is_fitted,必须为 True

写入 self

  • 以 “_” 结尾的已拟合模型属性。

  • 如果 remember_data 标签为 True,则通过 update_dataX 中的值更新到 self._X 中。

参数:
Xsktime 兼容数据容器格式的时间序列

用于更新转换的数据

sktime 中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一种抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list of Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认为 None

附加数据,例如用于转换的标签。某些转换器需要此参数,详情请参阅类文档字符串。

返回:
self估计器的已拟合实例