STORM 项目安装和配置指南
项目地址: https://gitcode.com/GitHub_Trending/sto/storm 1. 项目基础介绍和主要编程语言
项目介绍
STORM 是一个由斯坦福大学开发的 LLM（大型语言模型）驱动的知识管理与报告生成系统。它能够自动研究一个主题，并生成带有引用的完整报告。STORM 主要用于帮助用户在撰写文章前的研究阶段，生成文章的大纲和初稿。
主要编程语言
STORM 项目主要使用 Python 编程语言进行开发。
2. 项目使用的关键技术和框架
关键技术
- LLM（大型语言模型）：STORM 使用 LLM 进行文本生成和知识管理。
- Internet 搜索：系统通过互联网搜索收集参考资料。
- 多视角问题生成：STORM 通过模拟对话和多视角问题生成来提高问题的深度和广度。
框架
- Streamlit：用于构建用户界面的 Python 框架。
- dspy：用于实现系统的模块化设计。
3. 项目安装和配置的准备工作和详细安装步骤
准备工作
- Python 环境：确保你已经安装了 Python 3.11 或更高版本。
- Git：用于克隆项目代码库。
- API 密钥：如果你计划使用 OpenAI 或其他第三方服务，请准备好相应的 API 密钥。
详细安装步骤
步骤 1：克隆项目代码库
首先，使用 Git 克隆 STORM 项目的代码库到本地：
git clone https://github.com/stanford-oval/storm.git
cd storm
步骤 2：创建虚拟环境
建议在项目目录下创建一个虚拟环境，以隔离项目的依赖：
conda create -n storm python=3.11
conda activate storm
步骤 3：安装依赖包
在激活虚拟环境后，安装项目所需的依赖包：
pip install -r requirements.txt
步骤 4：配置 API 密钥
在项目根目录下创建一个名为 secrets.toml 的文件，并添加你的 API 密钥：
# Set up OpenAI API key
OPENAI_API_KEY="your_openai_api_key"
# If you are using the API service provided by Microsoft Azure, include the following lines:
OPENAI_API_TYPE="azure"
AZURE_API_BASE="your_azure_api_base_url"
AZURE_API_VERSION="your_azure_api_version"
# Set up You.com search API key
YDC_API_KEY="your_youcom_api_key"
步骤 5：运行示例脚本
项目提供了一个示例脚本，用于快速启动 STORM 并生成报告。你可以使用以下命令运行示例脚本：
python examples/run_storm_wiki_gpt.py \
--output-dir $OUTPUT_DIR \
--retriever you \
--do-research \
--do-generate-outline \
--do-generate-article \
--do-polish-article
注意事项
- API 密钥：确保你已经正确配置了所有需要的 API 密钥，否则系统可能无法正常工作。
- 虚拟环境：建议始终在虚拟环境中运行项目，以避免依赖冲突。
通过以上步骤，你应该能够成功安装并配置 STORM 项目，并开始使用它来生成知识管理和报告。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
