首页
/ AutoSurveyGPT 使用指南

AutoSurveyGPT 使用指南

2024-09-12 09:04:11作者:凤尚柏Louis

1. 项目目录结构及介绍

AutoSurveyGPT 是一个利用GPT-3.5 Turbo或GPT-4智能分析学术文献的开源工具,旨在自动化文献调研过程。下面是该仓库的主要目录结构及各部分功能简介:

  • main.py - 核心脚本,负责执行整个文献搜索、分析流程。
  • config.py - 配置文件,用于存放OpenAI API密钥等重要设置。
  • gpt_config.py - 控制GPT模型调用的相关配置,如选择GPT-3.5 Turbo还是GPT-4。
  • scholar_parser.py - 解析Google Scholar搜索结果的模块。
  • pdf_finder.py, pdf_processor.py - 用于查找和处理PDF文档的部分(开发中)。
  • query_generator.py, query_processor.py - 生成和处理查询请求的脚本。
  • output, input, logs - 存放输入数据、输出报告和日志的文件夹。
  • requirements.txt - Python依赖列表,确保环境兼容性。
  • LICENSE, README.md - 许可证信息和项目说明。

2. 项目启动文件介绍

主要启动文件: main.py

  • 运行此脚本之前,你需要准备好一个JSON格式的输入文件,它包含了搜索查询、相关主题描述以及其他配置选项。
  • 通过命令行运行时提供这个JSON文件的路径,如:python main.py -i path/to/your/input.json
  • 此脚本会基于用户的配置进行Google Scholar搜索,使用GPT进行论文的相关性和重要性评估,并生成报告。

3. 项目的配置文件介绍

配置文件: config.py, gpt_config.py

  • config.py 中需设置你的OpenAI API密钥 (openai_api_key),这是使用GPT服务的前提条件。

    openai_api_key = "your_openai_api_key"
    
  • gpt_config.py 决定了GPT模型的选择,默认使用GPT-3.5 Turbo,如果你想使用成本更高但更强大的GPT-4,你需要在这里更改调用的模型名称。

    model_engine = "gpt-3.5-turbo"  # 若要使用GPT-4,改为 "gpt-4"
    

为了正确使用AutoSurveyGPT,确保你已经安装了所有必要的Python库,并且理解如何构建你的搜索查询和配置文件以引导系统找到相关的学术文献。在实际操作过程中,遵循提供的步骤和示例输入文件格式是关键。

登录后查看全文
热门项目推荐

项目优选

收起
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
136
187
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
884
523
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
362
381
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
182
264
kernelkernel
deepin linux kernel
C
22
5
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.09 K
0
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
84
4
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
613
60
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
118
78