G-Retriever 项目使用教程

1. 项目的目录结构及介绍

G-Retriever 项目的目录结构如下：

G-Retriever/
├── dataset/
│   ├── preprocess/
│   └── expla_graphs/
├── figs/
├── src/
│   ├── dataset/
│   ├── model/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── inference.py
├── run.sh
├── train.py
└── ...

目录结构介绍

• dataset/: 包含数据预处理的脚本和数据集文件。
  • preprocess/: 数据预处理脚本。
  • expla_graphs/: 解释图数据集文件。
• figs/: 存放项目相关的图片文件。
• src/: 项目的主要源代码目录。
  • dataset/: 数据集处理相关代码。
  • model/: 模型定义和实现代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• inference.py: 推理脚本。
• run.sh: 运行脚本。
• train.py: 训练脚本。

2. 项目的启动文件介绍

run.sh

run.sh 是一个启动脚本，用于运行项目的代码并重现已发布的实验结果。使用方法如下：

./run.sh

该脚本会执行项目中的主要代码，确保实验结果的可重复性。

train.py

train.py 是项目的训练脚本，用于训练模型。使用方法如下：

python train.py --dataset scene_graphs --model_name graph_llm

参数说明：

• --dataset: 指定数据集，如 scene_graphs。
• --model_name: 指定模型名称，如 graph_llm。

inference.py

inference.py 是项目的推理脚本，用于对模型进行推理。使用方法如下：

python inference.py --dataset scene_graphs --model_name inference_llm --llm_model_name 7b_chat

参数说明：

• --dataset: 指定数据集，如 scene_graphs。
• --model_name: 指定模型名称，如 inference_llm。
• --llm_model_name: 指定大语言模型名称，如 7b_chat。

3. 项目的配置文件介绍

src/model/__init__.py

src/model/__init__.py 文件中包含了模型的初始化配置。在训练或推理之前，需要在该文件中替换大语言模型的检查点路径。

环境配置

项目的环境配置通过 conda 进行管理。以下是环境配置的步骤：

conda create --name g_retriever python=3.9 -y
conda activate g_retriever

# 安装 PyTorch
conda install pytorch==2.0.1 torchvision==0.15.2 torchaudio==2.0.2 pytorch-cuda=11.8 -c pytorch -c nvidia

# 安装其他依赖
pip install pyg_lib torch_scatter torch_sparse torch_cluster torch_spline_conv -f https://data.pyg.org/whl/torch-2.0.1+cu118.html
pip install peft pandas ogb transformers wandb sentencepiece torch_geometric datasets pcst_fast

通过以上步骤，您可以成功配置项目的环境并开始使用 G-Retriever 进行训练和推理。