KnowPrompt 项目使用教程

1. 项目目录结构及介绍

KnowPrompt 项目的目录结构如下：

knowprompt
|-- dataset
|   |-- semeval
|   |   |-- train.txt
|   |   |-- dev.txt
|   |   |-- test.txt
|   |   |-- temp.txt
|   |   |-- rel2id.json
|   |-- dialogue
|   |   |-- train.json
|   |   |-- dev.json
|   |   |-- test.json
|   |   |-- rel2id.json
|   |-- tacred
|   |   |-- train.txt
|   |   |-- dev.txt
|   |   |-- test.txt
|   |   |-- temp.txt
|   |   |-- rel2id.json
|   |-- tacrev
|   |   |-- train.txt
|   |   |-- dev.txt
|   |   |-- test.txt
|   |   |-- temp.txt
|   |   |-- rel2id.json
|   |-- retacred
|   |   |-- train.txt
|   |   |-- dev.txt
|   |   |-- test.txt
|   |   |-- temp.txt
|   |   |-- rel2id.json
|-- scripts
|   |-- semeval.sh
|   |-- dialogue.sh
|-- lit_models
|-- models
|-- scripts
|-- .gitignore
|-- CITATION.cff
|-- LICENSE
|-- README.md
|-- generate_k_shot.py
|-- get_label_word.py
|-- main.py
|-- model.png
|-- requirements.txt

目录结构介绍

• dataset: 包含所有用于实验的数据集，包括 semeval, dialogue, tacred, tacrev, retacred 等。每个数据集目录下包含训练集、验证集、测试集、临时文件和关系ID映射文件。
• scripts: 包含用于运行实验的脚本文件，如 semeval.sh 和 dialogue.sh。
• lit_models: 包含轻量级模型相关的文件。
• models: 包含模型相关的文件。
• scripts: 包含其他脚本文件。
• .gitignore: Git 忽略文件。
• CITATION.cff: 引用文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• generate_k_shot.py: 用于生成少样本数据集的脚本。
• get_label_word.py: 用于获取标签词的脚本。
• main.py: 项目的主启动文件。
• model.png: 模型结构图。
• requirements.txt: 项目依赖文件。

2. 项目启动文件介绍

项目的主启动文件是 main.py。该文件负责初始化模型、加载数据集、进行训练和评估等操作。

主要功能

• 模型初始化: 初始化 KnowPrompt 模型。
• 数据加载: 加载训练集、验证集和测试集。
• 训练: 进行模型的训练。
• 评估: 对模型进行评估。

使用方法

python main.py

3. 项目配置文件介绍

项目的配置文件主要是 requirements.txt，该文件列出了项目运行所需的所有依赖包。

配置文件内容

torch==1.8.1
transformers==4.6.0
numpy==1.20.3
...

安装依赖

pip install -r requirements.txt

通过以上步骤，您可以顺利启动和配置 KnowPrompt 项目。