From 11c641748f12196b5b95b0f049e97eaecfcd1025 Mon Sep 17 00:00:00 2001 From: Shengjiang Quan Date: Wed, 29 Mar 2023 22:36:15 +0900 Subject: [PATCH 1/7] readme: update Re-format a part of the markdown content and add conda instruction for installation. Signed-off-by: Shengjiang Quan --- README.md | 77 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 55 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d894348..dacf645 100644 --- a/README.md +++ b/README.md @@ -71,33 +71,66 @@ 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) From ad75886941ff27f1cb08d6d92ee5d6fc013a7baf Mon Sep 17 00:00:00 2001 From: binary-husky <96192199+binary-husky@users.noreply.github.com> Date: Wed, 29 Mar 2023 23:44:01 +0800 Subject: [PATCH 2/7] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index dacf645..fcac57d 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,9 @@ https://github.com/polarwinkel/mdtex2html 项目使用OpenAI的gpt-3.5-turbo模型，期待gpt-4早点放宽门槛😂 ``` +> **Note** +> 请注意只有“红颜色”标识的插件函数才支持文件/文件路径作为输入参数。目前暂不支持直接读取word和pdf（相关函数插件效果尚不理想）。 +
功能 | 描述 From e4b352394744d8b7624db55ea08de181307531b0 Mon Sep 17 00:00:00 2001 From: binary-husky <96192199+binary-husky@users.noreply.github.com> Date: Wed, 29 Mar 2023 23:44:37 +0800 Subject: [PATCH 3/7] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fcac57d..2b5dac9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +> **Note** +> 请注意只有“红颜色”标识的函数插件才支持文件/文件路径作为输入参数。目前暂不支持直接读取word和pdf（相关函数插件效果尚不理想）。 + + # ChatGPT 学术优化 **如果喜欢这个项目，请给它一个Star；如果你发明了更好用的学术快捷键，欢迎发issue或者pull requests** @@ -16,9 +20,6 @@ https://github.com/polarwinkel/mdtex2html 项目使用OpenAI的gpt-3.5-turbo模型，期待gpt-4早点放宽门槛😂 ``` -> **Note** -> 请注意只有“红颜色”标识的插件函数才支持文件/文件路径作为输入参数。目前暂不支持直接读取word和pdf（相关函数插件效果尚不理想）。 -
功能 | 描述 From d6e4fc27ada63eaaf7a731d116012d316db2c806 Mon Sep 17 00:00:00 2001 From: binary-husky <96192199+binary-husky@users.noreply.github.com> Date: Wed, 29 Mar 2023 23:48:58 +0800 Subject: [PATCH 4/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b5dac9..2a90feb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ > **Note** -> 请注意只有“红颜色”标识的函数插件才支持文件/文件路径作为输入参数。目前暂不支持直接读取word和pdf（相关函数插件效果尚不理想）。 +> 请注意只有“红颜色”标识的函数插件（按钮）才支持读取文件。目前暂不能完善地支持pdf和word格式文献的翻译解读。 # ChatGPT 学术优化 From 9598029620935acfc4bb8f7f87ca2f565ce30777 Mon Sep 17 00:00:00 2001 From: binary-husky <96192199+binary-husky@users.noreply.github.com> Date: Wed, 29 Mar 2023 23:50:20 +0800 Subject: [PATCH 5/7] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a90feb..0990ff4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -> **Note** -> 请注意只有“红颜色”标识的函数插件（按钮）才支持读取文件。目前暂不能完善地支持pdf和word格式文献的翻译解读。 # ChatGPT 学术优化 @@ -20,6 +18,10 @@ https://github.com/polarwinkel/mdtex2html 项目使用OpenAI的gpt-3.5-turbo模型，期待gpt-4早点放宽门槛😂 ``` +> **Note** +> 请注意只有“红颜色”标识的函数插件（按钮）才支持读取文件。目前暂不能完善地支持pdf格式文献的翻译解读，尚不支持word格式文件的读取。 + +
功能 | 描述 From bd4bf71c4b8cc99f332f9c7891cc9e2cd994e79a Mon Sep 17 00:00:00 2001 From: binary-husky <96192199+binary-husky@users.noreply.github.com> Date: Wed, 29 Mar 2023 23:53:33 +0800 Subject: [PATCH 6/7] Update README.md --- README.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0990ff4..0fe1ab6 100644 --- a/README.md +++ b/README.md @@ -93,10 +93,10 @@ 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 @@ -118,26 +118,18 @@ 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回答几个数的平方是什么），您可以根据此函数为模板，实现更复杂的功能 - +- 测试实验功能模板函数（要求gpt回答历史上的今天发生了什么），您可以根据此函数为模板，实现更复杂的功能 点击 "[实验] 实验功能函数模板" - +``` ## 使用docker (Linux) ``` sh @@ -154,7 +146,7 @@ docker run --rm -it --net=host gpt-academic # 测试实验性功能 ## 测试自我代码解读 点击 "[实验] 请解析并解构此项目本身" -## 测试实验功能模板函数（要求gpt回答几个数的平方是什么），您可以根据此函数为模板，实现更复杂的功能 +## 测试实验功能模板函数（要求gpt回答历史上的今天发生了什么），您可以根据此函数为模板，实现更复杂的功能 点击 "[实验] 实验功能函数模板" ##（请注意在docker中运行时，需要额外注意程序的文件访问权限问题） ## 测试C++项目头文件分析 From 3c5122b529705f73e7cf743405173e8da6a9387d Mon Sep 17 00:00:00 2001 From: binary-husky <96192199+binary-husky@users.noreply.github.com> Date: Thu, 30 Mar 2023 00:09:58 +0800 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fe1ab6..e5f96ec 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ chat分析报告生成 | [实验性功能] 运行后自动生成总结汇报 - 新界面
- +