Spaces:
Sleeping
Sleeping
Keldos
commited on
Commit
·
3192272
1
Parent(s):
61c9796
doc: 更新部署到服务器相关说明
Browse files补充了quickstart作为简明安装指南
- README.md +20 -5
- readme/README_en.md +3 -3
- readme/README_ja.md +3 -3
README.md
CHANGED
@@ -50,16 +50,31 @@
|
|
50 |
- 使用System Prompt可以很有效地设定前提条件。
|
51 |
- 使用Prompt模板功能时,选择Prompt模板集合文件,然后从下拉菜单中选择想要的prompt。
|
52 |
- 如果回答不满意,可以使用 `重新生成`按钮再试一次
|
53 |
-
- 对于长对话,可以使用 `优化Tokens`按钮减少Tokens占用。
|
54 |
- 输入框支持换行,按 `shift enter`即可。
|
55 |
- 可以在输入框按上下箭头在输入历史之间切换
|
56 |
-
-
|
57 |
-
-
|
58 |
- 在Hugging Face上使用:建议在右上角 **复制Space** 再使用,这样App反应可能会快一点。
|
59 |
|
60 |
-
##
|
61 |
|
62 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
63 |
|
64 |
## 疑难杂症解决
|
65 |
|
|
|
50 |
- 使用System Prompt可以很有效地设定前提条件。
|
51 |
- 使用Prompt模板功能时,选择Prompt模板集合文件,然后从下拉菜单中选择想要的prompt。
|
52 |
- 如果回答不满意,可以使用 `重新生成`按钮再试一次
|
|
|
53 |
- 输入框支持换行,按 `shift enter`即可。
|
54 |
- 可以在输入框按上下箭头在输入历史之间切换
|
55 |
+
- 部署到服务器:在 `config.json` 中设置 `"server_name": "0.0.0.0", "server_port": <你的端口号>,`。
|
56 |
+
- 获取公共链接:在 `config.json` 中设置 `"share": true,`。注意程序必须在运行,才能通过公共链接访问。
|
57 |
- 在Hugging Face上使用:建议在右上角 **复制Space** 再使用,这样App反应可能会快一点。
|
58 |
|
59 |
+
## 快速上手
|
60 |
|
61 |
+
```shell
|
62 |
+
git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
|
63 |
+
cd ChuanhuChatGPT
|
64 |
+
pip install -r requirements.txt
|
65 |
+
```
|
66 |
+
|
67 |
+
在项目文件夹中复制一份 `config_example.json`,并将其重命名为 `config.json`,在其中填入 `API-Key` 等设置。
|
68 |
+
|
69 |
+
```shell
|
70 |
+
python ChuanhuChatbot.py
|
71 |
+
```
|
72 |
+
|
73 |
+
一个浏览器窗口将会自动打开,此时您将可以使用 **川虎Chat** 与ChatGPT或其他模型进行对话。
|
74 |
+
|
75 |
+
> **Note**
|
76 |
+
>
|
77 |
+
> 具体详尽的安装教程和使用教程请查看[本项目的wiki页面](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程)。
|
78 |
|
79 |
## 疑难杂症解决
|
80 |
|
readme/README_en.md
CHANGED
@@ -51,11 +51,11 @@
|
|
51 |
- To try again if the response is unsatisfactory, use `🔄 Regenerate` button.
|
52 |
- To start a new line in the input box, press <kbd>Shift</kbd> + <kbd>Enter</kbd> keys.
|
53 |
- To quickly switch between input history, press <kbd>↑</kbd> and <kbd>↓</kbd> key in the input box.
|
54 |
-
- To deploy the program onto a server,
|
55 |
-
- To get a public shared link,
|
56 |
- To use it in Hugging Face Spaces: It is recommended to **Duplicate Space** and run the program in your own Space for a faster and more secure experience.
|
57 |
|
58 |
-
##
|
59 |
|
60 |
```shell
|
61 |
git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
|
|
|
51 |
- To try again if the response is unsatisfactory, use `🔄 Regenerate` button.
|
52 |
- To start a new line in the input box, press <kbd>Shift</kbd> + <kbd>Enter</kbd> keys.
|
53 |
- To quickly switch between input history, press <kbd>↑</kbd> and <kbd>↓</kbd> key in the input box.
|
54 |
+
- To deploy the program onto a server, set `"server_name": "0.0.0.0", "server_port" <your port number>,` in `config.json`.
|
55 |
+
- To get a public shared link, set `"share": true,` in `config.json`. Please be noted that the program must be running in order to be accessed via a public link.
|
56 |
- To use it in Hugging Face Spaces: It is recommended to **Duplicate Space** and run the program in your own Space for a faster and more secure experience.
|
57 |
|
58 |
+
## Quickstart
|
59 |
|
60 |
```shell
|
61 |
git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
|
readme/README_ja.md
CHANGED
@@ -50,11 +50,11 @@
|
|
50 |
- プロンプトテンプレートを使用するには、プロンプトテンプレートコレクションを選択し、ドロップダウンメニューから特定のプロンプトを選択。回答が不十分な場合は、`🔄再生成`ボタンを使って再試行します。
|
51 |
- 入力ボックスで改行するには、<kbd>Shift</kbd> + <kbd>Enter</kbd>キーを押してください。
|
52 |
- 入力履歴を素早く切り替えるには、入力ボックスで <kbd>↑</kbd>と<kbd>↓</kbd>キーを押す。
|
53 |
-
-
|
54 |
-
-
|
55 |
- Hugging Face Spacesで使用する場合: より速く、より安全に利用するために、**Duplicate Space**を使用し、自分のスペースでプログラムを実行することをお勧めします。
|
56 |
|
57 |
-
##
|
58 |
|
59 |
```shell
|
60 |
git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
|
|
|
50 |
- プロンプトテンプレートを使用するには、プロンプトテンプレートコレクションを選択し、ドロップダウンメニューから特定のプロンプトを選択。回答が不十分な場合は、`🔄再生成`ボタンを使って再試行します。
|
51 |
- 入力ボックスで改行するには、<kbd>Shift</kbd> + <kbd>Enter</kbd>キーを押してください。
|
52 |
- 入力履歴を素早く切り替えるには、入力ボックスで <kbd>↑</kbd>と<kbd>↓</kbd>キーを押す。
|
53 |
+
- プログラムをサーバーに展開するには、`config.json` 内の `"server_name": "0.0.0.0", "server_port": <ポート番号>`を設定してください。
|
54 |
+
- 共有リンクを取得するには、 `config.json` 内の `"share": true` を設定してください。なお、公開リンクでアクセスするためには、プログラムが実行されている必要があることに注意してください。
|
55 |
- Hugging Face Spacesで使用する場合: より速く、より安全に利用するために、**Duplicate Space**を使用し、自分のスペースでプログラムを実行することをお勧めします。
|
56 |
|
57 |
+
## クイックスタート
|
58 |
|
59 |
```shell
|
60 |
git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
|