diff --git a/README.md b/README.md index d894348..e5f96ec 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # ChatGPT 学术优化 **如果喜欢这个项目，请给它一个Star；如果你发明了更好用的学术快捷键，欢迎发issue或者pull requests** @@ -16,6 +18,10 @@ https://github.com/polarwinkel/mdtex2html 项目使用OpenAI的gpt-3.5-turbo模型，期待gpt-4早点放宽门槛😂 ``` +> **Note** +> 请注意只有“红颜色”标识的函数插件（按钮）才支持读取文件。目前暂不能完善地支持pdf格式文献的翻译解读，尚不支持word格式文件的读取。 + +
功能 | 描述 @@ -39,7 +45,7 @@ chat分析报告生成 | [实验性功能] 运行后自动生成总结汇报 - 新界面
- +
@@ -71,34 +77,59 @@ chat分析报告生成 | [实验性功能] 运行后自动生成总结汇报
-## 直接运行 (Windows or Linux or MacOS) +## 直接运行 (Windows, Linux or MacOS) -``` sh -# 下载项目 +下载项目 + +```sh git clone https://github.com/binary-husky/chatgpt_academic.git cd chatgpt_academic -# 在config.py中，配置 海外Proxy 和 OpenAI API KEY -- 1.如果你在国内，需要设置海外代理才能够使用 OpenAI API，你可以通过 config.py 文件来进行设置。 -- 2.配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY，在 config.py 文件里配置好即可。 -# 安装依赖 -python -m pip install -r requirements.txt -# 运行 -python main.py - -# 测试实验性功能 -## 测试C++项目头文件分析 -input区域 输入 ./crazy_functions/test_project/cpp/libJPG ， 然后点击 "[实验] 解析整个C++项目（input输入项目根路径）" -## 测试给Latex项目写摘要 -input区域 输入 ./crazy_functions/test_project/latex/attention ， 然后点击 "[实验] 读tex论文写摘要（input输入项目根路径）" -## 测试Python项目分析 -input区域 输入 ./crazy_functions/test_project/python/dqn ， 然后点击 "[实验] 解析整个py项目（input输入项目根路径）" -## 测试自我代码解读 -点击 "[实验] 请解析并解构此项目本身" -## 测试实验功能模板函数（要求gpt回答几个数的平方是什么），您可以根据此函数为模板，实现更复杂的功能 -点击 "[实验] 实验功能函数模板" ``` +我们建议将`config.py`复制为`config_private.py`并将后者用作个性化配置文件以避免`config.py`中的变更影响你的使用或不小心将包含你的OpenAI API KEY的`config.py`提交至本项目。 +```sh +cp config.py config_private.py +``` + +在`config_private.py`中，配置 海外Proxy 和 OpenAI API KEY +``` +1. 如果你在国内，需要设置海外代理才能够使用 OpenAI API，你可以通过 config.py 文件来进行设置。 +2. 配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY，在 config.py 文件里配置好即可。 +``` +安装依赖 + +```sh +python -m pip install -r requirements.txt +``` + +或者，如果你希望使用`conda` + +```sh +conda create -n gptac 'gradio>=3.23' requests +conda activate gptac +python3 -m pip install mdtex2html +``` + +运行 + +```sh +python main.py +``` + +测试实验性功能 +``` +- 测试C++项目头文件分析 + input区域 输入 `./crazy_functions/test_project/cpp/libJPG` ， 然后点击 "[实验] 解析整个C++项目（input输入项目根路径）" +- 测试给Latex项目写摘要 + input区域 输入 `./crazy_functions/test_project/latex/attention` ， 然后点击 "[实验] 读tex论文写摘要（input输入项目根路径）" +- 测试Python项目分析 + input区域 输入 `./crazy_functions/test_project/python/dqn` ， 然后点击 "[实验] 解析整个py项目（input输入项目根路径）" +- 测试自我代码解读 + 点击 "[实验] 请解析并解构此项目本身" +- 测试实验功能模板函数（要求gpt回答历史上的今天发生了什么），您可以根据此函数为模板，实现更复杂的功能 + 点击 "[实验] 实验功能函数模板" +``` ## 使用docker (Linux) ``` sh @@ -115,7 +146,7 @@ docker run --rm -it --net=host gpt-academic # 测试实验性功能 ## 测试自我代码解读 点击 "[实验] 请解析并解构此项目本身" -## 测试实验功能模板函数（要求gpt回答几个数的平方是什么），您可以根据此函数为模板，实现更复杂的功能 +## 测试实验功能模板函数（要求gpt回答历史上的今天发生了什么），您可以根据此函数为模板，实现更复杂的功能 点击 "[实验] 实验功能函数模板" ##（请注意在docker中运行时，需要额外注意程序的文件访问权限问题） ## 测试C++项目头文件分析