DiLu 开源项目使用教程
1. 项目的目录结构及介绍
DiLu 项目的目录结构如下:
DiLu/
├── assets/
├── dilu/
├── memories/
│ └── 20_mem/
├── github/
│ └── workflows/
├── .gitignore
├── LICENSE
├── README.md
├── config.yaml
├── requirements.txt
├── run_dilu.py
└── visualize_results.py
目录结构介绍
assets/
: 存放项目相关的静态资源文件。dilu/
: 存放 DiLu 框架的核心代码文件。memories/
: 存放记忆模块的文件,例如20_mem/
目录。github/
: 存放 GitHub 工作流配置文件,例如workflows/
目录。.gitignore
: Git 忽略文件配置。LICENSE
: 项目许可证文件。README.md
: 项目介绍和使用说明。config.yaml
: 项目配置文件。requirements.txt
: 项目依赖库列表。run_dilu.py
: 项目启动文件。visualize_results.py
: 结果可视化脚本。
2. 项目的启动文件介绍
run_dilu.py
run_dilu.py
是 DiLu 项目的启动文件,用于运行 DiLu 框架的模拟和决策过程。该文件的主要功能包括:
- 加载配置文件
config.yaml
。 - 初始化 DiLu 框架的各个模块(环境、推理、反思和记忆)。
- 执行模拟任务,生成决策并记录结果。
- 保存模拟结果和日志文件。
使用方法
python run_dilu.py
3. 项目的配置文件介绍
config.yaml
config.yaml
是 DiLu 项目的配置文件,包含了项目的各种配置参数。以下是配置文件的主要内容:
OPENAI_API_TYPE: # 'openai' or 'azure'
# 以下是 OpenAI 的配置
OPENAI_KEY: # 'sk-xxxxxx'
OPENAI_CHAT_MODEL: 'gpt-4-1106-preview'
# 以下是 Azure OpenAI 服务的配置
AZURE_API_BASE: # https://xxxxxxx.openai.azure.com/
AZURE_API_VERSION: "2023-07-01-preview"
AZURE_API_KEY: #'xxxxxxx'
AZURE_CHAT_DEPLOY_NAME: # chat model deployment name
AZURE_EMBED_DEPLOY_NAME: # text embed model deployment name
配置文件介绍
OPENAI_API_TYPE
: 指定使用 OpenAI 还是 Azure OpenAI 服务。OPENAI_KEY
: OpenAI API 密钥。OPENAI_CHAT_MODEL
: 使用的 OpenAI 聊天模型。AZURE_API_BASE
: Azure OpenAI 服务的 API 基础 URL。AZURE_API_VERSION
: Azure OpenAI 服务的 API 版本。AZURE_API_KEY
: Azure OpenAI 服务的 API 密钥。AZURE_CHAT_DEPLOY_NAME
: Azure OpenAI 聊天模型部署名称。AZURE_EMBED_DEPLOY_NAME
: Azure OpenAI 文本嵌入模型部署名称。
通过修改 config.yaml
文件,可以配置 DiLu 框架的运行环境和模型参数。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考