HolE

class pybind11_ke.module.model.HolE(*args: Any, **kwargs: Any)

HolE [NRP16] 提出于 2016 年，利用循环相关进行知识图谱嵌入，是 RESCAL 的压缩版本，因此非常容易的应用于大型的知识图谱。

评分函数为:

\[\mathbf{r}^T (\mathcal{F}^{-1}(\overline{\mathcal{F}(\mathbf{h})} \odot \mathcal{F}(\mathbf{t})))\]

其中 \(\mathcal{F}(\cdot)\) 和 \(\mathcal{F}^{-1}(\cdot)\) 表示快速傅里叶变换，\(\overline{\mathbf{x}}\) 表示复数共轭，\(\odot\) 表示哈达玛积。

正三元组的评分函数的值越大越好，负三元组越小越好，如果想获得更详细的信息请访问 HolE。

例子:

from pybind11_ke.config import Trainer, Tester
from pybind11_ke.module.model import HolE
from pybind11_ke.module.loss import SoftplusLoss
from pybind11_ke.module.strategy import NegativeSampling

# define the model
hole = HolE(
        ent_tol = train_dataloader.get_ent_tol(),
        rel_tol = train_dataloader.get_rel_tol(),
        dim = config.dim
)

# define the loss function
model = NegativeSampling(
        model = hole, 
        loss = SoftplusLoss(),
        batch_size = train_dataloader.get_batch_size(), 
        regul_rate = config.regul_rate
)

# test the model
tester = Tester(model = hole, data_loader = test_dataloader, use_gpu = config.use_gpu, device = config.device)

# train the model
trainer = Trainer(model = model, data_loader = train_dataloader, epochs = config.epochs,
        lr = config.lr, opt_method = config.opt_method, use_gpu = config.use_gpu, device = config.device,
        tester = tester, test = config.test, valid_interval = config.valid_interval,
        log_interval = config.log_interval, save_interval = config.save_interval,
        save_path = config.save_path, use_wandb = True)
trainer.run()

__call__(*args: Any, **kwargs: Any) → Any

Call self as a function.

__init__(ent_tol: int, rel_tol: int, dim: int = 100)

创建 HolE 对象。

参数:

• ent_tol (int) – 实体的个数

• rel_tol (int) – 关系的个数

• dim (int) – 实体和关系嵌入向量的维度

static __new__(cls, *args: Any, **kwargs: Any) → Any

__repr__() → str

Return repr(self).

__weakref__

list of weak references to the object (if defined)

_calc(h: torch.Tensor, t: torch.Tensor, r: torch.Tensor, mode: str) → torch.Tensor

计算 HolE 的评分函数。

参数:

• h (torch.Tensor) – 头实体的向量。

• t (torch.Tensor) – 尾实体的向量。

• r (torch.Tensor) – 关系的向量。

• mode (str) – normal 表示 pybind11_ke.data.TrainDataLoader 为训练同时进行头实体和尾实体负采样的数据，head_batch 和 tail_batch 表示为了减少数据传输成本，需要进行广播的数据，在广播前需要 reshape。

返回:

三元组的得分

返回类型:

torch.Tensor

_ccorr(a: torch.Tensor, b: torch.Tensor) → torch.Tensor

计算循环相关 \(\mathcal{F}^{-1}(\overline{\mathcal{F}(\mathbf{h})} \odot \mathcal{F}(\mathbf{t}))\)。

利用 torch.fft.rfft() 计算实数到复数离散傅里叶变换，torch.fft.irfft() 是其逆变换； 利用 torch.conj() 计算复数的共轭。

参数:

• a (torch.Tensor) – 头实体的向量。

• b (torch.Tensor) – 尾实体的向量。

返回:

返回循环相关计算结果。

返回类型:

torch.Tensor

dim: int

实体和关系嵌入向量的维度

ent_embeddings: torch.nn.Embedding

根据实体个数，创建的实体嵌入

ent_tol: int

实体的种类

forward(data: dict[str, Union[torch.Tensor, str]]) → torch.Tensor

定义每次调用时执行的计算。 torch.nn.Module 子类必须重写 torch.nn.Module.forward()。

参数:

data (dict[str, Union[torch.Tensor, str]]) – 数据。

返回:

三元组的得分

返回类型:

torch.Tensor

get_parameters(mode: str = 'numpy', param_dict: dict[str, Any] | None = None) → dict[str, numpy.ndarray] | dict[str, list] | dict[str, torch.Tensor]

获得模型权重。

参数:

• mode – 模型保存的格式，可以选择 numpy 、 list 和 Tensor 。

• param_dict (dict[str, Any] | None) – 可以选择从哪里获得模型权重。

返回:

模型权重字典。

返回类型:

dict[str, numpy.ndarray] | dict[str, list] | dict[str, torch.Tensor]

l3_regularization() → torch.Tensor

L3 正则化函数，在损失函数中用到。

返回:

模型参数的正则损失

返回类型:

torch.Tensor

load_checkpoint(path: str)

加载模型权重。

参数:

path (str) – 模型保存的路径

load_parameters(path: str)

加载模型权重。

参数:

path (str) – 模型保存的路径

pi_const: torch.nn.parameter.Parameter

常数 pi

predict(data: dict[str, Union[torch.Tensor, str]]) → numpy.ndarray

HolE 的推理方法。

参数:

data (dict[str, Union[torch.Tensor, str]]) – 数据。

返回:

三元组的得分

返回类型:

numpy.ndarray

regularization(data: dict[str, Union[torch.Tensor, str]]) → torch.Tensor

L2 正则化函数（又称权重衰减），在损失函数中用到。

参数:

data (dict[str, Union[torch.Tensor, str]]) – 数据。

返回:

模型参数的正则损失

返回类型:

torch.Tensor

rel_embeddings: torch.nn.Embedding

根据关系个数，创建的关系嵌入

rel_tol: int

关系的种类

save_checkpoint(path: str)

保存模型权重。

参数:

path (str) – 模型保存的路径

save_parameters(path: str)

用 json 格式保存模型权重。

参数:

path (str) – 模型保存的路径

set_parameters(parameters: dict[str, Any])

加载模型权重。

参数:

parameters (dict[str, Any]) – 模型权重字典。

zero_const: torch.nn.parameter.Parameter

常数 0