binary-husky commited on
Commit
2b9261b
1 Parent(s): 4812513

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +35 -40
README.md CHANGED
@@ -91,9 +91,8 @@ cd chatgpt_academic
91
 
92
  在`config.py`中,配置 海外Proxy 和 OpenAI API KEY,说明如下
93
  ```
94
- 1. 如果你在国内,需要设置海外代理才能够顺利使用 OpenAI API,设置方法请仔细阅读config.py(1.修改其中的USE_PROXY为True; 2.按照说明修改其中的proxies)。
95
- 2. 配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY,在 config.py 文件里配置好即可。
96
- 3. 支持任意数量的OpenAI的密钥和API2D的密钥共存/负载均衡,多个KEY用英文逗号分隔即可,例如输入 API_KEY="OpenAI密钥1,API2D密钥2,OpenAI密钥3,OpenAI密钥4"
97
  3. 与代理网络有关的issue(网络超时、代理不起作用)汇总到 https://github.com/binary-husky/chatgpt_academic/issues/1
98
  ```
99
  (P.S. 程序运行时会优先检查是否存在名为`config_private.py`的私密配置文件,并用其中的配置覆盖`config.py`的同名配置。因此,如果您能理解我们的配置读取逻辑,我们强烈建议您在`config.py`旁边创建一个名为`config_private.py`的新配置文件,并把`config.py`中的配置转移(复制)到`config_private.py`中。`config_private.py`不受git管控,可以让您的隐私信息更加安全。)
@@ -101,19 +100,17 @@ cd chatgpt_academic
101
 
102
  3. 安装依赖
103
  ```sh
104
- # (选择一)推荐
105
- python -m pip install -r requirements.txt
106
-
107
- # (选择二)如果您使用anaconda,步骤也是类似的:
108
- # (选择二.1)conda create -n gptac_venv python=3.11
109
- # (选择二.2)conda activate gptac_venv
110
- # (选择二.3python -m pip install -r requirements.txt
111
-
112
- # 备注:使用官方pip源或者阿里pip源,其他pip源(如一些大学的pip)有可能出问题,临时换源方法:
113
- # python -m pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
114
  ```
115
 
116
- 如果需要支持清华ChatGLM,需要额外安装更多依赖(不熟悉python者、电脑配置不佳者,建议不要尝试):
117
  ```sh
118
  python -m pip install -r request_llm/requirements_chatglm.txt
119
  ```
@@ -134,7 +131,7 @@ python main.py
134
  - 函数插件区下拉菜单中有更多功能可供选择
135
  ```
136
 
137
- ## 安装-方法2:使用docker (Linux)
138
 
139
  1. 仅ChatGPT(推荐大多数人选择)
140
  ``` sh
@@ -147,33 +144,23 @@ cd chatgpt_academic
147
  docker build -t gpt-academic .
148
  # 运行
149
  docker run --rm -it --net=host gpt-academic
150
-
151
- # 测试函数插件
152
- ## 测试函数插件模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能
153
- 点击 "[函数插件模板Demo] 历史上的今天"
154
- ## 测试给Latex项目写摘要
155
- input区域 输入 ./crazy_functions/test_project/latex/attention , 然后点击 "读Tex论文写摘要"
156
- ## 测试Python项目分析
157
- input区域 输入 ./crazy_functions/test_project/python/dqn , 然后点击 "解析整个Python项目"
158
-
159
- 函数插件区下拉菜单中有更多功能可供选择
160
  ```
161
 
162
- 2. ChatGPT+ChatGLM(需要对docker非常熟悉 + 电脑配置足够强)
163
 
164
  ``` sh
165
- # 修改dockerfile
166
  cd docs && nano Dockerfile+ChatGLM
167
- # How to build | 如何构建 (Dockerfile+ChatGLM在docs路径下,请先cd docs)
168
  docker build -t gpt-academic --network=host -f Dockerfile+ChatGLM .
169
- # How to run | 如何运行 (1) 直接运行:
170
  docker run --rm -it --net=host --gpus=all gpt-academic
171
- # How to run | 如何运行 (2) 我想运行之前进容器做一些调整:
172
  docker run --rm -it --net=host --gpus=all gpt-academic bash
173
  ```
174
 
175
 
176
- ## 安装-方法3:其他部署方式
177
 
178
  1. 远程云服务器部署
179
  请访问[部��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)
@@ -192,7 +179,9 @@ docker run --rm -it --net=host --gpus=all gpt-academic bash
192
 
193
  ---
194
 
195
- ## 自定义新的便捷按钮(学术快捷键自定义)
 
 
196
  任意文本编辑器打开`core_functional.py`,添加条目如下,然后重启程序即可。(如果按钮已经添加成功并可见,那么前缀、后缀都支持热修改,无需重启程序即可生效。)
197
  例如
198
  ```
@@ -208,19 +197,25 @@ docker run --rm -it --net=host --gpus=all gpt-academic bash
208
  <img src="https://user-images.githubusercontent.com/96192199/226899272-477c2134-ed71-4326-810c-29891fe4a508.png" width="500" >
