binary-husky commited on
Commit
5500fbe
1 Parent(s): 5a83b3b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +2 -91
README.md CHANGED
@@ -45,7 +45,6 @@ chat分析报告生成 | [函数插件] 运行后自动生成总结汇报
45
  启动暗色gradio[主题](https://github.com/binary-husky/chatgpt_academic/issues/173) | 在浏览器url后面添加```/?__dark-theme=true```可以切换dark主题
46
  [多LLM模型](https://www.bilibili.com/video/BV1wT411p7yf)支持,[API2D](https://api2d.com/)接口支持 | 同时被GPT3.5、GPT4和[清华ChatGLM](https://github.com/THUDM/ChatGLM-6B)伺候的感觉一定会很不错吧?
47
  更多LLM模型接入 | 新加入Newbing测试接口(新必应AI)
48
- huggingface免科学上网[在线体验](https://huggingface.co/spaces/qingxu98/gpt-academic) | 登陆huggingface后复制[此空间](https://huggingface.co/spaces/qingxu98/gpt-academic)
49
  …… | ……
50
 
51
  </div>
@@ -82,9 +81,6 @@ huggingface免科学上网[在线体验](https://huggingface.co/spaces/qingxu98/
82
  <img src="https://user-images.githubusercontent.com/96192199/232537274-deca0563-7aa6-4b5d-94a2-b7c453c47794.png" width="700" >
83
  </div>
84
 
85
- 多种大语言模型混合调用[huggingface测试版](https://huggingface.co/spaces/qingxu98/academic-chatgpt-beta)(huggingface版不支持chatglm)
86
-
87
-
88
  ---
89
 
90
  ## 安装-方法1:直接运行 (Windows, Linux or MacOS)
@@ -97,12 +93,7 @@ cd chatgpt_academic
97
 
98
  2. 配置API_KEY和代理设置
99
 
100
- 在`config.py`中,配置 海外Proxy 和 OpenAI API KEY,说明如下
101
- ```
102
- 1. 如果你在国内,需要设置海外代理才能够顺利使用OpenAI API,设置方法请仔细阅读config.py(1.修改其中的USE_PROXY为True; 2.按照说明修改其中的proxies)。
103
- 2. 配置 OpenAI API KEY。支持任意数量的OpenAI的密钥和API2D的密钥共存/负载均衡,多个KEY用英文逗号分隔即可,例如输入 API_KEY="OpenAI密钥1,API2D密钥2,OpenAI密钥3,OpenAI密钥4"
104
- 3. 与代理网络有关的issue(网络超时、代理不起作用)汇总到 https://github.com/binary-husky/chatgpt_academic/issues/1
105
- ```
106
  (P.S. 程序运行时会优先检查是否存在名为`config_private.py`的私密配置文件,并用其中的配置覆盖`config.py`的同名配置。因此,如果您能理解我们的配置读取逻辑,我们强烈建议您在`config.py`旁边创建一个名为`config_private.py`的新配置文件,并把`config.py`中的配置转移(复制)到`config_private.py`中。`config_private.py`不受git管控,可以让您的隐私信息更加安全。)
107
 
108
 
@@ -130,14 +121,8 @@ python main.py
130
 
131
  5. 测试函数插件
132
  ```
133
- - 测试Python项目分析
134
- (选择1)input区域 输入 `./crazy_functions/test_project/python/dqn` , 然后点击 "解析整个Python项目"
135
- (选择2)展开文件上传区,将python文件/包含python文件的压缩包拖拽进去,在出现反馈提示后, 然后点击 "解析整个Python项目"
136
- - 测试自我代码解读(本项目自译解)
137
- 点击 "[多线程Demo] 解析此项目本身(源码自译解)"
138
  - 测试函数插件模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能
139
  点击 "[函数插件模板Demo] 历史上的今天"
140
- - 函数插件区下拉菜单中有更多功能可供选择
141
  ```
142
 
143
  ## 安装-方法2:使用Docker
@@ -171,7 +156,6 @@ docker run --rm -it --net=host --gpus=all gpt-academic
171
  docker run --rm -it --net=host --gpus=all gpt-academic bash
172
  ```
173
 
174
-
175
  ## 安装-方法3:其他部署方式(需要云服务器知识与经验)
176
 
177
  1. 远程云服务器部署
@@ -183,14 +167,6 @@ docker run --rm -it --net=host --gpus=all gpt-academic bash
183
  3. 如何在二级网址(如`http://localhost/subpath`)下运行
184
  请访问[FastAPI运行说明](docs/WithFastapi.md)
185
 
186
- ## 安装-代理配置
187
- 1. 常规方法
188
- [配置代理](https://github.com/binary-husky/chatgpt_academic/issues/1)
189
-
190
- 2. 纯新手教程
191
- [纯新手教程](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)
192
-
193
-
194
  ---
195
 
196
  ## 自定义新的便捷按钮 / 自定义函数插件
@@ -218,73 +194,8 @@ docker run --rm -it --net=host --gpus=all gpt-academic bash
218
  详情请参考[函数插件指南](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)。
219
 
220
 
221
- ---
222
-
223
-
224
- ## 部分功能展示
225
-
226
- 1. 图片显示:
227
-
228
- <div align="center">
229
- <img src="https://user-images.githubusercontent.com/96192199/228737599-bf0a9d9c-1808-4f43-ae15-dfcc7af0f295.png" width="800" >
230
- </div>
231
-
232
- 2. 本项目的代码自译解(如果一个程序能够读懂并剖析自己):
233
-
234
- <div align="center">
235
- <img src="https://user-images.githubusercontent.com/96192199/226936850-c77d7183-0749-4c1c-9875-fd4891842d0c.png" width="800" >
236
- </div>
237
-
238
- <div align="center">
239
- <img src="https://user-images.githubusercontent.com/96192199/226936618-9b487e4b-ab5b-4b6e-84c6-16942102e917.png" width="800" >
240
- </div>
241
-
242
- 3. 其他任意Python/Cpp/Java/Go/Rect/...项目剖析:
243
- <div align="center">
244
- <img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="800" >
245
- </div>
246
-
247
- <div align="center">
248
- <img src="https://user-images.githubusercontent.com/96192199/226969067-968a27c1-1b9c-486b-8b81-ab2de8d3f88a.png" width="800" >
249
- </div>
250
-
251
- 4. Latex论文一键阅读理解与摘要生成
252
- <div align="center">
253
- <img src="https://user-images.githubusercontent.com/96192199/227504406-86ab97cd-f208-41c3-8e4a-7000e51cf980.png" width="800" >
254
- </div>
255
-
256
- 5. 自动报告生成
257
- <div align="center">
258
- <img src="https://user-images.githubusercontent.com/96192199/227503770-fe29ce2c-53fd-47b0-b0ff-93805f0c2ff4.png" height="300" >
259
- <img src="https://user-images.githubusercontent.com/96192199/227504617-7a497bb3-0a2a-4b50-9a8a-95ae60ea7afd.png" height="300" >
260
- <img src="https://user-images.githubusercontent.com/96192199/227504005-efeaefe0-b687-49d0-bf95-2d7b7e66c348.png" height="300" >
261
- </div>
262
-
263
- 6. 模块化功能设计
264
- <div align="center">
265
- <img src="https://user-images.githubusercontent.com/96192199/229288270-093643c1-0018-487a-81e6-1d7809b6e90f.png" height="400" >
266
- <img src="https://user-images.githubusercontent.com/96192199/227504931-19955f78-45cd-4d1c-adac-e71e50957915.png" height="400" >
267
- </div>
268
-
269
-
270
- 7. 源代码转译英文
271
-
272
- <div align="center">
273
- <img src="https://user-images.githubusercontent.com/96192199/229720562-fe6c3508-6142-4635-a83d-21eb3669baee.png" height="400" >
274
- </div>
275
-
276
- 8. 互联网在线信息综合
277
-
278
- <div align="center">
279
- <img src="https://user-images.githubusercontent.com/96192199/233575247-fb00819e-6d1b-4bb7-bd54-1d7528f03dd9.png" width="800" >
280
- <img src="https://user-images.githubusercontent.com/96192199/233779501-5ce826f0-6cca-4d59-9e5f-b4eacb8cc15f.png" width="800" >
281
-
282
- </div>
283
-
284
-
285
 
286
- ## Todo 与 版本规划:
287
- - version 3.3+ (todo): NewBing支持
288
  - version 3.2: 函数插件支持更多参数接口 (保存对话功能, 解读任意语言代码+同时询问任意的LLM组合)
289
  - version 3.1: 支持同时问询多个gpt模型!支持api2d,支持多个apikey负载均衡
290
  - version 3.0: 对chatglm和其他小型llm的支持
 
45
  启动暗色gradio[主题](https://github.com/binary-husky/chatgpt_academic/issues/173) | 在浏览器url后面添加```/?__dark-theme=true```可以切换dark主题
46
  [多LLM模型](https://www.bilibili.com/video/BV1wT411p7yf)支持,[API2D](https://api2d.com/)接口支持 | 同时被GPT3.5、GPT4和[清华ChatGLM](https://github.com/THUDM/ChatGLM-6B)伺候的感觉一定会很不错吧?
47
  更多LLM模型接入 | 新加入Newbing测试接口(新必应AI)
 
48
  …… | ……
49
 
50
  </div>
 
81
  <img src="https://user-images.githubusercontent.com/96192199/232537274-deca0563-7aa6-4b5d-94a2-b7c453c47794.png" width="700" >
82
  </div>
83
 
 
 
 
84
  ---
85
 
86
  ## 安装-方法1:直接运行 (Windows, Linux or MacOS)
 
93
 
94
  2. 配置API_KEY和代理设置
95
 
96
+ 在`config.py`中,配置 Proxy 和 OpenAI API KEY,说明如下
 
 
 
 
 
97
  (P.S. 程序运行时会优先检查是否存在名为`config_private.py`的私密配置文件,并用其中的配置覆盖`config.py`的同名配置。因此,如果您能理解我们的配置读取逻辑,我们强烈建议您在`config.py`旁边创建一个名为`config_private.py`的新配置文件,并把`config.py`中的配置转移(复制)到`config_private.py`中。`config_private.py`不受git管控,可以让您的隐私信息更加安全。)
98
 
99
 
 
121
 
122
  5. 测试函数插件
123
  ```
 
 
 
 
 
124
  - 测试函数插件模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能
125
  点击 "[函数插件模板Demo] 历史上的今天"
 
126
  ```
127
 
128
  ## 安装-方法2:使用Docker
 
156
  docker run --rm -it --net=host --gpus=all gpt-academic bash
157
  ```
158
 
 
159
  ## 安装-方法3:其他部署方式(需要云服务器知识与经验)
160
 
161
  1. 远程云服务器部署
 
167
  3. 如何在二级网址(如`http://localhost/subpath`)下运行
168
  请访问[FastAPI运行说明](docs/WithFastapi.md)
169
 
 
 
 
 
 
 
 
 
170
  ---
171
 
172
  ## 自定义新的便捷按钮 / 自定义函数插件
 
194
  详情请参考[函数插件指南](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)。
195
 
196
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
197
 
198
+ ## 版本:
 
199
  - version 3.2: 函数插件支持更多参数接口 (保存对话功能, 解读任意语言代码+同时询问任意的LLM组合)
200
  - version 3.1: 支持同时问询多个gpt模型!支持api2d,支持多个apikey负载均衡
201
  - version 3.0: 对chatglm和其他小型llm的支持