NeuralKG 开源项目使用教程

NeuralKG 开源项目使用教程

NeuralKG 项目地址: https://gitcode.com/gh_mirrors/ne/NeuralKG

1. 项目目录结构及介绍

NeuralKG 项目的目录结构如下：

NeuralKG/
├── config/
├── dataset/
├── docs/
├── pics/
├── save_axiom_prob/
├── scripts/
├── src/
│   └── neuralkg/
├── .gitignore
├── LICENSE
├── README.md
├── README_CN.md
├── demo.py
├── main.py
├── requirements.txt
└── setup.py

目录介绍

• config/: 存放项目的配置文件。
• dataset/: 存放知识图谱数据集。
• docs/: 存放项目的文档文件。
• pics/: 存放项目的图片资源。
• save_axiom_prob/: 存放保存的公理概率文件。
• scripts/: 存放项目的脚本文件，用于自动化任务。
• src/neuralkg/: 项目的核心代码库，包含各种知识图谱表示学习模型的实现。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目的英文介绍文档。
• README_CN.md: 项目的中文介绍文档。
• demo.py: 项目的演示脚本。
• main.py: 项目的启动文件。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。

2. 项目启动文件介绍

main.py

main.py 是 NeuralKG 项目的启动文件，负责加载配置、训练模型、评估模型等核心功能。以下是该文件的主要功能模块：

• 加载配置: 通过 --load_config 参数加载配置文件。
• 训练模型: 通过配置文件中的参数进行模型训练。
• 评估模型: 通过 --test_only 参数进行模型评估。

使用示例

# 使用配置文件进行训练
python main.py --load_config --config_path <your-config>

# 仅进行模型评估
python main.py --test_only --checkpoint_dir <your-model-path>

3. 项目的配置文件介绍

配置文件目录

配置文件存放在 config/ 目录下，通常以 .yaml 格式存储。配置文件定义了模型的各种参数，如数据集名称、模型名称、损失函数、训练参数等。

配置文件示例

以下是一个配置文件的示例：

command:
  - $[env]
  - $[interpreter]
  - $[program]
  - $[args]
program: main.py
method: bayes
metric:
  goal: maximize
  name: Eval|hits@10
parameters:
  dataset_name:
    value: FB15K237
  model_name:
    value: TransE
  loss_name:
    values: [Adv_Loss, Margin_Loss]
  train_sampler_class:
    values: [UniSampler, BernSampler]
  emb_dim:
    values: [400, 600]
  lr:
    values: [1e-4, 5e-5, 1e-6]
  train_bs:
    values: [1024, 512]
  num_neg:
    values: [128, 256]

配置文件参数说明

• dataset_name: 数据集名称。
• model_name: 模型名称。
• loss_name: 损失函数名称。
• train_sampler_class: 训练采样器类。
• emb_dim: 嵌入维度。
• lr: 学习率。
• train_bs: 训练批次大小。
• num_neg: 负样本数量。

通过配置文件，用户可以灵活地调整模型的各种参数，以适应不同的任务需求。

NeuralKG 项目地址: https://gitcode.com/gh_mirrors/ne/NeuralKG