ColumnEnsembleClassifier#

class ColumnEnsembleClassifier(estimators, remainder='drop', verbose=False)[源代码]#

将估计器应用于数组或 pandas DataFrame 的列。

此估计器允许分别转换输入的 Kassel 列或列子集,并且由每个转换器生成的特征将被集成为单个输出。

参数:
estimators元组列表

指定应用于数据子集的转换器对象的 (名称, 估计器, 列) 元组列表。

名称字符串

类似于 Pipeline 和 FeatureUnion,这允许使用 set_params 设置转换器及其参数,并在网格搜索中搜索。

估计器或 {‘drop’}

估计器必须支持 fitpredict_proba。也接受特殊处理的字符串 ‘drop’ 和 ‘passthrough’,用于指示删除列。

列: 字符串或整数的类数组、切片、布尔掩码数组或可调用对象。

remainder{‘drop’, ‘passthrough’} 或 估计器, 默认为 ‘drop’

默认情况下,只有 transformations 中指定的列会被转换并组合到输出中,未指定的列会被丢弃(默认为 'drop')。通过指定 remainder='passthrough',所有未在 transformations 中指定的剩余列将自动通过。这些列的子集将与转换的输出连接。通过将 remainder 设置为估计器,剩余的未指定列将使用 remainder 估计器。该估计器必须支持 fittransform

属性:
is_fitted

是否已调用 fit

示例

>>> from sktime.classification.dictionary_based import ContractableBOSS
>>> from sktime.classification.interval_based import CanonicalIntervalForest
>>> from sktime.datasets import load_basic_motions
>>> X_train, y_train = load_basic_motions(split="train") 
>>> X_test, y_test = load_basic_motions(split="test") 
>>> cboss = ContractableBOSS(
...     n_parameter_samples=4, max_ensemble_size=2, random_state=0
... ) 
>>> cif = CanonicalIntervalForest(
...     n_estimators=2, n_intervals=4, att_subsample_size=4, random_state=0
... ) 
>>> estimators = [("cBOSS", cboss, 5), ("CIF", cif, [3, 4])] 
>>> col_ens = ColumnEnsembleClassifier(estimators=estimators) 
>>> col_ens.fit(X_train, y_train) 
ColumnEnsembleClassifier(...)
>>> y_pred = col_ens.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])

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

fit(X, y)

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

fit_predict(X, y[, cv, change_state])

对 X 中的序列进行拟合并预测标签。

fit_predict_proba(X, y[, cv, change_state])

对 X 中的序列进行拟合并预测标签概率。

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

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

is_composite()

检查对象是否为组合对象。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

predict_proba(X)

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

reset()

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

save([path, serialization_format])

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

score(X, y)

根据 X 上的真实标签对预测标签进行评分。

set_config(**config_dict)

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

set_params(**kwargs)

设置估计器的参数。

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

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

set_tags(**tag_dict)

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

classmethod get_test_params(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, 默认为 “default”

要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 "default" 集。对于分类器,应提供一组“default”参数用于一般测试,如果一般参数集无法产生适合比较的概率,则应提供一组“results_comparison”参数用于与先前记录的结果进行比较。

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

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

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时,is_fitted 属性应设置为 True

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

克隆是没有共享引用,处于后初始化状态的不同对象。此函数相当于返回 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)[源代码]#

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

每个 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')[源代码]#

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

参数:
parameter_setstr, 默认为 “default”

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

返回:
instance带有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, 默认为 “default”

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

返回:
objscls 实例列表

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

namesstr 列表,长度与 objs 相同

第 i 个元素是测试中 objs 的第 i 个实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

fit(X, y)[源代码]#

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

状态变化

将状态更改为“已拟合”。

写入自身

将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

用于拟合估计器的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex: pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一层 = 实例索引,第二层 = 时间索引

  • numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表,请参见 datatypes.SCITYPE_REGISTER

规范详情,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考

yTable scitype 的 sktime 兼容表格数据容器

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
self对自身的引用。
fit_predict(X, y, cv=None, change_state=True)[源代码]#

对 X 中的序列进行拟合并预测标签。

用于生成样本内预测和交叉验证样本外预测的便捷方法。

如果 change_state=True,则写入自身

将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

如果 change_state=False,则不更新状态。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex: pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一层 = 实例索引,第二层 = 时间索引

  • numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表,请参见 datatypes.SCITYPE_REGISTER

规范详情,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考

yTable scitype 的 sktime 兼容表格数据容器

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认为 None
  • None: 预测是样本内的,相当于 fit(X, y).predict(X)

  • cv: 预测相当于 fit(X_train, y_train).predict(X_test),其中多个 X_trainy_trainX_testcv 折中获取。返回的 y 是所有测试折预测的并集,cv 测试折必须互不相交

  • int: 相当于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证样本外预测,其中 random_state x 如果存在则取自 self,否则 x=None

change_statebool, 可选 (默认为 True)
  • 如果为 False,将不改变分类器的状态,即拟合/预测序列在副本上运行,self 不变

  • 如果为 True,将把自身拟合到完整的 X 和 y 上,结束状态将等同于运行 fit(X, y)

返回:
y_predTable scitype 的 sktime 兼容表格数据容器

预测的类别标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。

1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同

fit_predict_proba(X, y, cv=None, change_state=True)[源代码]#

对 X 中的序列进行拟合并预测标签概率。

用于生成样本内预测和交叉验证样本外预测的便捷方法。

如果 change_state=True,则写入自身

