Spaces:
Sleeping
Sleeping
Keldos
Chuan Hu
commited on
Commit
•
5dcf6b8
1
Parent(s):
4779d2a
doc: 修改 README,更加小白友好 (#81)
Browse files* 修改了 README,应该没那么乱了
另外,其实troubleshooting可以放进wiki,而不是全放在readme里。另外好像有些也不需要用标题形式啊,不过之前是标题我还是用回标题了。
* Update README.md
---------
Co-authored-by: Chuan Hu <51039745+GaiZhenbiao@users.noreply.github.com>
README.md
CHANGED
@@ -50,86 +50,79 @@
|
|
50 |
|
51 |
## 安装方式
|
52 |
|
53 |
-
|
54 |
|
55 |
-
|
56 |
|
57 |
-
|
58 |
-
|
|
|
|
|
|
|
59 |
|
60 |
-
|
61 |
|
62 |
-
|
63 |
|
64 |
-
|
65 |
|
66 |
-
|
67 |
-
|
68 |
-
|
69 |
-
<details><summary>在代码中填入你的 OpenAI API 密钥</summary>
|
70 |
-
<p>
|
71 |
-
|
72 |
-
#### ……或者在代码中填入你的 OpenAI API 密钥
|
73 |
-
|
74 |
-
这样设置的密钥会成为默认密钥。在这里还可以选择是否在UI中隐藏密钥输入框。
|
75 |
-
|
76 |
-
<img width="525" alt="image" src="https://user-images.githubusercontent.com/51039745/223440375-d472de4b-aa7f-4eae-9170-6dc2ed9f5480.png">
|
77 |
-
|
78 |
-
</p>
|
79 |
-
</details>
|
80 |
-
|
81 |
-
### 直接安装
|
82 |
|
83 |
-
<details>
|
84 |
-
<
|
|
|
|
|
85 |
|
86 |
-
|
|
|
|
|
87 |
|
88 |
-
```
|
89 |
-
pip install -r requirements.txt
|
90 |
-
```
|
91 |
|
92 |
-
如果报错,试试
|
93 |
|
94 |
-
```
|
95 |
-
pip3 install -r requirements.txt
|
96 |
-
```
|
97 |
|
98 |
-
如果还是不行,请先[安装Python](https://www.runoob.com/python/python-install.html)。
|
99 |
|
100 |
-
如果下载慢,建议[配置清华源](https://mirrors.tuna.tsinghua.edu.cn/help/pypi/),或者科学上网。
|
101 |
|
102 |
-
|
103 |
|
104 |
-
```
|
105 |
-
python ChuanhuChatbot.py
|
106 |
-
```
|
107 |
|
108 |
-
如果报错,试试
|
109 |
|
110 |
-
```
|
111 |
-
python3 ChuanhuChatbot.py
|
112 |
-
```
|
113 |
|
114 |
-
如果还是不行,请先[安装Python](https://www.runoob.com/python/python-install.html)。
|
|
|
115 |
|
116 |
-
|
117 |
-
</details>
|
118 |
|
119 |
-
|
120 |
|
121 |
-
<details>
|
122 |
-
<p>
|
123 |
|
124 |
#### 拉取镜像
|
125 |
|
126 |
-
```
|
127 |
docker pull tuchuanhuhuhu/chuanhuchatgpt:latest
|
128 |
```
|
129 |
|
130 |
#### 运行
|
131 |
|
132 |
-
```
|
133 |
docker run -d --name chatgpt \
|
134 |
-e my_api_key="替换成API" \
|
135 |
-v ~/chatGPThistory:/app/history \
|
@@ -138,24 +131,21 @@ docker run -d --name chatgpt \
|
|
138 |
```
|
139 |
|
140 |
#### 查看运行状态
|
141 |
-
```
|
142 |
docker logs chatgpt
|
143 |
```
|
144 |
|
145 |
#### 也可修改脚本后手动构建镜像
|
146 |
|
147 |
-
```
|
148 |
docker build -t chuanhuchatgpt:latest .
|
149 |
```
|
150 |
-
|
151 |
-
</p>
|
152 |
</details>
|
153 |
|
154 |
|
155 |
## 部署相关
|
156 |
|
157 |
-
<details>
|
158 |
-
<p>
|
159 |
|
160 |
### 部署到公网服务器
|
161 |
|
@@ -212,32 +202,36 @@ map $http_upgrade $connection_upgrade {
|
|
212 |
}
|
213 |
```
|
214 |
|
215 |
-
</p>
|
216 |
</details>
|
217 |
|
218 |
## 疑难杂症解决
|
219 |
|
|
|
|
|
|
|
|
|
|
|
220 |
|
221 |
-
|
222 |
|
223 |
-
<details>
|
224 |
-
<p>
|
225 |
|
226 |
-
|
227 |
|
228 |
-
|
229 |
|
230 |
```
|
231 |
sudo yum install bzip2-devel
|
232 |
```
|
|
|
233 |
|
234 |
-
|
235 |
-
|
236 |
-
我是一只孤��� [#5](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/5):
|
237 |
|
238 |
-
如果有人也出现了`openai.error.APIConnectionError`提示的报错,那可能是`urllib3`的版本导致的。`urllib3`版本大于`1.25.11`,就会出现这个问题。
|
|
|
|
|
239 |
|
240 |
-
|
241 |
|
242 |
在终端或命令提示符中卸载`urllib3`
|
243 |
|
@@ -245,7 +239,7 @@ sudo yum install bzip2-devel
|
|
245 |
pip uninstall urllib3
|
246 |
```
|
247 |
|
248 |
-
|
249 |
|
250 |
```
|
251 |
pip install urllib3==1.25.11
|
@@ -253,38 +247,24 @@ pip install urllib3==1.25.11
|
|
253 |
|
254 |
参考自:
|
255 |
[解决OpenAI API 挂了代理还是连接不上的问题](https://zhuanlan.zhihu.com/p/611080662)
|
256 |
-
|
257 |
-
</p>
|
258 |
</details>
|
259 |
|
260 |
-
|
261 |
|
262 |
-
在ChuanhuChatbot.py中设置APIkey后验证出错,提示“发生了未知错误Orz”
|
263 |
-
|
264 |
-
### 重装 gradio
|
265 |
-
|
266 |
-
<details>
|
267 |
-
<p>
|
268 |
-
|
269 |
-
很多时候,这样就可以解决问题。
|
270 |
-
|
271 |
-
```
|
272 |
-
pip install gradio --upgrade --force-reinstall
|
273 |
-
```
|
274 |
|
275 |
-
|
276 |
</details>
|
277 |
|
278 |
-
|
279 |
-
|
280 |
-
<details>
|
281 |
-
<p>
|
282 |
|
283 |
-
|
284 |
-
|
285 |
-
|
286 |
-
|
287 |
-
```
|
|
|
|
|
288 |
|
289 |
请将`openai.com`加入你使用的代理App的代理规则。注意不要将`127.0.0.1`加入代理,否则会有下一个错误。
|
290 |
|
@@ -303,28 +283,22 @@ Surge:
|
|
303 |
DOMAIN,127.0.0.1,DIRECT
|
304 |
DOMAIN-SUFFIX,openai.com,你的代理规则
|
305 |
```
|
306 |
-
|
307 |
-
</p>
|
308 |
</details>
|
309 |
|
310 |
-
|
311 |
-
|
312 |
-
<details>
|
313 |
-
<p>
|
314 |
|
315 |
-
```
|
316 |
-
Something went wrong
|
317 |
-
Expecting value: 1ine 1 column 1 (char o)
|
318 |
-
```
|
319 |
|
320 |
出现这个错误的原因是`127.0.0.1`被代理了,导致网页无法和后端通信。请设置代理软件,将`127.0.0.1`加入直连。
|
321 |
-
|
322 |
-
</p>
|
323 |
</details>
|
324 |
|
325 |
-
|
326 |
|
327 |
`openai`这个依赖已经被移除了。请尝试下载最新版脚本。
|
|
|
328 |
|
329 |
## Starchart
|
330 |
|
|
|
50 |
|
51 |
## 安装方式
|
52 |
|
53 |
+
### 本地部署
|
54 |
|
55 |
+
1. **下载本项目**
|
56 |
|
57 |
+
```shell
|
58 |
+
git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
|
59 |
+
cd ChuanhuChatGPT
|
60 |
+
```
|
61 |
+
或者,点击网页右上角的 `Download ZIP`,下载并解压完成后进入文件夹,进入`终端`或`命令提示符`。
|
62 |
|
63 |
+
<img width="200" alt="downloadZIP" src="https://user-images.githubusercontent.com/23137268/223696317-b89d2c71-c74d-4c6d-8060-a21406cfb8c8.png">
|
64 |
|
65 |
+
2. **填写API密钥**
|
66 |
|
67 |
+
以下两种方法任选其一:
|
68 |
|
69 |
+
<details><summary>1. 在图形界面中填写你的API密钥</summary>
|
70 |
+
|
71 |
+
这样设置的密钥会在页面刷新后被清除。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
72 |
|
73 |
+
<img width="760" alt="image" src="https://user-images.githubusercontent.com/51039745/222873756-3858bb82-30b9-49bc-9019-36e378ee624d.png"></details>
|
74 |
+
<details><summary>2. 在直接代码中填入你的 OpenAI API 密钥</summary>
|
75 |
+
|
76 |
+
这样设置的密钥会成为默认密钥。在这里还可以选择是否在UI中隐藏密钥输入框。
|
77 |
|
78 |
+
<img width="525" alt="image" src="https://user-images.githubusercontent.com/51039745/223440375-d472de4b-aa7f-4eae-9170-6dc2ed9f5480.png"></details>
|
79 |
+
|
80 |
+
3. **安装依赖**
|
81 |
|
82 |
+
```shell
|
83 |
+
pip install -r requirements.txt
|
84 |
+
```
|
85 |
|
86 |
+
如果报错,试试
|
87 |
|
88 |
+
```shell
|
89 |
+
pip3 install -r requirements.txt
|
90 |
+
```
|
91 |
|
92 |
+
如果还是不行,请先[安装Python](https://www.runoob.com/python/python-install.html)。
|
93 |
|
94 |
+
如果下载慢,建议[配置清华源](https://mirrors.tuna.tsinghua.edu.cn/help/pypi/),或者科学上网。
|
95 |
|
96 |
+
4. **启动**
|
97 |
|
98 |
+
```shell
|
99 |
+
python ChuanhuChatbot.py
|
100 |
+
```
|
101 |
|
102 |
+
如果报错,试试
|
103 |
|
104 |
+
```shell
|
105 |
+
python3 ChuanhuChatbot.py
|
106 |
+
```
|
107 |
|
108 |
+
如果还是不行,请先[安装Python](https://www.runoob.com/python/python-install.html)。
|
109 |
+
<br />
|
110 |
|
111 |
+
如果一切顺利,现在,你应该已经可以在浏览器地址栏中输入 [`http://localhost:7860`](http://localhost:7860) 查看并使用 ChuanhuChatGPT 了。
|
|
|
112 |
|
113 |
+
**如果你在安装过程中碰到了问题,请先查看[疑难杂症解决](#疑难杂症解决)部分。**
|
114 |
|
115 |
+
<details><summary><h3>或者,使用Docker 运行</h3></summary>
|
|
|
116 |
|
117 |
#### 拉取镜像
|
118 |
|
119 |
+
```shell
|
120 |
docker pull tuchuanhuhuhu/chuanhuchatgpt:latest
|
121 |
```
|
122 |
|
123 |
#### 运行
|
124 |
|
125 |
+
```shell
|
126 |
docker run -d --name chatgpt \
|
127 |
-e my_api_key="替换成API" \
|
128 |
-v ~/chatGPThistory:/app/history \
|
|
|
131 |
```
|
132 |
|
133 |
#### 查看运行状态
|
134 |
+
```shell
|
135 |
docker logs chatgpt
|
136 |
```
|
137 |
|
138 |
#### 也可修改脚本后手动构建镜像
|
139 |
|
140 |
+
```shell
|
141 |
docker build -t chuanhuchatgpt:latest .
|
142 |
```
|
|
|
|
|
143 |
</details>
|
144 |
|
145 |
|
146 |
## 部署相关
|
147 |
|
148 |
+
<details><summary>如果需要在公网服务器部署本项目,可以查看。</summary>
|
|
|
149 |
|
150 |
### 部署到公网服务器
|
151 |
|
|
|
202 |
}
|
203 |
```
|
204 |
|
|
|
205 |
</details>
|
206 |
|
207 |
## 疑难杂症解决
|
208 |
|
209 |
+
首先,请尝试重装 gradio:
|
210 |
+
|
211 |
+
```
|
212 |
+
pip install gradio --upgrade --force-reinstall
|
213 |
+
```
|
214 |
|
215 |
+
很多时候,这样就可以解决问题。
|
216 |
|
217 |
+
<details><summary><h3><code>No module named '_bz2'</code></h3></summary>
|
|
|
218 |
|
219 |
+
> 部署在CentOS7.6,Python3.11.0上,最后报错ModuleNotFoundError: No module named '_bz2'
|
220 |
|
221 |
+
安装python前先下载 `bzip` 编译环境
|
222 |
|
223 |
```
|
224 |
sudo yum install bzip2-devel
|
225 |
```
|
226 |
+
</details>
|
227 |
|
228 |
+
<details><summary><h3><code>openai.error.APIConnectionError</code></h3></summary>
|
|
|
|
|
229 |
|
230 |
+
> 如果有人也出现了`openai.error.APIConnectionError`提示的报错,那可能是`urllib3`的版本导致的。`urllib3`版本大于`1.25.11`,就会出现这个问题。
|
231 |
+
>
|
232 |
+
> 解决方案是卸载`urllib3`然后重装至`1.25.11`版本再重新运行一遍就可以
|
233 |
|
234 |
+
参见:[#5](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/5)
|
235 |
|
236 |
在终端或命令提示符中卸载`urllib3`
|
237 |
|
|
|
239 |
pip uninstall urllib3
|
240 |
```
|
241 |
|
242 |
+
然后,通过使用指定版本号的`pip install`命令来安装所需的版本:
|
243 |
|
244 |
```
|
245 |
pip install urllib3==1.25.11
|
|
|
247 |
|
248 |
参考自:
|
249 |
[解决OpenAI API 挂了代理还是连接不上的问题](https://zhuanlan.zhihu.com/p/611080662)
|
|
|
|
|
250 |
</details>
|
251 |
|
252 |
+
<details><summary><h3>在 Python 文件里 设定 API Key 之后验证失败</h3></summary>
|
253 |
|
254 |
+
> 在ChuanhuChatbot.py中设置APIkey后验证出错,提示“发生了未知错误Orz”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
255 |
|
256 |
+
参见:[#26](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/26)
|
257 |
</details>
|
258 |
|
259 |
+
<details><summary><h3>一直等待/SSL Error</h3></summary>
|
|
|
|
|
|
|
260 |
|
261 |
+
> 更新脚本文件后,SSLError [#49](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/49)
|
262 |
+
>
|
263 |
+
> 跑起来之后,输入问题好像就没反应了,也没报错 [#25](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/25)
|
264 |
+
>
|
265 |
+
> ```
|
266 |
+
> requests.exceptions.SSLError: HTTPSConnectionPool(host='api.openai.com', port=443): Max retries exceeded with url: /v1/chat/completions (Caused by SSLError(SSLEOFError(8, 'EOF occurred in violation of protocol (_ssl.c:1129)')))
|
267 |
+
> ```
|
268 |
|
269 |
请将`openai.com`加入你使用的代理App的代理规则。注意不要将`127.0.0.1`加入代理,否则会有下一个错误。
|
270 |
|
|
|
283 |
DOMAIN,127.0.0.1,DIRECT
|
284 |
DOMAIN-SUFFIX,openai.com,你的代理规则
|
285 |
```
|
|
|
|
|
286 |
</details>
|
287 |
|
288 |
+
<details><summary><h3>网页提示错误 Something went wrong</h3></summary>
|
|
|
|
|
|
|
289 |
|
290 |
+
> ```
|
291 |
+
> Something went wrong
|
292 |
+
> Expecting value: 1ine 1 column 1 (char o)
|
293 |
+
> ```
|
294 |
|
295 |
出现这个错误的原因是`127.0.0.1`被代理了,导致网页无法和后端通信。请设置代理软件,将`127.0.0.1`加入直连。
|
|
|
|
|
296 |
</details>
|
297 |
|
298 |
+
<details><summary><h3><code>No matching distribution found for openai>=0.27.0</code></h3></summary>
|
299 |
|
300 |
`openai`这个依赖已经被移除了。请尝试下载最新版脚本。
|
301 |
+
</details>
|
302 |
|
303 |
## Starchart
|
304 |
|