MAESTRO 项目启动与配置教程

1. 项目目录结构及介绍

MAESTRO 项目是一个模块化的研究应用，旨在简化复杂的研究任务。以下是项目的目录结构及其各个部分的简要介绍：

• ai_researcher/：包含主要的 AI 研究者代码和相关文件。
  • .env.example：配置文件模板，用于设置环境变量。
  • requirements.txt：项目依赖的 Python 包列表。
  • ui/app.py：Streamlit Web UI 的主应用程序文件。
• evaluation/：用于评估和测试的文件。
• example_reports/：示例报告文件。
• scripts/：脚本文件，可能包括启动、配置或辅助脚本。
• tests/：测试代码和测试用例。
• DOCKER.md：Docker 容器使用的说明和命令。
• Dockerfile：构建 Docker 镜像的配置文件。
• LICENSE：项目使用的 AGPL-3.0 许可证。
• README.md：项目说明文件。
• VERIFIER_AND_MODEL_FINDINGS.md：验证者和模型发现的文档。
• docker-compose.yml：定义 Docker 服务和网络的配置文件。
• docker-entrypoint.sh：Docker 容器启动脚本。
• 其他文件和目录：如热图图像、日志处理脚本等。

2. 项目的启动文件介绍

项目可以通过两种主要方式启动：本地安装或 Docker 容器。

本地安装启动

1. 克隆仓库：

   git clone https://github.com/murtaza-nasir/maestro.git
   cd maestro
   

2. 设置虚拟环境（推荐）：

   python -m venv venv
   source venv/bin/activate
   

   Windows 用户使用 venv\Scripts\activate。

3. 安装依赖：

   pip install -r ai_researcher/requirements.txt
   

4. 配置环境变量：

   cp ai_researcher/.env.example ai_researcher/.env
   

   然后编辑 ai_researcher/.env 文件，添加您的 API 密钥和自定义设置。

5. 运行应用程序：

   python -m streamlit run ai_researcher/ui/app.py
   

   这将启动 Streamlit Web 界面，可以通过 http://localhost:8501 访问。

Docker 容器启动

1. 克隆仓库：

   git clone https://github.com/murtaza-nasir/maestro.git
   cd maestro
   

2. 配置环境变量：

   cp ai_researcher/.env.example ai_researcher/.env
   

   然后编辑 ai_researcher/.env 文件，添加您的 API 密钥和自定义设置。

3. 构建 Docker 镜像：

   docker compose build -t maestro
   

4. 运行 Docker 容器：

   docker compose up
   

   这将启动 Streamlit Web 界面，可以通过 http://localhost:8501 访问。

3. 项目的配置文件介绍

MAESTRO 项目的配置主要通过 ai_researcher/.env 文件进行。以下是一些主要的配置选项：

• LLM Providers：选择不同的语言模型提供者（如 openrouter 或 local）。
• Web Search：选择网络搜索提供者（如 tavily 或 linkup）。
• API Keys：根据所选提供者提供相应的 API 密钥。
• Local LLM Setup：如果使用本地语言模型，需要设置基础 URL 和模型 ID。
• OpenRouter：如果使用 OpenRouter，指定模型 ID 并提供 API 密钥。
• Connection Settings：自定义 LLM 调用的最大重试次数、重试延迟和请求超时时间。
• Web Search Configuration：设置网络搜索提供者、API 密钥、每次调用成本和缓存过期时间。
• Research Process Parameters：微调代理研究工作流程的各种参数，如迭代次数、研究深度、思想板上下文限制等。

通过编辑 .env 文件，您可以自定义 MAESTRO 的行为以满足您的研究需求。