209
  </div>
210
 
 
 
 
 
 
 
 
211
  ---
212
 
213
 
214
  ## 部分功能展示
215
 
216
- ### 图片显示:
217
 
218
  <div align="center">
219
  <img src="https://user-images.githubusercontent.com/96192199/228737599-bf0a9d9c-1808-4f43-ae15-dfcc7af0f295.png" width="800" >
220
  </div>
221
 
222
-
223
- ### 如果一个程序能够读懂并剖析自己:
224
 
225
  <div align="center">
226
  <img src="https://user-images.githubusercontent.com/96192199/226936850-c77d7183-0749-4c1c-9875-fd4891842d0c.png" width="800" >
@@ -230,7 +225,7 @@ docker run --rm -it --net=host --gpus=all gpt-academic bash
230
  <img src="https://user-images.githubusercontent.com/96192199/226936618-9b487e4b-ab5b-4b6e-84c6-16942102e917.png" width="800" >
231
  </div>
232
 
233
- ### 其他任意Python/Cpp项目剖析:
234
  <div align="center">
235
  <img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="800" >
236
  </div>
@@ -239,26 +234,26 @@ docker run --rm -it --net=host --gpus=all gpt-academic bash
239
  <img src="https://user-images.githubusercontent.com/96192199/226969067-968a27c1-1b9c-486b-8b81-ab2de8d3f88a.png" width="800" >
240
  </div>
241
 
242
- ### Latex论文一键阅读理解与摘要生成
243
  <div align="center">
244
  <img src="https://user-images.githubusercontent.com/96192199/227504406-86ab97cd-f208-41c3-8e4a-7000e51cf980.png" width="800" >
245
  </div>
246
 
247
- ### 自动报告生成
248
  <div align="center">
249
  <img src="https://user-images.githubusercontent.com/96192199/227503770-fe29ce2c-53fd-47b0-b0ff-93805f0c2ff4.png" height="300" >
250
  <img src="https://user-images.githubusercontent.com/96192199/227504617-7a497bb3-0a2a-4b50-9a8a-95ae60ea7afd.png" height="300" >
251
  <img src="https://user-images.githubusercontent.com/96192199/227504005-efeaefe0-b687-49d0-bf95-2d7b7e66c348.png" height="300" >
252
  </div>
253
 
254
- ### 模块化功能设计
255
  <div align="center">
256
  <img src="https://user-images.githubusercontent.com/96192199/229288270-093643c1-0018-487a-81e6-1d7809b6e90f.png" height="400" >
257
  <img src="https://user-images.githubusercontent.com/96192199/227504931-19955f78-45cd-4d1c-adac-e71e50957915.png" height="400" >
258
  </div>
259
 
260
 
261
- ### 源代码转译英文
262
 
263
  <div align="center">
264
  <img src="https://user-images.githubusercontent.com/96192199/229720562-fe6c3508-6142-4635-a83d-21eb3669baee.png" height="400" >
 
91
 
92
  在`config.py`中,配置 海外Proxy 和 OpenAI API KEY,说明如下
93
  ```
94
+ 1. 如果你在国内,需要设置海外代理才能够顺利使用OpenAI API,设置方法请仔细阅读config.py(1.修改其中的USE_PROXY为True; 2.按照说明修改其中的proxies)。
95
+ 2. 配置 OpenAI API KEY。支持任意数量的OpenAI的密钥和API2D的密钥共存/负载均衡,多个KEY用英文逗号分隔即可,例如输入 API_KEY="OpenAI密钥1,API2D密钥2,OpenAI密钥3,OpenAI密钥4"
 
96
  3. 与代理网络有关的issue(网络超时、代理不起作用)汇总到 https://github.com/binary-husky/chatgpt_academic/issues/1
97
  ```
98
  (P.S. 程序运行时会优先检查是否存在名为`config_private.py`的私密配置文件,并用其中的配置覆盖`config.py`的同名配置。因此,如果您能理解我们的配置读取逻辑,我们强烈建议您在`config.py`旁边创建一个名为`config_private.py`的新配置文件,并把`config.py`中的配置转移(复制)到`config_private.py`中。`config_private.py`不受git管控,可以让您的隐私信息更加安全。)
 
100
 
101
  3. 安装依赖
102
  ```sh
103
+ # (选择I: 如熟悉python)推荐
104
+ python -m pip install -r requirements.txt
105
+ # 备注:使用官方pip源或者阿里pip源,其他pip源(如一些大学的pip)有可能出问题,临时换源方法:python -m pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
106
+
107
+ # (选择II: 如不熟悉python)使用anaconda,步骤也是类似的:
108
+ # (II-1)conda create -n gptac_venv python=3.11
109
+ # (II-2conda activate gptac_venv
110
+ # (II-3)python -m pip install -r requirements.txt
 
 
111
  ```
112
 
113
+ 如果需要支持清华ChatGLM后端,需要额外安装更多依赖(不熟悉python、电脑配置不佳者,建议不要尝试):
114
  ```sh
115
  python -m pip install -r request_llm/requirements_chatglm.txt
116
  ```
 
