KRAGEN 项目安装与使用教程

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

KRAGEN 项目的目录结构如下：

KRAGEN/
├── config/
│   └── kragen.env
├── docker/
│   ├── Dockerfile
│   └── ...
├── images/
│   └── ...
├── release/
│   └── ...
├── src/
│   ├── extract_data.ipynb
│   └── ...
├── test_data/
│   └── test.csv
├── KRAGEN_Dashboard/
│   ├── Frontend/
│   │   ├── env.sample
│   │   └── ...
│   └── ...
├── .gitignore
├── Benchmark_Comparison_and_Setup.md
├── LICENSE
├── conversion.md
├── dev_guide.md
├── docker-compose-flask.yml
├── docker-compose-gui.yml
├── docker-compose-kragen.yml
├── docker-compose-weaviate.yml
├── docker-compose.yml
├── kragen-gui.sh
├── readme.md
└── test.csv

目录结构介绍

• config/: 包含项目的配置文件，如 kragen.env。
• docker/: 包含 Docker 相关的文件，如 Dockerfile。
• images/: 包含项目所需的图片资源。
• release/: 包含项目的发布文件。
• src/: 包含项目的主要源代码，如数据提取的 Jupyter Notebook 文件 extract_data.ipynb。
• test_data/: 包含测试数据，如 test.csv。
• KRAGEN_Dashboard/: 包含前端相关的文件，如 Frontend/ 目录下的 env.sample。
• .gitignore: Git 忽略文件。
• Benchmark_Comparison_and_Setup.md: 性能比较和设置的文档。
• LICENSE: 项目的许可证文件。
• conversion.md: 数据转换相关的文档。
• dev_guide.md: 开发者指南。
• docker-compose-flask.yml, docker-compose-gui.yml, docker-compose-kragen.yml, docker-compose-weaviate.yml, docker-compose.yml: Docker Compose 配置文件。
• kragen-gui.sh: 启动 GUI 的脚本。
• readme.md: 项目的 README 文件。
• test.csv: 测试数据文件。

2. 项目的启动文件介绍

启动文件

• kragen-gui.sh: 该脚本是启动 KRAGEN GUI 的主要脚本。通过运行该脚本，可以启动 KRAGEN 的图形用户界面。

启动步骤

1. 确保 Docker 已安装并运行。

2. 进入 KRAGEN 项目目录。

3. 运行以下命令启动 GUI：

   ./kragen-gui.sh
   

4. 访问 http://localhost:3000 即可使用 KRAGEN。

3. 项目的配置文件介绍

配置文件

• config/kragen.env: 该文件包含 KRAGEN 的主要配置变量，如 OPENAI_API_KEY 和 WEAVIATE_URL。

配置步骤

1. 复制 env.sample 文件并重命名为 .env：

   cp env.sample .env
   

2. 使用文本编辑器打开 .env 文件，并根据需要更新以下变量：

   • OPENAI_API_KEY: 设置为你的 OpenAI API 密钥。
   • WEAVIATE_URL: 设置为你的 Weaviate 数据库的 URL，例如 http://192.168.1.49:8080。

3. 保存并关闭 .env 文件。

4. 如果需要重新配置后端，可以运行以下命令：

   docker compose run kragen config_backend
   

5. 启动 KRAGEN：

   docker compose up gui
   

通过以上步骤，你可以成功配置并启动 KRAGEN 项目。