TEASER#

class TEASER(estimator=None, one_class_classifier=None, one_class_param_grid=None, classification_points=None, n_jobs=1, random_state=None)[source]#

两阶段早期准确时间序列分类器 (TEASER)。

一种早期分类器,它使用基于预测概率训练的单类 SVM 来确定早期预测是否安全。

概述

构建 n 个分类器,其中 n 是 classification_points 的数量。对于每个分类器,训练一个单类 SVM,用于确定在该序列长度下的预测安全性。调整需要多少个连续的安全 SVM 预测才认为预测安全。

当预测仍被认为不安全时

使用分类点 i 的序列长度进行预测。使用 decide_prediction_safety 决定预测是否安全。

参数:
estimator: sktime 分类器,默认值=None

将在每个 classification_points 时间戳构建的 sktime 评估器。默认使用 WEASEL 分类器。

one_class_classifier: 单类 sklearn 分类器,默认值=None

用于确定早期决策是否安全的 sklearn 单类分类器。默认使用经过调优的单类 SVM 分类器。

one_class_param_grid: dict 或 dict 列表,默认值=None

用于单类分类器通过网格搜索学习的超参数。字典,键为参数名称 (str),值为要尝试的参数设置列表,或此类字典的列表。

classification_points列表或 None,默认值=None

整数时间序列时间戳列表,用于构建分类器并允许在这些时间戳进行预测。早期预测的序列长度必须与 _classification_points 列表中的值匹配。重复值将被移除,如果不存在,将添加完整的序列长度。如果为 None,将使用从 0 到序列长度线性间隔的 20 个阈值。

n_jobsint,默认值=1

并行运行 fitpredict 的作业数量。-1 表示使用所有处理器。

random_stateint 或 None,默认值=None

随机数生成的种子。

属性:
n_classes_int

类别数量。

n_instances_int

训练样本数量。

n_dims_int

每个样本的维度数量。

series_length_int

每个序列的完整长度。

classes_list

唯一的类别标签。

state_info2d np.ndarray(4 列)

在 update/predict 方法中进行决策后存储的关于输入样本的信息。在 update 方法中用于根据先前方法调用的结果做出决策。按顺序记录:时间戳索引、连续决策次数、预测类别和序列长度。

参考文献

[1]

Schäfer, Patrick, and Ulf Leser. “TEASER: early and accurate time series classification.” Data mining and knowledge discovery 34, no. 5 (2020)

示例

>>> from sktime.classification.early_classification import TEASER
>>> from sktime.classification.interval_based import TimeSeriesForestClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True) 
>>> clf = TEASER(
...     classification_points=[6, 16, 24],
...     estimator=TimeSeriesForestClassifier(n_estimators=5),
... ) 
>>> clf.fit(X_train, y_train) 
TEASER(...)
>>> y_pred, decisions = clf.predict(X_test) 

方法

check_is_fitted([method_name])

检查评估器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([parameter_set])

使用第一个测试参数集构造类的实例。

create_test_instances_and_names([parameter_set])

创建所有测试实例及其名称的列表。

filter_X(X, decisions)

根据布尔型决策数组从 X 中移除 True 的情况。

filter_X_y(X, y, decisions)

根据布尔型决策数组从 X 和 y 中移除 True 的情况。

fit(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_state_info()

返回上次 predict/update 调用生成的状态信息。

get_tag(tag_name[, tag_value_default, ...])

从实例中获取标签值,并考虑标签级别继承和覆盖。

get_tags()

从实例中获取标签,并考虑标签级别继承和覆盖。

get_test_params([parameter_set])

返回评估器的测试参数设置。

is_composite()

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

predict_proba(X)

预测 X 中序列的标签概率。

reset()

将对象重置到干净的初始化后状态。

reset_state_info()

重置 update 方法中使用的状态信息。

save([path, serialization_format])

将序列化的对象保存到 bytes-like 对象或 (.zip) 文件。

score(X, y)

根据 X 中的真实标签评估预测标签的得分。

set_config(**config_dict)

将配置标志设置为给定值。

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为对象设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

将实例级别的标签覆盖设置为给定值。

split_indices(indices, decisions)

根据布尔型决策数组分割索引列表。

split_indices_and_filter(X, indices, decisions)

根据决策数组移除 True 的情况并分割索引列表。

update_predict(X)

在更大的序列长度上更新 X 中序列的标签预测。

update_predict_proba(X)

在更大的序列长度上更新 X 中序列的标签概率。

classmethod get_test_params(parameter_set='default')[source]#

返回评估器的测试参数设置。

参数:
parameter_setstr,默认值=”default”

要返回的测试参数集的名称,用于测试中。如果未为某个值定义特殊参数,将返回 "default" 集。

返回:
paramsdict 或 dict 列表,默认值 = {}

用于创建类的测试实例的参数。

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

检查 _is_fitted 属性是否存在且为 Trueis_fitted 属性应在对象的 fit 方法调用中设置为 True

如果不是,则引发 NotFittedError

参数:
method_namestr,可选

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

引发:
NotFittedError

如果评估器尚未拟合。

clone()[source]#

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

克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等效于返回 selfsklearn.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_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 个 obj 实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

static filter_X(X, decisions)[source]#

根据布尔型决策数组从 X 中移除 True 的情况。

static filter_X_y(X, y, decisions)[source]#

根据布尔型决策数组从 X 和 y 中移除 True 的情况。

fit(X, y)[source]#

将时间序列分类器拟合到训练数据。

参数:
X3D np.array(任意维度,等长序列)

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array(单变量,等长序列)

形状为 [n_instances, series_length]

或 pd.DataFrame,其中每列是一个维度,每个单元格是一个 pd.Series

(任意维度,等长或不等长序列)

或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER,规范请参见 examples/AA_datatypes_and_datasets.ipynb

y1D np.array (int), 形状为 [n_instances] - 用于拟合的类别标签

索引对应于 X 中的实例索引

返回:
self指向 self 的引用。

注意

通过创建拟合模型更改状态,该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。

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]#

