OpenResearcher 使用教程

OpenResearcher 使用教程

OpenResearcher OpenResearcher, an advanced Scientific Research Assistant 项目地址: https://gitcode.com/gh_mirrors/op/OpenResearcher

1. 项目目录结构及介绍

OpenResearcher项目的目录结构如下：

OpenResearcher/
├── connector/
│   ├── html_parsing.py
│   └── meta_elastic.py
├── data/
│   ├── 2401/
│   │   ├── 2401.00001/
│   │   │   └── doc.html
│   │   └── 2401.00002/
│   │       └── doc.html
│   └── 2402/
├── evaluation_data/
├── example_history/
├── images/
├── llm/
├── scripts/
├── service/
├── tool/
├── utils/
├── .gitignore
├── LICENSE
├── README.md
├── config.py
├── init.py
├── requirements.txt
└── ui_app.py

目录说明：

• connector/: 包含用于处理HTML数据并将其转换为向量的脚本。
• data/: 存储从arXiv下载的论文数据和元数据。
• evaluation_data/: 存储评估数据。
• example_history/: 存储示例历史数据。
• images/: 存储项目相关的图片文件。
• llm/: 存储语言模型相关的文件。
• scripts/: 包含项目运行时的脚本文件。
• service/: 存储服务相关的代码。
• tool/: 存储工具类代码。
• utils/: 存储一些工具函数和类。
• .gitignore: 指定git忽略的文件和目录。
• LICENSE: 项目的许可文件。
• README.md: 项目的说明文档。
• config.py: 项目的配置文件。
• init.py: 项目的初始化文件。
• requirements.txt: 项目依赖的Python包列表。
• ui_app.py: 项目的启动文件。

2. 项目的启动文件介绍

项目的启动文件是ui_app.py。这个文件用于启动OpenResearcher的系统界面。运行以下命令可以启动系统：

CUDA_VISIBLE_DEVICES=0 streamlit run ui_app.py

确保已经正确安装了所有依赖项，并且环境变量CUDA_VISIBLE_DEVICES已经设置好了，以便在GPU上运行。

3. 项目的配置文件介绍

项目的配置文件是config.py。这个文件包含了项目运行时需要的一些配置参数，例如API密钥、数据库连接信息等。

以下是一些示例配置：

openai_api_base_url = "https://api.deepseek.com/v1"
openai_api_key = "api key here"
bing_search_key = "api key here"
bing_search_end_point = "https://api.bing.microsoft.com/"

在开始运行项目之前，需要确保这些配置参数已经被正确填写。如果使用的是其他API服务或模型，也需要在这里进行相应的修改。

OpenResearcher OpenResearcher, an advanced Scientific Research Assistant 项目地址: https://gitcode.com/gh_mirrors/op/OpenResearcher