BaseEarlyClassifier

class BaseEarlyClassifier

早期时间序列分类器的抽象基类。

基础分类器指定了所有早期分类器必须实现的方法和方法签名。带有下划线后缀的属性在方法fit中设置。

参数:

classes_类标签的ndarray，可能是字符串

n_classes_ : 整数, 类别数量 (classes_ 的长度)整数，类别数量（长度）

fit_time_整数，适应运行的时间（以毫秒为单位）。

_class_dictionary : 将类映射到整数 0…n_classes_-1 的字典。字典映射

_threads_to_use在拟合过程中使用的线程数，由 n_jobs 决定。

state_info包含X中每个决策的状态信息的数组。

属性:

is_fitted

是否已调用 fit。

方法

check_is_fitted()	检查估计器是否已被拟合。
clone()	获取一个具有相同超参数的对象副本。
clone_tags(estimator[, tag_names])	从另一个估计器克隆标签作为动态覆盖。
create_test_instance([parameter_set])	如果可能，构造 Estimator 实例。
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()	获取 self 的配置标志
get_fitted_params([deep])	获取拟合参数。
get_param_defaults()	获取对象的参数默认值。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_state_info()	返回从上一次预测/更新调用生成的状态信息。
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()	重置在更新方法中使用的状态信息。
save([path, serialization_format])	将序列化的自身保存到类字节对象或 (.zip) 文件中。
score(X, y)	在X上将预测标签与真实标签进行比较。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将动态标签设置为给定值。
split_indices(indices, decisions)	根据给定的布尔数组决策拆分索引列表。
split_indices_and_filter(X, indices, decisions)	移除真值情况并根据决策数组拆分索引列表。
update_predict(X)	在更大的序列长度下更新X中序列的标签预测。
update_predict_proba(X)	更新序列 X 在更大系列长度下的标签概率。

fit(X, y)

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

参数:

X3D np.array（任意数量的维度，等长序列）

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array（单变量，等长序列）

形状为 [n_instances, series_length]

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

（任意数量的维度，等长或不等长序列）

或任何其他支持的 Panel mtype

有关mtypes的列表，请参阅datatypes.SCITYPE_REGISTER；有关规范，请参阅examples/AA_datatypes_and_datasets.ipynb

y1D np.array of int, of shape [n_instances] - 用于拟合的类别标签

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

返回:

self自我引用。

注释

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

predict(X) → tuple[numpy.ndarray, numpy.ndarray]

预测X中序列的标签。

早期的分类器可以在序列长度小于训练数据序列长度的情况下进行预测。

对于尚无法做出决策的情况，预测将返回 -1。只有在使用完整系列长度时，输出才保证为所有情况返回有效的类别标签。

参数:

X3D np.array（任意数量的维度，等长序列）

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array（单变量，等长序列）

形状为 [n_instances, series_length]

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

（任意数量的维度，等长或不等长序列）

或任何其他支持的 Panel mtype

有关mtypes的列表，请参阅datatypes.SCITYPE_REGISTER；有关规范，请参阅examples/AA_datatypes_and_datasets.ipynb

返回:

y1D np.array of int, of shape [n_instances] - 预测的类别标签

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

决策一维布尔数组

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

update_predict(X) → tuple[numpy.ndarray, numpy.ndarray]

在更大的序列长度下更新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

有关mtypes的列表，请参阅datatypes.SCITYPE_REGISTER；有关规范，请参阅examples/AA_datatypes_and_datasets.ipynb

返回:

y1D np.array of int, of shape [n_instances] - 预测的类别标签

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

决策一维布尔数组

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

predict_proba(X) → tuple[numpy.ndarray, numpy.ndarray]

预测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

有关mtypes的列表，请参阅datatypes.SCITYPE_REGISTER；有关规范，请参阅examples/AA_datatypes_and_datasets.ipynb

返回:

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

第一维度索引对应于 X 中的实例索引 第二维度索引对应于可能的标签（整数） (i, j)-th 条目是预测概率，即第 i 个实例属于第 j 类的概率

决策一维布尔数组

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

update_predict_proba(X) → tuple[numpy.ndarray, numpy.ndarray]

更新序列 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

有关mtypes的列表，请参阅datatypes.SCITYPE_REGISTER；有关规范，请参阅examples/AA_datatypes_and_datasets.ipynb

返回:

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

第一维度索引对应于 X 中的实例索引 第二维度索引对应于可能的标签（整数） (i, j)-th 条目是预测概率，即第 i 个实例属于第 j 类的概率

决策一维布尔数组

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

score(X, y) → tuple[float, float, float]

在X上将预测标签与真实标签进行比较。

参数:

X3D np.array（任意数量的维度，等长序列）

形状为 [n_instances, n_dimensions, series_length]

或 2D np.array（单变量，等长序列）

形状为 [n_instances, series_length]

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

（任意数量的维度，等长或不等长序列）

或任何其他支持的 Panel mtype

有关mtypes的列表，请参阅datatypes.SCITYPE_REGISTER；有关规范，请参阅examples/AA_datatypes_and_datasets.ipynb

