KG-RAG 开源项目教程

1. 项目目录结构及介绍

test_notebooks

这个目录包含了测试笔记本，用于验证代码功能。

datadata

存放数据相关文件的地方，可能包括知识图谱和其他输入数据。

kg_rag

此目录包含了核心的KG-RAG代码库。

notebooks

这里存储了可以交互使用的Jupyter笔记本示例。

.gitignore

定义了在版本控制中忽略的文件或文件夹。

LICENSE

项目许可文件，说明了使用该项目的法律条款。

README.md

项目简介和指南，提供了快速入门信息。

__init__.py

Python包初始化文件，使目录被视为一个模块。

config.yaml

主要的配置文件，设置运行参数。

requirements.txt

列出项目依赖的Python库及其版本。

system_prompts.yaml

系统提示的配置文件，用于KG-RAG框架内的交互。

2. 项目启动文件介绍

• python -m kg_rag run_setup 这是项目的一个命令行脚本，用于设置环境，例如创建疾病向量数据库。

• python -m kg_rag rag_based_generation 此命令启动基于RAG（Retrieval-Augmented Generation）的文本生成，可以选择GPT或Llama模型进行操作。

3. 项目配置文件介绍

config.yaml

• config.yaml 是项目的主要配置文件，其中包含了运行KG-RAG时所需的详细信息。比如模型参数、知识图谱设置、API类型等。在运行程序之前，务必根据实际情况更新此文件以确保正确运行。

• 示例配置项可能包括：

  • gpt_model: 指定要使用的GPT模型名称。
  • api_type: API提供商，如 'azure' 或 'openai'。
  • knowledge_graph: 知识图谱的相关设定。

system_prompts.yaml

• system_prompts.yaml 包含了所有系统交互过程中使用的提示语句，这些提示将指导用户完成不同的步骤。

通过理解以上目录结构、启动文件和配置文件，你可以顺利地设置和运行KG-RAG项目。记得在实际操作前阅读官方文档以获取最新和详细的指引。