BasePairwiseTransformer#
- class BasePairwiseTransformer[source]#
用于表格或序列数据模板类的基本成对变换器。
基本成对变换器指定了所有成对变换器必须实现的方法和方法签名。
这些方法的具体实现推迟到具体类中进行。
- 属性:
is_fitted
是否已调用
fit
方法。
方法
__call__
(X[, X2])计算距离/核矩阵,调用简写。
check_is_fitted
([method_name])检查估计器是否已 fitted。
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])从类中获取类标签值,带有父类的标签级继承。
从类中获取类标签,带有父类的标签级继承。
获取 self 的配置标志。
get_fitted_params
([deep])获取 fitted 参数。
获取对象的默认参数。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,带有标签级继承和覆盖。
get_tags
()从实例获取标签,带有标签级继承和覆盖。
get_test_params
([parameter_set])返回 skbase 对象的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
reset
()将对象重置到初始化后的干净状态。
save
([path, serialization_format])将序列化的 self 保存到字节类对象或 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为 self 设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级标签覆盖设置为给定值。
transform
(X[, X2])计算距离/核矩阵。
- transform(X, X2=None)[source]#
计算距离/核矩阵。
- 行为:返回成对距离/核矩阵
在 X 和 X2(如果未传递则等于 X)中的样本之间
- 参数:
- X: 长度为 n 的 pd.DataFrame,或具有 n 行的 2D np.array
- X2: 长度为 m 的 pd.DataFrame,或具有 m 行的 2D np.array,可选
默认 X2 = X
- 返回:
- distmat: 形状为 [n, m] 的 np.array
(i,j) 元素包含 X.iloc[i] 和 X2.iloc[j] 之间的距离/核
- check_is_fitted(method_name=None)[source]#
检查估计器是否已 fitted。
检查是否存在
_is_fitted
属性且其值为True
。在调用对象的fit
方法时,is_fitted
属性应设置为True
。如果不是,则会引发
NotFittedError
。- 参数:
- method_namestr,可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未 fitted。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后的状态。此函数等效于返回
sklearn.clone
的self
。等效于使用
self
的参数构建一个新的type(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_tags
或get_tag
查看。- 参数:
- estimatorBaseObject 或派生类的一个实例
- 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
的标签值,考虑标签覆盖,优先级降序如下:在类的
_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]#
获取 fitted 参数。
- 所需状态
要求状态为 “fitted”。
- 参数:
- deepbool,默认=True
是否返回组件的 fitted 参数。
如果为 True,将返回此对象的参数名称:值字典,包括可 fitted 组件(= BaseEstimator 值参数)的 fitted 参数。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的 fitted 参数。
- 返回:
- fitted_params带有 str 类型键的 dict
fitted 参数字典, paramname : paramvalue 键值对包括
always: 此对象的所有 fitted 参数,如通过
get_param_names
获得的值,是该键对应的此对象的 fitted 参数值如果
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 键值对包括
always: 此对象的所有参数,如通过
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_errorbool
未找到标签时是否引发
ValueError
- 返回:
- tag_valueAny
self
中tag_name
标签的值。如果未找到,并且raise_error
为 True,则引发错误,否则返回tag_value_default
。
- 引发:
- ValueError,如果
raise_error
为True
。 如果
tag_name
不在self.get_tags().keys()
中,则引发ValueError
。
- ValueError,如果
- get_tags()[source]#
从实例获取标签,带有标签级继承和覆盖。
每个与
scikit-base
兼容的对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。get_tags
方法返回一个标签字典,其中的键是类或其任何父类中设置的任何_tags
属性的键,或通过set_tags
或clone_tags
设置的标签。值是对应的标签值,按以下降序优先级进行覆盖:
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tagsdict
标签名称:标签值对字典。通过嵌套继承从
_tags
类属性收集,然后从_tags_dynamic
对象属性收集任何覆盖和新标签。
- classmethod get_test_params(parameter_set='default')[source]#
返回 skbase 对象的测试参数设置。
get_test_params
是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于create_test_instance
和create_test_instances_and_names
来构造测试实例。get_test_params
应该返回单个dict
,或dict
的list
。每个
dict
都是用于测试的参数配置,可用于构造一个“有趣的”测试实例。对于get_test_params
返回中的所有字典params
,调用cls(**params)
都应该有效。get_test_params
不必返回固定的字典列表,它也可以返回动态或随机参数设置。- 参数:
- parameter_setstr,默认=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 参数集。
- 返回:
- paramsdict 或 dict 列表,默认 = {}
用于创建类测试实例的参数。每个 dict 都是构造“有趣的”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是一个包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- 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) 的结果
- 返回:
- 通过
cls.save(path)
,在path
生成输出的非序列化 self
- 通过
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 通过
cls.save(None)
,生成输出serial
的非序列化 self
- 通过
- 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) 创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则会在
/home/stored/
中保存一个 zip 文件estimator.zip
。
存储在
/home/stored/
中。- serialization_format: str,默认 = “pickle”
用于序列化的模块。可用选项包括 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称:配置值对字典。有效的配置、值及其含义如下所示
- displaystr,“diagram”(默认)或“text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认=True
打印 self 时是只列出与默认值不同的参数 (False),还是列出所有参数名称和值 (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
在并行化后 关闭。
- “shutdown_ray”:bool,默认=True;False 会阻止
“logger_name”: str, 默认值=”ray”;要使用的日志记录器名称。
“mute_warnings”: bool, 默认值=False;如果为 True,则抑制警告
- 返回:
- self对自身的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及组合对象。参数键字符串
<component>__<parameter>
可用于组合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确(例如,没有两个组件参数的名称相同),也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,前提是在 get_params 键中是唯一的。
- 返回:
- 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,则仅设置
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对自身的引用
- set_tags(**tag_dict)[source]#
将实例级标签覆盖设置为给定值。
每个与
scikit-base
兼容的对象都有一个标签字典,用于存储有关对象的元数据。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名,字典值是要将标签设置为什么值。的
set_tags
方法应仅在对象的__init__
方法中调用,即在构造期间,或通过__init__
直接构造之后调用。当前的标签值可以通过
get_tags
或get_tag
查看。- 参数:
- **tag_dictdict
标签名:标签值 对的字典。
- 返回:
- 自身
对自身的引用。