BaseEarlyClassifier#

class BaseEarlyClassifier[source]#

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

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

参数:
classes_类标签的 ndarray,可能是字符串
n_classes_整数,类的数量(classes_ 的长度)
fit_time_整数,fit 运行所需时间(毫秒)。
_class_dictionaryclasses_ 映射到整数 0…n_classes_-1 的字典。
_threads_to_use由 n_jobs 确定的 fit 中使用的线程数。
state_info一个数组,包含 X 中每个决策的状态信息。
属性:
is_fitted

fit 是否已被调用。

方法

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

获取 self 的配置标志。

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

返回 skbase 对象的测试参数设置。

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

将序列化的 self 保存到类字节对象或到 (.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)

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

update_predict(X)

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

update_predict_proba(X)

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

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

y形状为 [n_instances] 的 1D np.array (int 类型) - 用于拟合的类别标签

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

返回:
selfself 的引用。

注意

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

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

返回:
y形状为 [n_instances] 的 1D np.array (int 类型) - 预测的类别标签

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

decisions1D 布尔数组

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

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

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

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

如果不存在状态信息,将转而调用 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

返回:
y形状为 [n_instances] 的 1D np.array (int 类型) - 预测的类别标签

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

decisions1D 布尔数组

一个布尔数组,包含预测是否安全可用的决策。第 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] 的 2D 数组 - 预测的类别概率

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

decisions1D 布尔数组

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

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

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

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

如果不存在状态信息,将转而调用 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] 的 2D 数组 - 预测的类别概率

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

decisions1D 布尔数组

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

score(X, y) 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] 的 1D np.ndarray (int 类型) - 类别标签(真实值)

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

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

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

返回:
一个数组,包含 X 中每个决策的状态信息,这些信息来自 update 和
predict 方法。包含用于未来决策的依赖于分类器的信息
数据,以及关于何时做出案例决策的信息。每行
包含上次 update/predict 中关于其安全性的决策产生的案例信息。连续的
update 可能会从
state_info 中移除行,因为它只会存储与
update/predict 输入实例数量一样多的行。
reset_state_info()[source]#

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

static filter_X(X, decisions)[source]#

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

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

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

static split_indices(indices, decisions)[source]#

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

static split_indices_and_filter(X, indices, decisions)[source]#

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

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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

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 的配置标志。

配置是 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 类型的字典

已拟合参数字典,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_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 对象属性收集任何覆盖和新标签。

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

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于 create_test_instancecreate_test_instances_and_names 来构造测试实例。

get_test_params 应该返回一个单独的 dict,或者一个 dictlist

每个 dict 都是用于测试的参数配置,可用于构造一个“有趣”的测试实例。对于 get_test_params 返回值中的所有字典 params,调用 cls(**params) 都应该是有效的。

get_test_params 不需要返回固定列表的字典,它也可以返回动态或随机的参数设置。

参数:
parameter_setstr,默认=”default”

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

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

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

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”) 的结果
返回:
反序列化后的 self,其输出位于 path,是 cls.save(path) 的结果
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化后的 self,其输出为 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]#

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

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

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

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

如果为 None,self 会保存到内存对象中。如果为文件位置,self 会保存到该文件位置。If

  • path=”estimator” 则会在当前工作目录 (cwd) 创建一个名为 estimator.zip 的 zip 文件。

  • path=”/home/stored/estimator” 则会将名为 estimator.zip 的 zip 文件

存储在 /home/stored/ 中。

serialization_format: str,默认值 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr,“diagram”(默认)或“text”

jupyter 内核如何显示 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”;要使用的日志记录器名称。

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

为 self 设置 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 的引用。