开源项目教程：Together Open Deep Research

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

Together Open Deep Research 项目旨在提供一个基于LLM（大型语言模型）的工作流，用于对复杂主题进行深入的研究。以下是项目的目录结构及其简要介绍：

• assets/：存放项目相关资源文件。
• benchmark/：包含性能测试相关的代码和数据。
• configs/：存放项目的配置文件。
• src/：项目的核心源代码目录。
• .gitignore：指定Git忽略的文件和目录。
• LICENSE：项目的开源许可证文件。
• README.md：项目的说明文档。
• config.env.dev：开发环境的配置文件。
• pyproject.toml：项目依赖和构建配置文件。
• requirements.txt：项目的依赖文件。
• uv.lock：依赖锁定文件。

2. 项目的启动文件介绍

项目的启动主要依赖于src/together_open_deep_research.py文件。以下是启动文件的基本介绍：

• together_open_deep_research.py：这是项目的主入口文件，它负责初始化配置、加载模型以及开始研究工作流。

启动项目时，可以通过以下命令运行：

python src/together_open_deep_research.py --config configs/open_deep_researcher_config.yaml

此外，还可以运行src/webapp.py来启动一个基于Gradio的Web应用，用于交互式地使用研究工具。

3. 项目的配置文件介绍

配置文件是项目运行时所需参数的重要来源。Together Open Deep Research 使用yaml格式的配置文件，位于configs/目录下。

• open_deep_researcher_config.yaml：这是默认的配置文件，它定义了研究工作流的参数，包括模型设置、API密钥、输出格式等。

在运行项目之前，你需要确保配置文件中的所有参数都是正确的，特别是API密钥等敏感信息。

以下是一个配置文件的示例片段：

model:
  name: "gpt-2"
  max_length: 1024

api_keys:
  together_api_key: "your_key_here"
  tively_api_key: "your_key_here"
  huggingface_token: "your_token_here"

output:
  write_pdf: false
  write_html: true
  write_podcast: false
  add_toc_image: true

确保在启动项目之前，你已经根据实际情况更新了配置文件中的信息。