获取对象的配置标志。

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

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

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

配置在 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,也包含组件参数的键/值对,组件参数的索引为 [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

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

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

  • 如果 deep=True,也包含组件参数的键/值对,组件参数的索引为 [componentname]__[paramname]componentname 的所有参数都显示为 paramname 及其值

  • 如果 deep=True,也包含任意级别的组件递归,例如 [componentname]__[componentcomponentname]__[paramname]

get_state_info()[source]#

返回上次 predict/update 调用生成的状态信息。

返回:
一个数组,包含 update 和 predict 方法中 X 中每个决策的状态信息。包含分类器相关的未来数据决策信息以及案例决策何时做出。每行包含 update/predict 中对其安全性做出最新决策的案例信息。连续更新可能会从 state_info 中移除行,因为它只会存储与输入到 update/predict 的实例数量相同的行。
predict methods. Contains classifier dependent information for future decisions
on the data and information on when a cases decision has been made. Each row
contains information for a case from the latest decision on its safety made in
update/predict. Successive updates are likely to remove rows from the
state_info, as it will only store as many rows as there are input instances to
update/predict.
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 对象属性的任何覆盖和新标签。

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)
predict(X) tuple[ndarray, ndarray][source]#

预测 X 中序列的标签。

早期分类器可以在短于训练数据序列长度的序列长度上进行预测。

对于尚无法做出决策的案例,predict 将返回 -1。只有在使用完整序列长度时,输出才保证对所有案例返回有效的类别标签。

参数:
X3D np.array(任意维度,等长序列)

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array(单变量,等长序列)

形状为 [n_instances, series_length]

或 pd.DataFrame,其中每列是一个维度,每个单元格是一个 pd.Series

(任意维度,等长或不等长序列)

或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER,规范请参见 examples/AA_datatypes_and_datasets.ipynb

返回:
y1D np.array (int), 形状为 [n_instances] - 预测类别标签

索引对应于 X 中的实例索引

decisions1D bool 数组

一个布尔值数组,包含预测是否可以安全使用的决策。第 i 个条目是分类器关于第 i 个实例是否安全可用的决策

predict_proba(X) tuple[ndarray, ndarray][source]#

预测 X 中序列的标签概率。

早期分类器可以在短于训练数据序列长度的序列长度上进行预测。

概率预测将对尚未能做出决策的情况返回 [-1]*n_classes_。仅在使用完整序列长度时,输出才能保证为所有情况返回有效的类别标签。

参数:
X3D np.array(任意维度,等长序列)

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array(单变量,等长序列)

形状为 [n_instances, series_length]

或 pd.DataFrame,其中每列是一个维度,每个单元格是一个 pd.Series

(任意维度,等长或不等长序列)

或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER,规范请参见 examples/AA_datatypes_and_datasets.ipynb

返回:
y形状为 [n_instances, n_classes] 的二维数组 - 预测的类别概率

第一维索引对应于 X 中的实例索引;第二维索引对应于可能的标签(整数);(i, j) 条目表示第 i 个实例属于第 j 个类别的预测概率。

decisions1D bool 数组

一个布尔值数组,包含预测是否可以安全使用的决策。第 i 个条目是分类器关于第 i 个实例是否安全可用的决策

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

类实例被重置到干净的初始化后状态,但保留当前的超参数值。

reset_state_info()[source]#

重置 update 方法中使用的状态信息。

save(path=None, serialization_format='pickle')[source]#

将序列化的对象保存到 bytes-like 对象或 (.zip) 文件。

