TransD¶

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

TransD [JHX+15] 提出于 2015 年，自动生成映射矩阵，简单而且高效，是对 TransR 的改进。

评分函数为:

\[\parallel (\mathbf{r}_p \mathbf{h}_p^T + \mathbf{I})\mathbf{h} + \mathbf{r} - (\mathbf{r}_p \mathbf{t}_p^T + \mathbf{I})\mathbf{t} \parallel_{L_1/L_2}\]

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

例子:

from pybind11_ke.utils import WandbLogger
from pybind11_ke.data import KGEDataLoader, BernSampler, TradTestSampler
from pybind11_ke.module.model import TransD
from pybind11_ke.module.loss import MarginLoss
from pybind11_ke.module.strategy import NegativeSampling
from pybind11_ke.config import Trainer, Tester

wandb_logger = WandbLogger(
        project="pybind11-ke",
        name="TransD-FB15K237",
        config=dict(
                in_path = '../../benchmarks/FB15K237/',
                batch_size = 2048,
                neg_ent = 25,
                test = True,
                test_batch_size = 10,
                num_workers = 16,
                dim_e = 200,
                dim_r = 200,
                p_norm = 1,
                norm_flag = True,
                margin = 4.0,
                use_gpu = True,
                device = 'cuda:1',
                epochs = 1000,
                lr = 1.0,
                opt_method = 'sgd',
                valid_interval = 100,
                log_interval = 100,
                save_interval = 100,
                save_path = '../../checkpoint/transd.pth'
        )
)

config = wandb_logger.config

# dataloader for training
dataloader = KGEDataLoader(
        in_path = config.in_path, 
        batch_size = config.batch_size,
        neg_ent = config.neg_ent,
        test = config.test,
        test_batch_size = config.test_batch_size,
        num_workers = config.num_workers,
        train_sampler = BernSampler,
        test_sampler = TradTestSampler
)

# define the model
transd = TransD(
        ent_tol = dataloader.get_ent_tol(),
        rel_tol = dataloader.get_rel_tol(),
        dim_e = config.dim_e, 
        dim_r = config.dim_r, 
        p_norm = config.p_norm, 
        norm_flag = config.norm_flag)

# define the loss function
model = NegativeSampling(
        model = transd, 
        loss = MarginLoss(margin = config.margin)
)

# test the model
tester = Tester(model = transd, data_loader = dataloader, use_gpu = config.use_gpu, device = config.device)

# train the model
trainer = Trainer(model = model, data_loader = dataloader.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()

# close your wandb run
wandb_logger.finish()

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

__init__(ent_tol: int, rel_tol: int, dim_e: int = 100, dim_r: int = 100, p_norm: int = 1, norm_flag: bool = True, margin: float | None = None)[源代码]¶

创建 TransD 对象。

参数:

ent_tol (int) – 实体的个数
rel_tol (int) – 关系的个数
dim_e (int) – 实体嵌入和实体投影向量的维度
dim_r (int) – 关系嵌入和关系投影向量的维度
p_norm (int) – 评分函数的距离函数, 按照原论文，这里可以取 1 或 2。
norm_flag (bool) – 是否利用 torch.nn.functional.normalize() 对实体和关系嵌入的最后一维执行 L2-norm。
margin (float) – 当使用 RotatE [SDNT19] 的损失函数 pybind11_ke.module.loss.SigmoidLoss，需要提供此参数，将 TransE [BUGD+13] 的正三元组的评分由越小越好转化为越大越好，如果想获得更详细的信息请访问 RotatE。

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

计算 TransD 的评分函数。

参数:

h (torch.Tensor) – 头实体的向量。
r (torch.Tensor) – 关系的向量。
t (torch.Tensor) – 尾实体的向量。

返回:

三元组的得分

返回类型:

torch.Tensor

_resize(tensor: torch.Tensor, axis: int, size: int) → torch.Tensor[源代码]¶

计算实体向量与单位矩阵的乘法，并返回结果向量。

源代码使用 torch.narrow() 进行缩小向量， torch.nn.functional.pad() 进行填充向量。

参数:

tensor (torch.Tensor) – 实体向量。
axis (int) – 在哪个轴上进行乘法运算。
size (int) – 运算结果在 axis 上的维度大小，一般为关系向量的维度。

返回:

乘法结果的向量

返回类型:

torch.Tensor

_transfer(e: torch.Tensor, e_transfer: torch.Tensor, r_transfer: torch.Tensor) → torch.Tensor[源代码]¶

将头实体或尾实体的向量映射到关系向量空间。

参数:

e (torch.Tensor) – 头实体或尾实体向量。
e_transfer (torch.Tensor) – 头实体或尾实体的投影向量
r_transfer (torch.Tensor) – 关系的投影向量

返回:

投影后的实体向量

返回类型:

torch.Tensor

dim_e: int¶: 实体嵌入和实体投影向量的维度

dim_r: int¶: 关系嵌入和关系投影向量的维度

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

ent_tol: int¶: 实体的种类

ent_transfer: torch.nn.Embedding¶: 根据实体个数，创建的实体投影向量

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) – 模型保存的路径

margin: torch.nn.parameter.Parameter¶: 当使用 RotatE [SDNT19] 的损失函数 pybind11_ke.module.loss.SigmoidLoss，需要提供此参数，将 TransE [BUGD+13] 的正三元组的评分由越小越好转化为越大越好，如果想获得更详细的信息请访问 RotatE。