y1D np.ndarray of int, of shape [n_instances] - 类别标签（真实值）

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

返回:

浮点数元组，预测(X)与y的调和平均值、准确率和时效性得分

get_state_info()

返回从上一次预测/更新调用生成的状态信息。

返回:

一个包含X中每个决策的状态信息的数组，来自更新和

预测方法。包含分类器依赖的信息，用于未来的决策

关于案件判决时间的数据和信息。每行

包含最新安全决策案例的信息

更新/预测。连续的更新可能会删除行。

state_info，因为它只会存储与输入实例数量相同的行数。

更新/预测

reset_state_info()

重置在更新方法中使用的状态信息。

static filter_X(X, decisions)

从 X 中移除 True 情况，给定一个布尔决策数组。

static filter_X_y(X, y, decisions)

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

static split_indices(indices, decisions)

根据给定的布尔数组决策拆分索引列表。

static split_indices_and_filter(X, indices, decisions)

移除真值情况并根据决策数组拆分索引列表。

check_is_fitted()

检查估计器是否已被拟合。

引发:

NotFittedError

如果估计器尚未拟合。

clone()

获取一个具有相同超参数的对象副本。

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

引发:

如果克隆不符合规范，由于 __init__ 存在错误，将引发 RuntimeError。

注释

如果成功，值等于 type(self)(**self.get_params(deep=False))。

clone_tags(estimator, tag_names=None)

从另一个估计器克隆标签作为动态覆盖。

参数:

估计器继承自 BaseEstimator 的估计器

标签名称str 或 str 列表, 默认 = None

要克隆的标签名称。如果为 None，则使用估计器中的所有标签作为 tag_names。

返回:

自我

自我引用。

注释

通过在 self 中将 estimator 中的 tag_set 设置为动态标签，来改变对象状态。

classmethod create_test_instance(parameter_set='default')

如果可能，构造 Estimator 实例。

参数:

参数集str, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果没有为某个值定义特殊参数，将返回 “default” 集。

返回:

实例使用默认参数的类实例

注释

get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典，并使用该字典构建对象。

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

参数集str, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果没有为某个值定义特殊参数，将返回 “default” 集。

返回:

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

名称list of str, 与 objs 长度相同

第 i 个元素是测试中第 i 个 obj 实例的名称，约定为 {cls.__name__}-{i}，如果存在多个实例，否则为 {cls.__name__}。

classmethod get_class_tag(tag_name, tag_value_default=None)

获取类标签的值。

不会返回在实例上定义的动态标签（通过 set_tags 或 clone_tags 设置）的信息。

参数:

标签名称str

标签值的名称。

tag_value_default任何

如果未找到标签，则使用默认/回退值。

返回:

标签值

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()

从类及其所有父类中获取类标签。

从 _tags 类属性中检索标签：值对。不返回在实例上通过 set_tags 或 clone_tags 设置的动态标签信息。

返回:

collected_tagsdict

类标签名称字典：标签值对。通过嵌套继承从 _tags 类属性中收集。

get_config()

获取 self 的配置标志

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

状态要求：

需要状态为“已拟合”。

参数:

深度bool, 默认=True

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

• 如果为 True，将返回此对象的参数名称 : 值的字典，包括可拟合组件的拟合参数（= 值为 BaseEstimator 的参数）。

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

返回:

fitted_params带有字符串键的字典

拟合参数的字典，paramname : paramvalue 键值对包括：

• always: 此对象的所有拟合参数，如通过 get_param_names 获取的值是该键对应的拟合参数值，属于此对象

• 如果 deep=True，还包含组件参数的键/值对，组件的参数被索引为 [componentname]__[paramname]，所有 componentname 的参数都以其值作为 paramname 出现。

• 如果 deep=True，还包含任意层级的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

classmethod get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数，值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

排序bool, 默认=True

是否按字母顺序返回参数名称（True），或者按它们在类 __init__ 中出现的顺序返回（False）。

返回:

param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)

获取此对象的参数值字典。

参数:

深度bool, 默认=True

是否返回组件的参数。

• 如果为真，将返回此对象的参数名称 : 值的字典，包括组件的参数（= BaseObject 值的参数）。

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

返回:

参数带有字符串键的字典

参数字典，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)

从估计器类获取标签值并动态覆盖标签。

参数:

标签名称str

要检索的标签名称

tag_value_default任何类型，可选；默认=None

如果未找到标签，则使用默认/回退值

raise_error布尔

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

返回:

标签值任何

self 中 tag_name 标签的值。如果未找到，当 raise_error 为 True 时返回错误，否则返回 tag_value_default。

引发:

如果 raise_error 为 True，即如果 tag_name 不在其中，则引发 ValueError。

self.get_tags().keys()

get_tags()

从估计器类获取标签和动态标签覆盖。

返回:

collected_tagsdict

标签名称 : 标签值对的字典。从 _tags 类属性通过嵌套继承收集，然后是 _tags_dynamic 对象属性的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')

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

参数:

参数集str, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果没有为某个值定义特殊参数，将返回 “default” 集。