131
  - 函数插件区下拉菜单中有更多功能可供选择
132
  ```
133
 
134
+ ## 安装-方法2:使用Docker (Linux)
135
 
136
  1. 仅ChatGPT(推荐大多数人选择)
137
  ``` sh
 
144
  docker build -t gpt-academic .
145
  # 运行
146
  docker run --rm -it --net=host gpt-academic
 
 
 
 
 
 
 
 
 
 
147
  ```
148
 
149
+ 2. ChatGPT+ChatGLM(需要对docker熟悉 + 读懂Dockerfile + 电脑配置够强)
150
 
151
  ``` sh
152
+ # 修改Dockerfile
153
  cd docs && nano Dockerfile+ChatGLM
154
+ # 构建 (Dockerfile+ChatGLM在docs路径下,请先cd docs)
155
  docker build -t gpt-academic --network=host -f Dockerfile+ChatGLM .
156
+ # 运行 (1) 直接运行:
157
  docker run --rm -it --net=host --gpus=all gpt-academic
158
+ # 运行 (2) 我想运行之前进容器做一些调整:
159
  docker run --rm -it --net=host --gpus=all gpt-academic bash
160
  ```
161
 
162
 
163
+ ## 安装-方法3:其他部署方式(需要云服务器知识与经验)
164
 
165
  1. 远程云服务器部署
166
  请访问[部��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)
 
179
 
180
  ---
181
 
182
+ ## 自定义新的便捷按钮 / 自定义函数插件
183
+
184
+ 1. 自定义新的便捷按钮(学术快捷键)
185
  任意文本编辑器打开`core_functional.py`,添加条目如下,然后重启程序即可。(如果按钮已经添加成功并可见,那么前缀、后缀都支持热修改,无需重启程序即可生效。)
186
  例如
187
  ```
 
197
  <img src="https://user-images.githubusercontent.com/96192199/226899272-477c2134-ed71-4326-810c-29891fe4a508.png" width="500" >
198
  </div>
199
 
200
+ 2. 自定义函数插件
201
+
202
+ 编写强大的函数插件来执行任何你想得到的和想不到的任务。
203
+ 本项目的插件编写、调试难度很低,只要您具备一定的python基础知识,就可以仿照我们提供的模板实现自己的插件功能。
204
+ 详情请参考[函数插件指南](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)
205
+
206
+
207
  ---
208
 
209
 
210
  ## 部分功能展示
211
 
212
+ 1. 图片显示:
213
 
214
  <div align="center">
215
  <img src="https://user-images.githubusercontent.com/96192199/228737599-bf0a9d9c-1808-4f43-ae15-dfcc7af0f295.png" width="800" >
216
  </div>
217
 
218
+ 2. 本项目的代码自译解(如果一个程序能够读懂并剖析自己):
 
219
 
220
  <div align="center">
221
  <img src="https://user-images.githubusercontent.com/96192199/226936850-c77d7183-0749-4c1c-9875-fd4891842d0c.png" width="800" >
 
225
  <img src="https://user-images.githubusercontent.com/96192199/226936618-9b487e4b-ab5b-4b6e-84c6-16942102e917.png" width="800" >
226
  </div>
227
 
228
+ 3. 其他任意Python/Cpp/Java/Go/Rect/...项目剖析:
229
  <div align="center">
230
  <img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="800" >
231
  </div>
 
234
  <img src="https://user-images.githubusercontent.com/96192199/226969067-968a27c1-1b9c-486b-8b81-ab2de8d3f88a.png" width="800" >
235
  </div>
236
 
237
+ 4. Latex论文一键阅读理解与摘要生成
238
  <div align="center">
239
  <img src="https://user-images.githubusercontent.com/96192199/227504406-86ab97cd-f208-41c3-8e4a-7000e51cf980.png" width="800" >
240
  </div>
241
 
242
+ 5. 自动报告生成
243
  <div align="center">
244
  <img src="https://user-images.githubusercontent.com/96192199/227503770-fe29ce2c-53fd-47b0-b0ff-93805f0c2ff4.png" height="300" >
245
  <img src="https://user-images.githubusercontent.com/96192199/227504617-7a497bb3-0a2a-4b50-9a8a-95ae60ea7afd.png" height="300" >
246
  <img src="https://user-images.githubusercontent.com/96192199/227504005-efeaefe0-b687-49d0-bf95-2d7b7e66c348.png" height="300" >
247
  </div>
248
 
249
+ 6. 模块化功能设计
250
  <div align="center">
251
  <img src="https://user-images.githubusercontent.com/96192199/229288270-093643c1-0018-487a-81e6-1d7809b6e90f.png" height="400" >
252
  <img src="https://user-images.githubusercontent.com/96192199/227504931-19955f78-45cd-4d1c-adac-e71e50957915.png" height="400" >
253
  </div>
254
 
255
 
256
+ 7. 源代码转译英文
257
 
258
  <div align="center">
259
  <img src="https://user-images.githubusercontent.com/96192199/229720562-fe6c3508-6142-4635-a83d-21eb3669baee.png" height="400" >