Shortcuts

TransD-FB15K237-single-gpu-wandb || TransD-FB15K237-single-gpu-hpo

TransD-FB15K237-single-gpu-wandb

备注

created by LuYF-Lemon-love <luyanfeng_nlp@qq.com> on May 7, 2023

备注

updated by LuYF-Lemon-love <luyanfeng_nlp@qq.com> on May 14, 2024

备注

last run by LuYF-Lemon-love <luyanfeng_nlp@qq.com> on May 14, 2024

这一部分介绍如何用一个 GPU 在 FB15K237 知识图谱上训练 TransD [JHX+15],使用 wandb 记录实验结果。

导入数据

pybind11-OpenKE 有两个工具用于导入数据: pybind11_ke.data.KGEDataLoader

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

首先初始化 pybind11_ke.utils.WandbLogger 日志记录器,它是对 wandb 初始化操作的一层简单封装。

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_tqdm = False,
            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

pybind11-OpenKE 提供了很多数据集,它们很多都是 KGE 原论文发表时附带的数据集。 pybind11_ke.data.KGEDataLoader 包含 in_path 用于传递数据集目录。

# 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
)

导入模型

pybind11-OpenKE 提供了很多 KGE 模型,它们都是目前最常用的基线模型。我们下面将要导入 pybind11_ke.module.model.TransD,它是动态构建映射矩阵的平移模型。

# 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)

损失函数

我们这里使用了 TransD 原论文使用的损失函数:pybind11_ke.module.loss.MarginLosspybind11_ke.module.strategy.NegativeSamplingpybind11_ke.module.loss.MarginLoss 进行了封装,加入权重衰减等额外项。

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

训练模型

pybind11-OpenKE 将训练循环包装成了 pybind11_ke.config.Trainer, 可以运行它的 pybind11_ke.config.Trainer.run() 函数进行模型学习; 也可以通过传入 pybind11_ke.config.Tester, 使得训练器能够在训练过程中评估模型。

# test the model
tester = Tester(model = transd, data_loader = dataloader, use_tqdm = config.use_tqdm,
                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()

备注

上述代码的运行日志可以从 此处 下载。

备注

上述代码的运行报告可以从 此处 下载。


Total running time of the script: ( 0 minutes 0.000 seconds)

Gallery generated by Sphinx-Gallery

Docs

Access comprehensive developer documentation for Pybind11-OpenKE

View Docs