返回:

参数字典或字典列表，默认 = {}

创建类的测试实例的参数 每个字典都是用于构造一个“有趣的”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典

is_composite()

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

复合对象是一个包含对象的对象，作为参数。在实例上调用，因为这可能因实例而异。

返回:

composite: bool

一个对象是否具有任何值为 BaseObjects 的参数。

property is_fitted

是否已调用 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

串行ZipFile(path).open(“object”) 的结果

返回:

反序列化自身，结果输出到 path，通过 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

serial : cls.save(None) 输出的第一个元素输出中的第一个元素

返回:

反序列化自身，结果输出为 serial，由 cls.save(None) 产生

reset()

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

使用 reset，使用当前的超参数值（get_params 的结果）运行 __init__。这将移除任何对象属性，除了：

• 超参数 = __init__ 的参数

• 包含双下划线的对象属性，即字符串”__”

类和对象方法，以及类属性也不受影响。

返回:

自身

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

注释

等同于 sklearn.clone 但覆盖 self。在调用 self.reset() 之后，self 的值等于 type(self)(**self.get_params(deep=False))

save(path=None, serialization_format='pickle')

将序列化的自身保存到类字节对象或 (.zip) 文件中。

行为：如果 path 为 None，则返回内存中的序列化自身；如果 path 是一个文件位置，则将自身存储在该位置作为一个 zip 文件。

保存的文件是包含以下内容的zip文件：_metadata - 包含自身的类，即 type(self) _obj - 序列化的自身。此类使用默认的序列化（pickle）。

参数:

路径无或文件位置（字符串或路径）

如果为 None，则将 self 保存到内存对象中；如果为文件位置，则将 self 保存到该文件位置。如果：

path=”estimator” 则在当前工作目录下会生成一个名为 estimator.zip 的压缩文件。path=”/home/stored/estimator” 则会在 /home/stored/ 目录下存储一个名为 estimator.zip 的压缩文件。

serialization_format: str, default = “pickle”

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

返回:

如果 path 为 None - 内存中序列化的 self

如果 path 是文件位置 - 带有文件引用的 ZipFile

set_config(**config_dict)

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

参数:

config_dictdict

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

显示str, “diagram” (默认), 或 “text”

jupyter 内核如何显示实例

• “diagram” = html 盒子图表示

• “text” = 字符串输出

print_changed_onlybool, 默认=True

是否仅打印与默认值不同的自身参数（False），或者打印所有参数名称和值（False）。不嵌套，即仅影响自身，而不影响组件估计器。

警告str, “on” (默认), 或 “off”

是否引发警告，仅影响来自 sktime 的警告

• “on” = 将引发来自 sktime 的警告

• “off” = 不会从 sktime 引发警告

后端:并行str, 可选, 默认=”None”

在广播/矢量化时用于并行化的后端，可以是以下之一

• “None”: 按顺序执行循环，简单的列表推导

• “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

• “joblib”：自定义和第三方 joblib 后端，例如 spark

• “dask”: 使用 dask，需要在环境中安装 dask 包

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

返回:

self对自身的引用。

注释

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)

设置此对象的参数。

该方法适用于简单的估计器以及复合对象。参数键字符串 <component>__<parameter> 可以用于复合对象，即包含其他对象的对象，以访问组件 <component> 中的 <parameter>。如果这使得引用明确，例如没有两个组件的参数名称是 <parameter>，则也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**参数dict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果唯一存在于 get_params 键中，__ 后缀可以别名为完整字符串。

返回:

self引用自身（在参数设置之后）

set_random_state(random_state=None, deep=True, self_policy='copy')

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

通过 estimator.get_params 查找名为 random_state 的参数，并通过 set_params 将其设置为由 random_state 派生的整数。这些整数通过 sample_dependent_seed 的链式哈希采样得到，并保证种子随机生成器的伪随机独立性。

根据 self_policy 应用于 estimator 中的 random_state 参数，并且仅当 deep=True 时应用于剩余的组件估计器。

注意：即使 self 没有 random_state，或者没有任何组件有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 估计器，即使那些没有 random_state 参数的估计器。

参数:

random_stateint, RandomState 实例或 None, 默认=None

伪随机数生成器，用于控制随机整数的生成。传递整数以在多次函数调用中获得可重复的输出。

深度bool, 默认=True

是否在子估计器中设置随机状态。如果为 False，则仅设置 self 的 random_state 参数（如果存在）。如果为 True，则还会在子估计器中设置 random_state 参数。

self_policystr, 可选值为 {“copy”, “keep”, “new”}, 默认值为 “copy”

• “复制” : estimator.random_state 被设置为输入的 random_state

• “保持” : estimator.random_state 保持不变

• “new” : estimator.random_state 被设置为一个新随机状态，

源自输入 random_state，并且通常与它不同。

返回:

self自我引用

set_tags(**tag_dict)

将动态标签设置为给定值。

参数:

**标签字典dict

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

返回:

自我

自我引用。

注释

通过在 tag_dict 中设置标签值，将对象状态更改为 self 中的动态标签。