diff --git a/README.md b/README.md index 4d2f79d..a97026e 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ If you like this project, please give it a Star. If you've come up with more use 一键代码解释 | 可以正确显示代码、解释代码 [自定义快捷键](https://www.bilibili.com/video/BV14s4y1E7jN) | 支持自定义快捷键 [配置代理服务器](https://www.bilibili.com/video/BV1rc411W7Dr) | 支持配置代理服务器 -模块化设计 | 支持自定义高阶的实验性功能与[函数插件],插件支持[热更新](https://github.com/binary-husky/chatgpt_academic/wiki/%E5%87%BD%E6%95%B0%E6%8F%92%E4%BB%B6%E6%8C%87%E5%8D%97) +模块化设计 | 支持自定义高阶的函数插件与[函数插件],插件支持[热更新](https://github.com/binary-husky/chatgpt_academic/wiki/%E5%87%BD%E6%95%B0%E6%8F%92%E4%BB%B6%E6%8C%87%E5%8D%97) [自我程序剖析](https://www.bilibili.com/video/BV1cj411A7VW) | [函数插件] [一键读懂](https://github.com/binary-husky/chatgpt_academic/wiki/chatgpt-academic%E9%A1%B9%E7%9B%AE%E8%87%AA%E8%AF%91%E8%A7%A3%E6%8A%A5%E5%91%8A)本项目的源代码 [程序剖析](https://www.bilibili.com/video/BV1cj411A7VW) | [函数插件] 一键可以剖析其他Python/C/C++/Java/Lua/...项目树 读论文 | [函数插件] 一键解读latex论文全文并生成摘要 @@ -78,16 +78,17 @@ huggingface免科学上网[在线体验](https://huggingface.co/spaces/qingxu98/ v3.1的[huggingface测试版](https://huggingface.co/spaces/qingxu98/academic-chatgpt-beta)(huggingface版不支持chatglm) +--- -## 直接运行 (Windows, Linux or MacOS) +## 安装-方法1:直接运行 (Windows, Linux or MacOS) -### 1. 下载项目 +1. 下载项目 ```sh git clone https://github.com/binary-husky/chatgpt_academic.git cd chatgpt_academic ``` -### 2. 配置API_KEY和代理设置 +2. 配置API_KEY和代理设置 在`config.py`中,配置 海外Proxy 和 OpenAI API KEY,说明如下 ``` @@ -98,7 +99,7 @@ cd chatgpt_academic (P.S. 程序运行时会优先检查是否存在名为`config_private.py`的私密配置文件,并用其中的配置覆盖`config.py`的同名配置。因此,如果您能理解我们的配置读取逻辑,我们强烈建议您在`config.py`旁边创建一个名为`config_private.py`的新配置文件,并把`config.py`中的配置转移(复制)到`config_private.py`中。`config_private.py`不受git管控,可以让您的隐私信息更加安全。) -### 3. 安装依赖 +3. 安装依赖 ```sh # (选择一)推荐 python -m pip install -r requirements.txt @@ -112,27 +113,30 @@ python -m pip install -r requirements.txt # python -m pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/ ``` -### 4. 运行 +如果需要支持清华ChatGLM,需要额外安装更多依赖(不熟悉python者、电脑配置不佳者,建议不要尝试): +```sh +python -m pip install -r request_llm/requirements_chatglm.txt +``` + +4. 运行 ```sh python main.py ``` -### 5. 测试实验性功能 +5. 测试函数插件 ``` -- 测试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输入项目根路径)" + input区域 输入 `./crazy_functions/test_project/python/dqn` , 然后点击 "解析整个Python项目" - 测试自我代码解读 - 点击 "[实验] 请解析并解构此项目本身" + 点击 "[多线程Demo] 解析此项目本身(源码自译解)" - 测试实验功能模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能 - 点击 "[实验] 实验功能函数模板" + 点击 "[函数插件模板Demo] 历史上的今天" +- 函数插件区下拉菜单中有更多功能可供选择 ``` -## 使用docker (Linux) +## 安装-方法2:使用docker (Linux) +1. 仅ChatGPT(推荐大多数人选择) ``` sh # 下载项目 git clone https://github.com/binary-husky/chatgpt_academic.git @@ -144,67 +148,70 @@ docker build -t gpt-academic . # 运行 docker run --rm -it --net=host gpt-academic -# 测试实验性功能 -## 测试自我代码解读 -点击 "[实验] 请解析并解构此项目本身" -## 测试实验功能模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能 -点击 "[实验] 实验功能函数模板" -##(请注意在docker中运行时,需要额外注意程序的文件访问权限问题) -## 测试C++项目头文件分析 -input区域 输入 ./crazy_functions/test_project/cpp/libJPG , 然后点击 "[实验] 解析整个C++项目(input输入项目根路径)" +# 测试函数插件 +## 测试函数插件模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能 +点击 "[函数插件模板Demo] 历史上的今天" ## 测试给Latex项目写摘要 -input区域 输入 ./crazy_functions/test_project/latex/attention , 然后点击 "[实验] 读tex论文写摘要(input输入项目根路径)" +input区域 输入 ./crazy_functions/test_project/latex/attention , 然后点击 "读Tex论文写摘要" ## 测试Python项目分析 -input区域 输入 ./crazy_functions/test_project/python/dqn , 然后点击 "[实验] 解析整个py项目(input输入项目根路径)" +input区域 输入 ./crazy_functions/test_project/python/dqn , 然后点击 "解析整个Python项目" +函数插件区下拉菜单中有更多功能可供选择 ``` -## 其他部署方式 +2. ChatGPT+ChatGLM(需要对docker非常熟悉 + 电脑配置足够强) -- 远程云服务器部署 -请访问[部署wiki-2](https://github.com/binary-husky/chatgpt_academic/wiki/%E4%BA%91%E6%9C%8D%E5%8A%A1%E5%99%A8%E8%BF%9C%E7%A8%8B%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97) +``` sh +# 修改dockerfile +cd docs && nano Dockerfile+ChatGLM +# How to build | 如何构建 (Dockerfile+ChatGLM在docs路径下,请先cd docs) +docker build -t gpt-academic --network=host -f Dockerfile+ChatGLM . +# How to run | 如何运行 (1) 直接运行: +docker run --rm -it --net=host --gpus=all gpt-academic +# How to run | 如何运行 (2) 我想运行之前进容器做一些调整: +docker run --rm -it --net=host --gpus=all gpt-academic bash +``` -- 使用WSL2(Windows Subsystem for Linux 子系统) -请访问[部署wiki-1](https://github.com/binary-husky/chatgpt_academic/wiki/%E4%BD%BF%E7%94%A8WSL2%EF%BC%88Windows-Subsystem-for-Linux-%E5%AD%90%E7%B3%BB%E7%BB%9F%EF%BC%89%E9%83%A8%E7%BD%B2) + +## 安装-方法3:其他部署方式 + +1. 远程云服务器部署 +请访问[部署wiki-1](https://github.com/binary-husky/chatgpt_academic/wiki/%E4%BA%91%E6%9C%8D%E5%8A%A1%E5%99%A8%E8%BF%9C%E7%A8%8B%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97) + +2. 使用WSL2(Windows Subsystem for Linux 子系统) +请访问[部署wiki-2](https://github.com/binary-husky/chatgpt_academic/wiki/%E4%BD%BF%E7%94%A8WSL2%EF%BC%88Windows-Subsystem-for-Linux-%E5%AD%90%E7%B3%BB%E7%BB%9F%EF%BC%89%E9%83%A8%E7%BD%B2) + + +## 安装-代理配置 +### 方法一:常规方法 +[配置代理](https://github.com/binary-husky/chatgpt_academic/issues/1) + +### 方法二:纯新手教程 +[纯新手教程](https://github.com/binary-husky/chatgpt_academic/wiki/%E4%BB%A3%E7%90%86%E8%BD%AF%E4%BB%B6%E9%97%AE%E9%A2%98%E7%9A%84%E6%96%B0%E6%89%8B%E8%A7%A3%E5%86%B3%E6%96%B9%E6%B3%95%EF%BC%88%E6%96%B9%E6%B3%95%E5%8F%AA%E9%80%82%E7%94%A8%E4%BA%8E%E6%96%B0%E6%89%8B%EF%BC%89) + + +--- ## 自定义新的便捷按钮(学术快捷键自定义) 任意文本编辑器打开`core_functional.py`,添加条目如下,然后重启程序即可。(如果按钮已经添加成功并可见,那么前缀、后缀都支持热修改,无需重启程序即可生效。) 例如 ``` "超级英译中": { - # 前缀,会被加在你的输入之前。例如,用来描述你的要求,例如翻译、解释代码、润色等等 "Prefix": "请翻译把下面一段内容成中文,然后用一个markdown表格逐一解释文中出现的专有名词:\n\n", # 后缀,会被加在你的输入之后。例如,配合前缀可以把你的输入内容用引号圈起来。 "Suffix": "", - }, ```