BOSSVSClassifierPyts#
- class BOSSVSClassifierPyts(word_size=4, n_bins=4, window_size=10, window_step=1, anova=False, drop_sum=False, norm_mean=False, norm_std=False, strategy='quantile', alphabet=None, numerosity_reduction=True, use_idf=True, smooth_idf=False, sublinear_tf=True)[source]#
向量空间中的 Bag-of-SFA 符号,来自 pyts。
直接接口到
pyts.classification.BOSSVS
,接口类的作者是johannfaouzi
。使用 Bag-of-SFA 符号 (BOSS) 算法将每个时间序列转换为直方图。然后,对于每个类,将直方图相加并计算 tf-idf 向量。新样本的预测类别是其 tf 向量与每个类的 tf-idf 向量之间余弦相似度最高的类别。
- 参数:
- word_sizeint(默认值 = 4)
每个词的大小。
- n_binsint(默认值 = 4)
要生成的 bin 数量。必须在 2 到 26 之间。
- window_sizeint 或 float(默认值 = 10)
滑动窗口的大小。如果为 float,则表示每个时间序列大小的百分比,并且必须介于 0 和 1 之间。窗口大小将计算为
ceil(window_size * n_timestamps)
。- window_stepint 或 float(默认值 = 1)
滑动窗口的步长。如果为 float,则表示每个时间序列大小的百分比,并且必须介于 0 和 1 之间。窗口大小将计算为
ceil(window_step * n_timestamps)
。- anovabool(默认值 = False)
如果为 True,则通过单因素方差分析 (ANOVA) 测试选择傅里叶系数。如果为 False,则选择前几个傅里叶系数。
- drop_sumbool(默认值 = False)
如果为 True,则删除第一个傅里叶系数(即子序列的总和)。否则保留。
- norm_meanbool(默认值 = False)
如果为 True,则在缩放之前将每个子序列中心化。
- norm_stdbool(默认值 = False)
如果为 True,则将每个子序列缩放到单位方差。
- strategystr(默认值 = ‘quantile’)
用于定义 bin 宽度的策略
‘uniform’:每个样本中的所有 bin 具有相同的宽度
‘quantile’:每个样本中的所有 bin 具有相同数量的点
‘normal’:bin 边缘是标准正态分布的分位数
‘entropy’:使用信息增益计算 bin 边缘
- alphabetNone、‘ordinal’ 或 array-like,形状 = (n_bins,)
要使用的字母表。如果为 None,则使用拉丁字母表的前 n_bins 个字母。
- numerosity_reductionbool(默认值 = True)
如果为 True,则样本中除连续相同单词的最后一个之外,删除所有其他连续相同的单词。
- use_idfbool(默认值 = True)
启用逆文档频率重新加权。
- smooth_idfbool(默认值 = False)
通过给文档频率加一来平滑 idf 权重,就像看到一个额外文档,其中集合中的每个词都只出现一次一样。防止零除。
- sublinear_tfbool(默认值 = True)
应用亚线性 tf 缩放,即将 tf 替换为 1 + log(tf)。
- 属性:
- idf_array,形状 = (n_features,),或 None
当
use_idf=True
时学习到的 idf 向量(全局词权重),否则为 None。- tfidf_array,形状 = (n_classes, n_words)
词-文档矩阵。
- vocabulary_dict
特征索引到词的映射。
参考文献
[1]P. Schäfer, “Scalable Time Series Classification”. Data Mining and Knowledge Discovery, 30(5), 1273-1298 (2016)。
方法
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])从类中获取类标签值,继承父类的标签级别。
从类中获取类标签,继承父类的标签级别。
获取 self 的配置标志。
get_fitted_params
([deep])获取已拟合参数。
获取对象的参数默认值。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,包括标签级别的继承和覆盖。
get_tags
()从实例获取标签,包括标签级别的继承和覆盖。
get_test_params
([parameter_set])返回估计器的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X)预测 X 中序列的标签。
预测 X 中序列的标签概率。
reset
()将对象重置为初始状态后的干净状态。
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)将实例级别的标签覆盖设置为给定值。
- 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
属性是否存在且为True
。在调用对象的fit
方法时,应将is_fitted
属性设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr,可选
调用此方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用的不同对象,处于后初始化状态。此函数等同于返回
self
的sklearn.clone
。等同于构造一个
type(self)
的新实例,使用self
的参数,即type(self)(**self.get_params(deep=False))
。如果配置设置在
self
上,克隆也将具有与原始对象相同的配置,等同于调用cloned_self.set_config(**self.get_config())
。其值也等同于调用
self.reset
,不同之处在于clone
返回一个新对象,而不是像reset
那样改变self
。- 引发:
- 如果克隆不符合规范,则抛出 RuntimeError,原因可能是
__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_tags
或get_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__}
- fit(X, y)[source]#
将时间序列分类器拟合到训练数据。
- 状态变化
将状态更改为“已拟合”。
- 写入 self
将
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 格式
有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详情请参阅标签参考。
- ysktime 兼容的表格数据容器,Table scitype
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类标签。第 0 维索引对应于 X 中的实例索引,第 1 维索引(如果适用)对应于 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回:
- selfself 的引用。
- fit_predict(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 如果 change_state=True,写入 self
将
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 格式
有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详情请参阅标签参考。
- ysktime 兼容的表格数据容器,Table scitype
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_train
、y_train
、X_test
从cv
折中获得。返回的y
是所有测试折预测的并集,cv
测试折必须不相交int:等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证的样本外预测,其中random_state
x
如果存在则取自self
,否则x=None
- change_statebool,可选(默认值=True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列以副本运行,self 不改变
如果为 True,则会将 self 拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
- 返回:
- y_predsktime 兼容的表格数据容器,Table scitype 格式
预测的类别标签
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)[source]#
拟合并预测 X 中序列的标签概率。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 如果 change_state=True,写入 self
将
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 格式
有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详情请参阅标签参考。
- ysktime 兼容的表格数据容器,Table scitype
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_train
、y_train
、X_test
从cv
折中获得。返回的y
是所有测试折预测的并集,cv
测试折必须不相交int:等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证的样本外预测,其中random_state
x
如果存在则取自self
,否则x=None
- change_statebool,可选(默认值=True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列以副本运行,self 不改变
如果为 True,则会将 self 拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
- 返回:
- y_predint 类型的 2D np.array,形状为 [n_instances, n_classes]
预测的类别标签概率。第 0 维索引对应于 X 中的实例索引,第 1 维索引对应于类索引,顺序与 self.classes_ 中相同。条目是预测的类别概率,总和为 1
- classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
从类中获取类标签值,继承父类的标签级别。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。get_class_tag
方法是一个类方法,它只考虑类级别的标签值和覆盖来检索标签的值。它返回对象中名称为
tag_name
的标签的值,考虑标签覆盖,优先级降序如下:设置在类的
_tags
属性中的标签。设置在父类
_tags
属性中的标签,
按继承顺序。
不考虑通过
set_tags
或clone_tags
设置的实例上的动态标签覆盖,这些覆盖定义在实例上。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_default任意类型
如果未找到标签,则为默认/备用值。
- 返回:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类中获取类标签,继承父类的标签级别。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。get_class_tags
方法是一个类方法,它只考虑类级别的标签值和覆盖来检索标签的值。它返回一个字典,其键是设置在类或其任何父类中的任何
_tags
属性的键。值是相应的标签值,按优先级降序的覆盖顺序如下:
设置在类的
_tags
属性中的标签。设置在父类
_tags
属性中的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能包含实例覆盖的标签,请改用
get_tags
方法。不考虑通过
set_tags
或clone_tags
设置的实例上的动态标签覆盖,这些覆盖定义在实例上。要包括来自动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集。不会被通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取 self 的配置标志。
配置是
self
的键值对,通常用作控制行为的临时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置设置在类或其父类的
_config
类属性中,并被通过set_config
设置的动态配置覆盖。在
clone
或reset
调用下,配置得以保留。- 返回:
- config_dictdict
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deepbool,默认值=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名:值字典,包括可拟合组件(= BaseEstimator 类型参数)的已拟合参数。
如果为 False,将返回此对象的参数名:值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_paramsstr 类型键的 dict
已拟合参数的字典,参数名:参数值键值对包括
始终:此对象的所有已拟合参数,如通过
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]#
获取对象的参数名称。
- 参数:
- sort布尔值,默认为 True
是否按字母顺序排序返回参数名称(True),还是按它们在类的
__init__
中出现的顺序返回(False)。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类的__init__
中出现的相同顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool,默认值=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名 : 值字典,包括组件的参数(= 值为BaseObject
的参数)。如果为
False
,将返回此对象的参数名 : 值字典,但不包括组件的参数。
- 返回:
- params键为字符串的字典
参数字典,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
的单个标签的值,同时考虑标签覆盖,优先级按以下降序排列在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构建时。
设置在类的
_tags
属性中的标签。设置在父类
_tags
属性中的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型,可选;默认为 None
如果找不到标签,则使用的默认/回退值
- raise_error布尔值
当找不到标签时是否引发
ValueError
- 返回:
- tag_value任意类型
self
中tag_name
标签的值。如果找不到,并且raise_error
为 True,则引发错误,否则返回tag_value_default
。
- 引发:
- 如果
raise_error
为True
,则引发 ValueError。 如果
tag_name
不在self.get_tags().keys()
中,则会引发ValueError
。
- 如果
- get_tags()[source]#
从实例获取标签,包括标签级别的继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的任何_tags
属性的键,或者通过set_tags
或clone_tags
设置的标签的键。值是相应的标签值,按优先级降序的覆盖顺序如下:
在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构建时。
设置在类的
_tags
属性中的标签。设置在父类
_tags
属性中的标签,
按继承顺序。
- 返回:
- collected_tags字典
标签名 : 标签值 对的字典。通过嵌套继承从
_tags
类属性中收集,然后从_tags_dynamic
对象属性中收集任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用此方法,因为这可能因实例而异。
- 返回:
- composite: 布尔值
对象是否包含任何参数,其值是
BaseObject
的后代实例。
- property is_fitted[source]#
是否已调用
fit
方法。检查对象的
_is_fitted` 属性,该属性在对象构建期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- 布尔值
估计器是否已拟合(fit)。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化的 self,其结果位于路径
path
,由cls.save(path)
生成
- 反序列化的 self,其结果位于路径
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的 self,其结果为
serial
,由cls.save(None)
生成
- 反序列化的 self,其结果为
- predict(X)[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 格式
有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详情请参阅标签参考。
- 返回:
- y_predsktime 兼容的表格数据容器,Table scitype 格式
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 维索引对应于 X 中的实例索引,第 1 维索引(如果适用)对应于 X 中的多输出向量索引。
1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传递的 y 类型相同
- predict_proba(X)[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 格式
有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详情请参阅标签参考。
- 返回:
- y_predint 类型的 2D np.array,形状为 [n_instances, n_classes]
预测的类别标签概率。第 0 个索引对应于 X 中的实例索引,第 1 个索引对应于类别索引,顺序与 self.classes_ 中的顺序相同。条目是预测的类别概率,总和为 1。
- 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 保存到该文件位置。例如
path=”estimator” 则会在当前工作目录 (cwd) 下创建一个名为
estimator.zip
的 zip 文件。path=”/home/stored/estimator” 则会在 `/home/stored/` 下创建一个名为
estimator.zip
的 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 格式
有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详情请参阅标签参考。
- ysktime 兼容的表格数据容器,Table scitype
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类标签。第 0 维索引对应于 X 中的实例索引,第 1 维索引(如果适用)对应于 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回:
- 浮点数,
predict(X)
与y
的准确率得分
- 浮点数,
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名 : 配置值 对的字典。有效的配置、值及其含义如下所示
- display字符串,“diagram”(默认)或“text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_only布尔值,默认为 True
打印 self 时是否只列出与默认值不同的 self 参数(True),还是列出所有参数名称和值(False)。不进行嵌套,即只影响 self,不影响组件估计器。
- warnings字符串,“on”(默认)或“off”
是否发出警告,仅影响来自 sktime 的警告
“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告
- backend:parallel字符串,可选,默认为“None”
广播/向量化时用于并行处理的后端,可选值之一为
“None”:顺序执行循环,简单的列表推导式
“loky”、“multiprocessing”和“threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包
- backend:parallel:params字典,可选,默认为 {}(未传递参数)
作为配置传递给并行化后端的额外参数。有效键取决于
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
在并行化后 关闭。
- “shutdown_ray”:布尔值,默认为 True;False 可防止
“logger_name”:字符串,默认为“ray”;要使用的日志记录器名称。
“mute_warnings”:布尔值,默认为 False;如果为 True,则抑制警告
- 返回:
- self对 self 的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确,也可以使用不带<component>__
的字符串<parameter>
,例如,没有两个组件的参数名称相同。- 参数:
- **params字典
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
的参数,并使用sample_dependent_seed
将它们设置为从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,则仅设置 self 的
random_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_tags
或get_tag
检查。- 参数:
- **tag_dict字典
标签名: 标签值 对的字典。
- 返回:
- self
对 self 的引用。