IndepDist#
- class IndepDist(dist, aggfun=None)[source]#
多元核函数或距离函数的变量级聚合。
一种将单变量时间序列距离或核函数转换为多元时间序列距离或核函数的常用基线方法。
在
aggfun
是求和或均值且成对转换器是时间序列距离的特殊情况下,有时也称为“独立距离”。正式细节(对于实值对象,类比于混合类型行):设 \(d: \mathbb{R}^n \times \mathbb{R}^n\rightarrow \mathbb{R}\) 是应用于长度为 \(n\) 的单变量序列时,
dist
中的成对函数。此类表示定义为 \(d_g(x, y) := g(d(x_1, y_1), \dots, d(x_D, y_D))\) 的成对函数 \(d_g: \mathbb{R}^{n\times D} \times \mathbb{R}^{n\times D}\rightarrow \mathbb{R}\),其中 \(x_i\)、\(y_i\) 表示第 \(i\) 列,x
、y` 被解释为具有 `D` 个变量的多元时间序列,并且其中
g` 是函数 `g: \mathbb{R}^D \rightarrow \mathbb{R}`, 表示输入参数
aggfun
。特别是,如果
aggfun="sum"
(或默认值),那么 \(g(x) = \sum_{i=1}^D x_i\),并且 \(d_g(x, y) := \sum_{i=1}^D d(x_i, y_i)\),这对应于通常的术语“独立距离”。- 参数:
- distscitype 为 BasePairwiseTransformer 的成对转换器,或
可调用 np.ndarray (n_samples, nd) x (n_samples, nd) -> (n_samples x n_samples)
- aggfun可选,字符串或可调用 np.ndarray (m, nd, nd) -> (nd, nd)
变量上的聚合函数,即上述 \(g\)。“sum” = np.sum = 默认值 “mean” = np.mean “median” = np.median “max” = np.max “min” = np.min 当从函数 (m) -> 标量开始时,使用 np.apply_along_axis 创建函数 (m, nd, nd) -> (nd, nd) 并将其作为
aggfun
传入
- 属性:
is_fitted
是否已调用
fit
。
示例
>>> from sktime.dists_kernels.indep import IndepDist >>> from sktime.dists_kernels.dtw import DtwDist >>> >>> dist = IndepDist(DtwDist())
方法
__call__
(X[, X2])计算距离/核矩阵,调用简写。
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, X2])为接口兼容性而设的 fit 方法(内部无逻辑)。
get_class_tag
(tag_name[, tag_value_default])从类中获取类标签值,具有来自父类的标签级别继承。
从类中获取类标签,具有来自父类的标签级别继承。
获取自身的配置标志。
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])返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
reset
()将对象重置到干净的后初始化状态。
save
([path, serialization_format])将序列化后的自身保存到类字节对象或 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别标签覆盖设置为给定值。
transform
(X[, X2])计算距离/核矩阵。
计算距离/核矩阵的对角线。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则抛出
NotFittedError
。- 参数:
- method_namestr,可选
调用此方法的函数的名称。如果提供,错误消息将包含此信息。
- 抛出:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取一个具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于后初始化状态。此函数等同于返回
sklearn.clone
的self
。等同于构造一个新的
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
检查。- 参数:
- estimatorBaseObject 或其派生类的实例
- tag_names字符串或字符串列表,默认 = None
要克隆的标签名称。默认值(
None
)克隆estimator
中的所有标签。
- 返回:
- self
对自身的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集名称,用于测试。如果某个值未定义特殊参数,将返回 “default” 集。
- 返回:
- instance带有默认参数的类的实例
-
第 i 个元素是测试中 objs 中第 i 个实例的名称。命名约定是
{cls.__name__}-{i}
(如果多于一个实例),否则为{cls.__name__}
为接口兼容性而设的 fit 方法(内部无逻辑)。
- fit(X=None, X2=None)[source]#
从类中获取类标签值,具有来自父类的标签级别继承。
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
。 从类中获取类标签,具有来自父类的标签级别继承。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。classmethod get_class_tags()[source]#
get_class_tags
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中
_tags
属性的任何属性的键。它返回名称为
tag_name
的标签的值,同时考虑标签覆盖,优先级降序如下:类中的
_tags
属性中设置的标签。
父类
_tags
属性中设置的标签,值是相应的标签值,覆盖优先级降序如下:
实例可以根据超参数覆盖这些标签。
按继承顺序。
要检索带有潜在实例覆盖的标签,请改用
get_tags
方法。- 对于包含动态标签的覆盖,使用
get_tags
。 collected_tagsdict
-
标签名称:标签值对字典。通过嵌套继承从
_tags
类属性收集。不受set_tags
或clone_tags
设置的动态标签覆盖。 获取自身的配置标志。
配置是自身的键值对,通常用作控制行为的瞬时标志。
get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。- 返回:
- 配置在
clone
或reset
调用后保留。 config_dictdict
- 配置在
- 配置名称:配置值对字典。通过嵌套继承从 _config 类属性收集,然后应用 _config_dynamic 对象属性中的任何覆盖和新标签。
获取已拟合参数。
- 参数:
- 需要状态为“fitted”。
deepbool,默认值=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值的参数)的已拟合参数。
- 返回:
- 如果为 False,将返回此对象的参数名称:值字典,但不包括组件的已拟合参数。
fitted_params键为字符串的字典
已拟合参数字典,键值对为 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]
- 是否按字母顺序排序参数名称(True),或按其在类
-
cls
的参数名称列表。如果sort=False
,则与它们在类__init__
中出现的顺序相同。如果sort=True
,则按字母顺序排列。 获取此对象的参数值字典。
- 参数:
- 返回:
- 如果为
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。 params键为字符串的 dict
参数字典,键值对为 paramname : paramvalue,包含:
始终:此对象的所有已拟合参数,通过
get_param_names
获取,值为此对象该键的已拟合参数值如果
deep=True
,还包含组件参数的键/值对,组件参数的索引格式为[componentname]__[paramname]
,componentname
的所有参数以paramname
形式出现,并带有其值
- 如果为
-
始终:此对象的所有参数,通过
get_param_names
获取,值为此对象该键的参数值,值始终与构造时传入的值相同 从实例获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
get_tag
方法从实例中检索名称为tag_name
的单个标签的值,同时考虑标签覆盖,优先级降序如下:
通过
set_tags
或clone_tags
在实例上设置的标签,它返回名称为
tag_name
的标签的值,同时考虑标签覆盖,优先级降序如下:类中的
_tags
属性中设置的标签。
父类
_tags
属性中设置的标签,- 参数:
- 要检索带有潜在实例覆盖的标签值,请改用
get_tag
方法。 在实例构造时。
- 要检索的标签的名称
tag_value_default任意类型,可选;默认值=None
- 如果未找到标签,则为默认/回退值。
raise_errorbool
- 要检索带有潜在实例覆盖的标签值,请改用
- 返回:
- 如果未找到标签时是否抛出
ValueError
tag_valueAny
- 如果未找到标签时是否抛出
- 抛出:
self
中tag_name
标签的值。如果未找到,且raise_error
为 True,则抛出错误;否则返回tag_value_default
。ValueError,如果
raise_error
为True
。
-
如果
tag_name
不在self.get_tags().keys()
中,则抛出ValueError
。 从实例获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。它返回一个字典,其键是类或其任何父类中
_tags
属性的任何属性的键。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,同时考虑标签覆盖,优先级降序如下:
通过
set_tags
或clone_tags
在实例上设置的标签,它返回名称为
tag_name
的标签的值,同时考虑标签覆盖,优先级降序如下:类中的
_tags
属性中设置的标签。
父类
_tags
属性中设置的标签,- 返回:
get_tags
方法返回一个标签字典,其键是类或其任何父类中_tags
属性的任何属性的键,或通过set_tags
或clone_tags
设置的标签。collected_tagsdict
-
标签名称:标签值对字典。通过嵌套继承从
_tags
类属性收集,然后应用_tags_dynamic
对象属性中的任何覆盖和新标签。 返回估计器的测试参数设置。
-
用于创建类测试实例的参数。每个 dict 都是构造“有趣”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。 检查对象是否由其他 BaseObject 组成。
- 返回:
- 复合对象是一个包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
composite: bool
-
对象是否具有任何参数其值是
BaseObject
后代实例。 是否已调用
fit
。- 返回:
- 检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为
``False
,并在调用对象的 fit 方法时设置为 True。 bool
- 检查对象的
- 估计器是否已 fit。
从文件位置加载对象。
-
反序列化后的自身,结果在
path
,即cls.save(path)
的输出 从序列化内存容器加载对象。
-
反序列化后的自身,结果为
serial
,即cls.save(None)
的输出 将对象重置到干净的后初始化状态。
将
self
设置为其在构造函数调用后立即所处的状态,具有相同的超参数。set_config
设置的配置值也会保留。一个
reset
调用会删除所有对象属性,除了:超参数 =
__init__
的参数,写入self
,例如self.paramname
,其中paramname
是__init__
的参数包含双下划线的对象属性,即字符串“__”。例如,名为“__myattr”的属性会保留。
配置属性,配置会保留,不做更改。也就是说,
reset
前后get_config
的结果是相同的。类和对象方法,以及类属性也不受影响。
等同于
clone
,区别在于reset
修改self
而不是返回一个新对象。- 返回:
- self
在调用
self.reset()
后,self
在值和状态上等同于构造函数调用type(self)(**self.get_params(deep=False))
后获得的对象。
- 类实例重置为干净的后初始化状态,但保留当前超参数值。
将序列化后的自身保存到类字节对象或 (.zip) 文件。
save(path=None, serialization_format='pickle')[source]#
行为:如果
path
为 None,返回内存中的序列化自身;如果path
是文件位置,将其自身存储在该位置作为 zip 文件- 参数:
- 保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即 type(self) _obj - 序列化后的自身。此类使用默认的序列化方式 (pickle)。
pathNone 或文件位置 (str 或 Path)
如果 None,则将自身保存到内存中对象;如果文件位置,则将自身保存到该文件位置。
如果 path=”estimator”,则会在当前工作目录创建 zip 文件
estimator.zip
。
如果 path=”/home/stored/estimator”,则会将 zip 文件
estimator.zip
- 存储在
/home/stored/
中。 serialization_format: str,默认值 = “pickle”
- 返回:
- 用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 如果
path
为 None - 内存中的序列化自身
-
如果
path
是文件位置 - 引用该文件的 ZipFile 将配置标志设置为给定值。
- 参数:
- 配置在
clone
或reset
调用后保留。 - 配置名称:配置值对字典。下方列出了有效的配置、值及其含义
displaystr,“diagram”(默认值),或“text”
Jupyter kernel 如何显示自身实例
“diagram” = HTML 框图表示
- “text” = 字符串输出
print_changed_onlybool,默认值=True
- 打印自身时是否仅打印与默认值不同的自身参数(True),或打印所有参数名称和值(False)。不进行嵌套,即仅影响自身,不影响组件估计器。
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
在并行化后关闭。
- “ray_remote_args”:
“logger_name”: str, 默认值=”ray”;要使用的日志记录器名称。
“logger_name”:str,默认值=”ray”;要使用的日志记录器名称。
- 配置在
- 返回:
- “mute_warnings”:bool,默认值=False;如果为 True,则抑制警告
self自身引用。
备注
- 更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
设置此对象的参数。
此方法适用于简单的 skbase 对象和复合对象。参数键字符串
<component>__<parameter>
可用于复合对象,即包含其他对象的对象,以访问组件<component>
中的<parameter>
。如果引用是明确的,也可以使用不带<component>__
的字符串<parameter>
,例如,没有两个组件参数具有相同的名称<parameter>
。- 参数:
- **params字典
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 可在多次函数调用中获得可重现的输出。
- 需要状态为“fitted”。
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,将仅设置
self
的random_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]#
将实例级别标签覆盖设置为给定值。
classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
标签是特定于实例
self
的键值对,它们是对象构建后不更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要将标签设置为的值。set_tags
方法应仅在对象的__init__
方法中、构建期间或通过__init__
构建后直接调用。当前标签值可以通过
get_tags
或get_tag
检查。- 参数:
- **tag_dict字典
标签名称:标签值对的字典。
- 返回:
- Self
指向 self 的引用。
- transform(X, X2=None)[source]#
计算距离/核矩阵。
- 行为:返回成对距离/核矩阵
X 和 X2 中样本之间的距离/核矩阵(如果未传递,则等于 X)
- 参数:
- XSeries 或 Panel,任何受支持的 mtype,包含 n 个实例
- 要转换的数据,Python 类型如下:
Series: pd.Series, pd.DataFrame 或 np.ndarray (1D 或 2D) Panel: 具有 2 级 MultiIndex 的 pd.DataFrame, list of pd.DataFrame,
嵌套的 pd.DataFrame 或长/宽格式的 pd.DataFrame
- 需符合 sktime mtype 格式规范,详情请参阅
examples/AA_datatypes_and_datasets.ipynb
- X2Series 或 Panel,任何受支持的 mtype,包含 m 个实例
可选,默认值: X = X2
- 要转换的数据,Python 类型如下:
Series: pd.Series, pd.DataFrame 或 np.ndarray (1D 或 2D) Panel: 具有 2 级 MultiIndex 的 pd.DataFrame, list of pd.DataFrame,
嵌套的 pd.DataFrame 或长/宽格式的 pd.DataFrame
- 需符合 sktime mtype 格式规范,详情请参阅
examples/AA_datatypes_and_datasets.ipynb
X 和 X2 不需要具有相同的 mtype
- 返回:
- distmat: shape 为 [n, m] 的 np.array
(i,j) 项包含 X[i] 和 X2[j] 之间的距离/核
- transform_diag(X)[source]#
计算距离/核矩阵的对角线。
行为:返回 X 中样本距离/核矩阵的对角线
- 参数:
- XSeries 或 Panel,任何受支持的 mtype,包含 n 个实例
- 要转换的数据,Python 类型如下:
Series: pd.Series, pd.DataFrame 或 np.ndarray (1D 或 2D) Panel: 具有 2 级 MultiIndex 的 pd.DataFrame, list of pd.DataFrame,
嵌套的 pd.DataFrame 或长/宽格式的 pd.DataFrame
- 需符合 sktime mtype 格式规范,详情请参阅
examples/AA_datatypes_and_datasets.ipynb
- 返回:
- diag: shape 为 [n] 的 np.array
第 i 项包含 X[i] 和 X[i] 之间的距离/核