行为:如果 path 为 None,则返回一个内存中的序列化 self;如果 path 是文件位置,则将 self 作为 zip 文件存储在该位置。

保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化的 self。此类使用默认的序列化方式 (pickle)。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None,self 将保存到内存对象中;如果是文件位置,self 将保存到该文件位置。如果

  • path=”estimator”,则会在当前工作目录 (cwd) 生成一个 estimator.zip 文件。

  • path=”/home/stored/estimator”,则会在 /home/stored/

存储一个 estimator.zip 文件。

serialization_format: str 类型,默认值为 “pickle”

用于序列化的模块。可用选项为 "pickle" 和 "cloudpickle"。请注意,非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile 对象
score(X, y) tuple[float, float, float][source]#

根据 X 中的真实标签评估预测标签的得分。

参数:
X3D np.array(任意维度,等长序列)

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array(单变量,等长序列)

形状为 [n_instances, series_length]

或 pd.DataFrame,其中每列是一个维度,每个单元格是一个 pd.Series

(任意维度,等长或不等长序列)

或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER,规范请参见 examples/AA_datatypes_and_datasets.ipynb

y形状为 [n_instances] 的一维 int 类型 np.ndarray 数组 - 类别标签(真实值)

索引对应于 X 中的实例索引

返回:
浮点数元组,predict(X) 与 y 相比的调和平均数、准确率和早期性得分。
set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:
config_dictdict

配置名称:配置值对的字典。有效的配置、值及其含义如下所示

displaystr 类型,"diagram"(默认)或 "text"

jupyter kernel 如何显示 self 的实例

  • "diagram" = html 框图表示

  • "text" = 字符串打印输出

print_changed_onlybool 类型,默认值为 True

打印 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 在并行化后

      关闭。

    • "logger_name":str 类型,默认值为 "ray";要使用的 logger 名称。

    • "mute_warnings":bool 类型,默认值为 False;如果为 True,则抑制警告

返回:
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 对象值参数(即组件估计器)中的随机状态。

  • 如果为 False,则仅设置 selfrandom_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_tagsget_tag 检查当前标签值。

参数:
**tag_dictdict

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

返回:
Self对 self 的引用。

自指

静态 split_indices(indices, decisions)[source]#

根据布尔型决策数组分割索引列表。

静态 split_indices_and_filter(X, indices, decisions)[source]#

根据决策数组移除 True 的情况并分割索引列表。

update_predict(X) tuple[ndarray, ndarray][source]#

在更大的序列长度上更新 X 中序列的标签预测。

使用分类器状态中存储的来自先前预测的信息,并在较短的序列长度处进行更新。更新将仅接受尚未做出决策的情况,已做出肯定决策的情况应从输入中移除并保留行顺序。

如果没有状态信息,将改为调用 predict。

预测更新将对尚未能做出决策的情况返回 -1。仅在使用完整序列长度时,输出才能保证为所有情况返回有效的类别标签。

参数:
X3D np.array(任意维度,等长序列)

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array(单变量,等长序列)

形状为 [n_instances, series_length]

或 pd.DataFrame,其中每列是一个维度,每个单元格是一个 pd.Series

(任意维度,等长或不等长序列)

或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER,规范请参见 examples/AA_datatypes_and_datasets.ipynb

返回:
y1D np.array (int), 形状为 [n_instances] - 预测类别标签

索引对应于 X 中的实例索引

decisions1D bool 数组

一个布尔值数组,包含预测是否可以安全使用的决策。第 i 个条目是分类器关于第 i 个实例是否安全可用的决策

update_predict_proba(X) tuple[ndarray, ndarray][source]#

在更大的序列长度上更新 X 中序列的标签概率。

使用分类器状态中存储的来自先前预测的信息,并在较短的序列长度处进行更新。更新将仅接受尚未做出决策的情况,已做出肯定决策的情况应从输入中移除并保留行顺序。

如果没有状态信息,将改为调用 predict_proba。

概率预测更新将对尚未能做出决策的情况返回 [-1]*n_classes_。仅在使用完整序列长度时,输出才能保证为所有情况返回有效的类别标签。

参数:
X3D np.array(任意维度,等长序列)

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array(单变量,等长序列)

形状为 [n_instances, series_length]

或 pd.DataFrame,其中每列是一个维度,每个单元格是一个 pd.Series

(任意维度,等长或不等长序列)

或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER,规范请参见 examples/AA_datatypes_and_datasets.ipynb

返回:
y形状为 [n_instances, n_classes] 的二维数组 - 预测的类别概率

第一维索引对应于 X 中的实例索引;第二维索引对应于可能的标签(整数);(i, j) 条目表示第 i 个实例属于第 j 个类别的预测概率。

decisions1D bool 数组

一个布尔值数组,包含预测是否可以安全使用的决策。第 i 个条目是分类器关于第 i 个实例是否安全可用的决策