将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

如果 change_state=False,则不更新状态。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex: pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一层 = 实例索引,第二层 = 时间索引

  • numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表,请参见 datatypes.SCITYPE_REGISTER

规范详情,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考

yTable scitype 的 sktime 兼容表格数据容器

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认为 None
  • None: 预测是样本内的,相当于 fit(X, y).predict(X)

  • cv: 预测相当于 fit(X_train, y_train).predict(X_test),其中多个 X_trainy_trainX_testcv 折中获取。返回的 y 是所有测试折预测的并集,cv 测试折必须互不相交

  • int: 相当于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证样本外预测,其中 random_state x 如果存在则取自 self,否则 x=None

change_statebool, 可选 (默认为 True)
  • 如果为 False,将不改变分类器的状态,即拟合/预测序列在副本上运行,self 不变

  • 如果为 True,将把自身拟合到完整的 X 和 y 上,结束状态将等同于运行 fit(X, y)

返回:
y_pred2D np.array, int 类型, 形状为 [n_instances, n_classes]

预测的类别标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类别索引,顺序与 self.classes_ 中相同 条目是预测的类别概率,总和为 1

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

从类中获取类标签值,带有父类的标签级别继承。

每个 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()[源代码]#

从类中获取类标签,带有父类的标签级别继承。

每个 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()[源代码]#

获取自身的配置标志。

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

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

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

clonereset 调用下,配置会被保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[源代码]#

获取拟合后的参数。

所需状态

要求状态为“已拟合”。

参数:
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()[源代码]#

获取对象的默认参数。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数:
sortbool, 默认为 True

是否按字母顺序排序返回参数名称 (True),或按其在类 __init__ 中出现的顺序返回 (False)。

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

获取估计器的参数。

参数:
deep布尔值, 可选

如果为 True,将返回此估计器及其包含的作为估计器的子对象的参数。

返回:
params字符串到任意类型的映射

参数名称映射到其值。

get_tag(tag_name, tag_value_default=None, raise_error=True)[源代码]#

从实例中获取标签值,带有标签级别继承和覆盖。

每个 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()[源代码]#

从实例中获取标签,带有标签级别继承和覆盖。

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

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

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

值是相应的标签值,覆盖的优先级从高到低依次为:

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

在实例构造时设置。

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

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

按继承顺序排列。

返回:
collected_tagsdict

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

is_composite()[源代码]#

检查对象是否为组合对象。

组合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。

返回:
composite: bool,自身是否包含 BaseObject 类型的参数
property is_fitted[源代码]#

是否已调用 fit

检查对象的 _is_fitted 属性,该属性在对象构造期间应初始化为 False,并在调用对象的 fit 方法时设置为 True。

返回:
bool

估计器是否已进行 fit

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的自身,结果输出到 path,即 cls.save(path) 的输出
classmethod load_from_serial(serial)[源代码]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的自身,结果输出 serial,即 cls.save(None) 的输出
predict(X)[源代码]#

预测 X 中序列的标签。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

用于预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex: pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一层 = 实例索引,第二层 = 时间索引

  • numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表,请参见 datatypes.SCITYPE_REGISTER

规范详情,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考

返回:
y_predTable scitype 的 sktime 兼容表格数据容器

预测的类别标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。

1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同

predict_proba(X)[源代码]#

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

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

用于预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex: pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一层 = 实例索引,第二层 = 时间索引

  • numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表,请参见 datatypes.SCITYPE_REGISTER

规范详情,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考

返回:
y_pred2D np.array, int 类型, 形状为 [n_instances, n_classes]

预测的类别标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类别索引,顺序与 self.classes_ 中相同 条目是预测的类别概率,总和为 1

reset()[源代码]#

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

结果是将 self 设置为其在构造函数调用后的状态,具有相同的超参数。通过 set_config 设置的配置值也会被保留。

调用 reset 会删除任何对象属性,除了

  • 超参数 = 写入 self__init__ 参数,例如 self.paramname,其中 paramname__init__ 的一个参数

  • 包含双下划线(即字符串“__”)的对象属性。例如,名为“__myattr”的属性会被保留。

  • 配置属性,配置会被保留而不改变。也就是说,get_configreset 前后的结果相同。

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

相当于 clone,不同之处在于 reset 修改 self 本身,而不是返回一个新对象。

调用 self.reset() 后,self 在值和状态上等同于通过构造函数调用 type(self)(**self.get_params(deep=False)) 获得的对象。

返回:
self

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

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

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

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

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

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

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

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

  • path=”/home/stored/estimator” 则会有一个 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str,默认值 = “pickle”

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

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

根据 X 上的真实标签对预测标签进行评分。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

用于评估预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex: pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一层 = 实例索引,第二层 = 时间索引

  • numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表,请参见 datatypes.SCITYPE_REGISTER

规范详情,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考

yTable scitype 的 sktime 兼容表格数据容器

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
float,predict(X) 与 y 相比的准确率得分
set_config(**config_dict)[source]#

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

参数:
config_dictdict

配置名称 : 配置值 对的字典。下方列出了有效的配置、值及其含义

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

jupyter 内核如何显示 self 实例

  • “diagram” = HTML 框图表示

  • “text” = 字符串输出

print_changed_onlybool,默认值=True

打印 self 时,是否只列出与默认值不同的 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:parallel 配置控制。如果未传递 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(**kwargs)[source]#

设置估计器的参数。

有效的参数键可以通过 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 派生,且通常与输入的 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 的引用。