storm

环境要求

• Python 3.11（README 源码安装示例使用 conda create -n storm python=3.11）
• OpenAI API Key（用于语言模型与 openai 类型的编码器）
• 可访问 GitHub、LLM 接口与检索服务的网络环境
• 可选：Conda（用于创建独立环境）
• 可选：Bing Search 或 You.com 检索 API Key（使用对应检索器时需要）

安装与启动步骤

1. 1安装 STORM 库

   最简单的方式：直接通过 pip 安装官方发布的 knowledge-storm 包，作为依赖在代码中调用。

   pip install knowledge-storm

   复制

2. 2克隆源码仓库

   若想修改 STORM 引擎行为，则克隆源码到本地并进入 storm 目录。

   git clone https://github.com/stanford-oval/storm.git
   cd storm

   复制

3. 3创建 Python 环境

   README 示例使用 Python 3.11，建议用 conda 建独立环境避免依赖冲突。

   conda create -n storm python=3.11
   conda activate storm

   复制

4. 4安装项目依赖

   在已激活的 storm 环境中安装 requirements.txt 列出的全部依赖包。

   pip install -r requirements.txt

   复制

5. 5写入 API 密钥

   在项目根目录新建 secrets.toml，填入语言模型与检索服务的密钥。

   # secrets.toml
   OPENAI_API_KEY="your_openai_api_key"
   BING_SEARCH_API_KEY="your_bing_search_api_key"
   ENCODER_API_TYPE="openai"

   复制

关键配置

如何确认成功

能成功 import knowledge_storm 并运行 examples 目录下的示例脚本、正常产出带引用的报告即安装成功。

常见问题

注意事项

• secrets.toml 含密钥，不要提交到公开仓库。
• STORM 与 Co-STORM 分别使用 STORMWikiRunner 和 CoStormRunner，参数不同请对应参考。
• runner.run 的 do_research、do_generate_outline、do_generate_article、do_polish_article 置 False 可复用已有结果。
• 调用 LLM 与检索服务会产生网络请求和费用，注意控制 top_k 等参数。