首页
/ AutoSurveyGPT 使用指南

AutoSurveyGPT 使用指南

2024-09-12 04:49:43作者:凤尚柏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库,并且理解如何构建你的搜索查询和配置文件以引导系统找到相关的学术文献。在实际操作过程中,遵循提供的步骤和示例输入文件格式是关键。

热门项目推荐
相关项目推荐

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
33
24
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
828
0
redis-sdkredis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
376
32
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.92 K
19.09 K
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.62 K
1.45 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
19
2
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
9
1
Yi-CoderYi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
57
7
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
147
26
markdown4cjmarkdown4cj
一个markdown解析和展示的库
Cangjie
10
1