Analogy¶

class unike.module.model.Analogy(*args: Any, **kwargs: Any)[源代码]¶

Analogy [LWY17] 提出于 2017 年，unike.module.model.DistMult、unike.module.model.HolE 和 unike.module.model.ComplEx 的集大成者，效果与 unike.module.model.HolE、unike.module.model.ComplEx 差不多。

评分函数为:

\[<\operatorname{Re}(\mathbf{h_c}),\operatorname{Re}(\mathbf{r_c}),\operatorname{Re}(\mathbf{t_c})> +<\operatorname{Re}(\mathbf{h_c}),\operatorname{Im}(\mathbf{r_c}),\operatorname{Im}(\mathbf{t_c})> +<\operatorname{Im}(\mathbf{h_c}),\operatorname{Re}(\mathbf{r_c}),\operatorname{Im}(\mathbf{t_c})> -<\operatorname{Im}(\mathbf{h_c}),\operatorname{Im}(\mathbf{r_c}),\operatorname{Re}(\mathbf{t_c})> +<\mathbf{h_d}, \mathbf{r_d}, \mathbf{t_d}>\]

评分函数为 unike.module.model.DistMult 和 unike.module.model.ComplEx 两者评分函数的和。\(< \mathbf{a}, \mathbf{b}, \mathbf{c} >\) 为逐元素多线性点积（element-wise multi-linear dot product），正三元组的评分函数的值越大越好，负三元组越小越好，如果想获得更详细的信息请访问 ANALOGY。

例子:

from unike.config import Trainer, Tester
from unike.module.model import Analogy
from unike.module.loss import SoftplusLoss
from unike.module.strategy import NegativeSampling

# define the model
analogy = Analogy(
        ent_tol = train_dataloader.get_ent_tol(),
        rel_tol = train_dataloader.get_rel_tol(),
        dim = 200
)

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

# test the model
tester = Tester(model = analogy, data_loader = test_dataloader, use_gpu = True, device = 'cuda:1')

# train the model
trainer = Trainer(model = model, data_loader = train_dataloader,
        epochs = 2000, lr = 0.5, opt_method = "adagrad", use_gpu = True, device = 'cuda:1',
        tester = tester, test = True, valid_interval = 100,
        log_interval = 100, save_interval = 100,
        save_path = '../../checkpoint/analogy.pth', delta = 0.01)
trainer.run()

__call__(*args: Any, **kwargs: Any) → Any¶: Call self as a function.

__init__(ent_tol: int, rel_tol: int, dim: int = 100)[源代码]¶

创建 Analogy 对象。

参数:

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(head_emb: torch.Tensor, relation_emb: torch.Tensor, tail_emb: torch.Tensor) → torch.Tensor[源代码]¶

计算 Analogy 的评分函数。

参数:

head_emb (torch.Tensor) – 头实体的向量。
relation_emb (torch.Tensor) – 关系的向量。
tail_emb (torch.Tensor) – 尾实体的向量。

返回:

三元组的得分

返回类型:

torch.Tensor

dim: int¶: 实体嵌入向量和关系嵌入向量的维度

ent_embeddings: torch.nn.Embedding¶: 根据实体个数，创建的实体嵌入

ent_tol: int¶: 实体的种类

forward(triples: torch.Tensor, negs: torch.Tensor | None = None, mode: str = 'single') → torch.Tensor[源代码]¶

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

参数:

triples (str) – 正确的三元组
negs (torch.Tensor) – 负三元组类别
mode – 模式

返回:

三元组的得分

返回类型:

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]

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]], mode) → torch.Tensor[源代码]¶

Analogy 的推理方法。

参数:: data (dict[str, Union[torch.Tensor,str]]) – 数据。
返回:: 三元组的得分
返回类型:: torch.Tensor

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]) – 模型权重字典。

tri2emb(triples: torch.Tensor, negs: torch.Tensor | None = None, mode: str = 'single') → tuple[torch.Tensor, torch.Tensor, torch.Tensor]¶

返回三元组对应的嵌入向量。

参数:

triples (str) – 正确的三元组
negs (torch.Tensor) – 负三元组类别
mode – 模式

返回:

头实体、关系和尾实体的嵌入向量

返回类型:

tuple[torch.Tensor, torch.Tensor, torch.Tensor]

zero_const: torch.nn.parameter.Parameter¶: 常数 0

Analogy¶

Docs