AStarNet 项目使用教程

1. 项目目录结构及介绍

AStarNet 项目的目录结构如下：

AStarNet/
├── asset/
├── config/
├── data/
├── prompt/
├── reasoning/
├── script/
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt

目录介绍

• asset/: 存放项目相关的资源文件，如图片、视频等。
• config/: 存放项目的配置文件，包括数据集、模型架构和超参数的配置。
• data/: 存放项目所需的数据集文件。
• prompt/: 存放与提示相关的文件。
• reasoning/: 存放与推理相关的代码文件。
• script/: 存放项目的启动脚本文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖库列表。

2. 项目启动文件介绍

项目的启动文件主要位于 script/ 目录下，其中最重要的启动文件是 run.py。

run.py

run.py 是 AStarNet 项目的主要启动脚本，用于运行实验。你可以通过以下命令启动 AStarNet：

python script/run.py -c config/transductive/fb15k237_astarnet.yaml --gpus [0]

• -c 参数指定实验的配置文件路径。
• --gpus 参数指定使用的 GPU 设备，null 表示使用 CPU。

3. 项目配置文件介绍

项目的配置文件位于 config/ 目录下，配置文件主要用于定义数据集、模型架构和超参数。

配置文件示例

# config/transductive/fb15k237_astarnet.yaml

dataset: fb15k237
model:
  name: AStarNet
  hyperparameters:
    learning_rate: 0.001
    batch_size: 32

配置文件结构

• dataset: 指定使用的数据集。
• model: 定义模型的名称和超参数。
  • name: 模型名称。
  • hyperparameters: 模型的超参数，如学习率、批量大小等。

通过配置文件，你可以灵活地调整实验的设置，以适应不同的需求。