MZhao Keldos Tuchuanhuhuhu Sergey Pinus commited on
Commit
a8a34a0
1 Parent(s): aad9d90

doc: Update docs for ChuanhuChat v5.0 (#887)

Browse files

* doc: 更新功能和支持模型

* doc: 改进 Readme 内容

* doc: 调整大小

* 模型放到表格中

* 更新详情图片

* 订正一些小细节

* Preparation for v5.0

* Preparation for v5.0

* Preparation for v5.0(jp)

* Preparation for v5.0(ru)

* Remove unnecessary blank space

* Doc: Update Russian locales (#888)

* feat: Update russian localy

Add russian to search preset and The readme has been slightly rewritten for clarity

* Update README_ru.md

* 解决一部分日语翻译问题 | 一部分の日本語翻訳問題を解決する

* doc: use `<kbd>` tag for keyboard keys

fix: correct Chat History

---------

Co-authored-by: Keldos <hi@keldos.me>
Co-authored-by: Tuchuanhuhuhu <gzblog@hdu.edu.cn>
Co-authored-by: Sergey Pinus <57861007+bropines@users.noreply.github.com>

Files changed (5) hide show
  1. README.md +76 -24
  2. modules/presets.py +1 -0
  3. readme/README_en.md +82 -32
  4. readme/README_ja.md +73 -24
  5. readme/README_ru.md +71 -25
README.md CHANGED
@@ -22,9 +22,7 @@
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
- 流式传输 / 无限对话 / 保存对话 / 预设Prompt集 / 联网搜索 / 根据文件回答 <br />
26
- 渲染LaTeX / 渲染表格 / 代码高亮 / 自动亮暗色切换 / 自适应界面 / “小而美”的体验 <br />
27
- 自定义api-Host / 多参数可调 / 多API Key均衡负载 / 多用户显示 / 适配GPT-4 / 支持本地部署LLM
28
  </p>
29
  <a href="https://www.bilibili.com/video/BV1mo4y1r7eE"><strong>视频教程</strong></a>
30
  ·
@@ -42,38 +40,92 @@
42
  ## 目录
43
 
44
  | [支持模型](#支持模型) | [使用技巧](#使用技巧) | [安装方式](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程) | [常见问题](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/常见问题) | [给作者买可乐🥤](#捐款) |
45
- | ------------------ | ------------------ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------- |
46
 
47
- ## 支持模型
 
 
 
 
 
 
 
 
 
48
 
49
- **通过API调用的语言模型**:
50
 
51
- - [ChatGPT](https://chat.openai.com) ([GPT-4](https://openai.com/product/gpt-4))
52
- - [Google PaLM](https://developers.generativeai.google/products/palm)
53
- - [Inspur Yuan 1.0](https://air.inspur.com/home)
54
- - [MiniMax](https://api.minimax.chat/)
55
- - [XMChat](https://github.com/MILVLG/xmchat)
56
 
57
- **本地部署语言模型**:
58
 
59
- - [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B))
60
- - [LLaMA](https://github.com/facebookresearch/llama)
61
- - [StableLM](https://github.com/Stability-AI/StableLM)
62
- - [MOSS](https://github.com/OpenLMLab/MOSS)
 
 
 
 
 
 
 
 
 
 
 
63
 
64
  ## 使用技巧
65
 
66
- - 使用System Prompt可以很有效地设定前提条件。
67
- - 使用Prompt模板功能时,选择Prompt模板集合文件,然后从下拉菜单中选择想要的prompt。
68
- - 如果回答不满意,可以使用 `重新生成`按钮再试一次
69
- - 输入框支持换行,按 `shift enter`即可。
70
- - 可以在输入框按上下箭头在输入历史之间切换
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  - 部署到服务器:在 `config.json` 中设置 `"server_name": "0.0.0.0", "server_port": <你的端口号>,`。
72
  - 获取公共链接:在 `config.json` 中设置 `"share": true,`。注意程序必须在运行,才能通过公共链接访问。
73
  - 在Hugging Face上使用:建议在右上角 **复制Space** 再使用,这样App反应可能会快一点。
74
 
75
  ## 快速上手
76
 
 
 
77
  ```shell
78
  git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
79
  cd ChuanhuChatGPT
@@ -89,14 +141,14 @@ python ChuanhuChatbot.py
89
  一个浏览器窗口将会自动打开,此时您将可以使用 **川虎Chat** 与ChatGPT或其他模型进行对话。
90
 
91
  > **Note**
92
- >
93
  > 具体详尽的安装教程和使用教程请查看[本项目的wiki页面](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程)。
94
 
95
  ## 疑难杂症解决
96
 
97
- 在遇到各种问题查阅相关信息前,您可以先尝试手动拉取本项目的最新更改并更新依赖库,然后重试。步骤为:
98
 
99
- 1. 点击网页上的 `Download ZIP` 下载最新代码,或
100
  ```shell
101
  git pull https://github.com/GaiZhenbiao/ChuanhuChatGPT.git main -f
102
  ```
 
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
+ 支持 GPT-4 · 基于文件问答 · LLM本地部署 · 联网搜索 · Agent 助理 · 支持 Fine-tune
 
 
26
  </p>
27
  <a href="https://www.bilibili.com/video/BV1mo4y1r7eE"><strong>视频教程</strong></a>
28
  ·
 
40
  ## 目录
41
 
42
  | [支持模型](#支持模型) | [使用技巧](#使用技巧) | [安装方式](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程) | [常见问题](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/常见问题) | [给作者买可乐🥤](#捐款) |
43
+ | --- | --- | --- | --- | --- |
44
 
45
+ ## ✨ 5.0 重磅更新!
46
+
47
+ ![ChuanhuChat5更新](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/70903329/f2c2be3a-ea93-4edf-8221-94eddd4a0178)
48
+
49
+
50
+ <sup>New!</sup> 全新的用户界面!精致得不像 Gradio,甚至有毛玻璃效果!
51
+
52
+ <sup>New!</sup> 适配了移动端(包括全面屏手机的挖孔/刘海),层级更加清晰。
53
+
54
+ <sup>New!</sup> 历史记录移到左侧,使用更加方便。并且支持搜索(支持正则)、删除、重命名。
55
 
56
+ <sup>New!</sup> 现在可以让大模型自动命名历史记录(需在设置或配置文件中开启)。
57
 
58
+ <sup>New!</sup> 现在可以将 川虎Chat 作为 PWA 应用程序安装,体验更加原生!支持 Chrome/Edge/Safari 等浏览器。
 
 
 
 
59
 
60
+ <sup>New!</sup> 图标适配各个平台,看起来更舒服。
61
 
62
+ <sup>New!</sup> 支持 Finetune(微调) GPT 3.5!
63
+
64
+
65
+ ## 支持模型
66
+
67
+ | API 调用模型 | 备注 | 本地部署模型 | 备注 |
68
+ | :---: | --- | :---: | --- |
69
+ | [ChatGPT(GPT-4)](https://chat.openai.com) | 支持微调 gpt-3.5 | [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B)) |
70
+ | [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service) | | [LLaMA](https://github.com/facebookresearch/llama) | 支持 Lora 模型 
71
+ | [Google PaLM](https://developers.generativeai.google/products/palm) | 不支持流式传输 | [StableLM](https://github.com/Stability-AI/StableLM)
72
+ | [讯飞星火认知大模型](https://xinghuo.xfyun.cn) | | [MOSS](https://github.com/OpenLMLab/MOSS)
73
+ | [Inspur Yuan 1.0](https://air.inspur.com/home) | |
74
+ | [MiniMax](https://api.minimax.chat/) |
75
+ | [XMChat](https://github.com/MILVLG/xmchat) | 不支持流式传输
76
+ | [Midjourney](https://www.midjourney.com/) | 不支持流式传输
77
 
78
  ## 使用技巧
79
 
80
+ ### 💪 强力功能
81
+ - **川虎助理**:类似 AutoGPT,全自动解决你的问题;
82
+ - **在线搜索**:ChatGPT 的数据太旧?给 LLM 插上网络的翅膀;
83
+ - **知识库**:让 ChatGPT 帮你量子速读!根据文件回答问题。
84
+ - **本地部署LLM**:一键部署,获取属于你自己的大语言模型。
85
+
86
+ ### 🤖 System Prompt
87
+ - 通过 System Prompt 设定前提条件,可以很有效地进行角色扮演;
88
+ - 川虎Chat 预设了Prompt模板,点击`加载Prompt模板`,先选择 Prompt 模板集合,然后在下方选择想要的 Prompt。
89
+
90
+ ### 💬 基础对话
91
+ - 如果回答不满意,可以使用 `重新生成` 按钮再试一次,或者直接 `删除这轮对话`;
92
+ - 输入框支持换行,按 <kbd>Shift</kbd> + <kbd>Enter</kbd>即可;
93
+ - 在输入框按 <kbd>↑</kbd> <kbd>↓</kbd> 方向键,可以在发送记录中快速切换;
94
+ - 每次新建一个对话太麻烦,试试 `单论对话` 功能;
95
+ - 回答���泡旁边的小按钮,不仅能 `一键复制`,还能 `查看Markdown原文`;
96
+ - 指定回答语言,让 ChatGPT 固定以某种语言回答。
97
+
98
+ ### 📜 对话历史
99
+ - 对话历史记录会被自动保存,不用担心问完之后找不到了;
100
+ - 多用户历史记录隔离,除了你都看不到;
101
+ - 重命名历史记录,方便日后查找;
102
+ - <sup>New!</sup> 魔法般自动命名历史记录,让 LLM 理解对话内容,帮你自动为历史记录命名!
103
+ - <sup>New!</sup> 搜索历史记录,支持正则表达式!
104
+
105
+ ### 🖼️ 小而美的体验
106
+ - 自研 Small-and-Beautiful 主题,带给你小而美的体验;
107
+ - 自动亮暗色切换,给你从早到晚的舒适体验;
108
+ - 完美渲染 LaTeX / 表格 / 代码块,支持代码高亮;
109
+ - <sup>New!</sup> 非线性动画、毛玻璃效果,精致得不像 Gradio!
110
+ - <sup>New!</sup> 适配 Windows / macOS / Linux / iOS / Android,从图标到全面屏适配,给你最合适的体验!
111
+ - <sup>New!</sup> 支持以 PWA应用程序 安装,体验更加原生!
112
+
113
+ ### 👨‍💻 极客功能
114
+ - <sup>New!</sup> 支持 Fine-tune(微调)gpt-3.5!
115
+ - 大量 LLM 参数可调;
116
+ - 支持更换 api-host;
117
+ - 支持自定义代理;
118
+ - 支持多 api-key 负载均衡。
119
+
120
+ ### ⚒️ 部署相关
121
  - 部署到服务器:在 `config.json` 中设置 `"server_name": "0.0.0.0", "server_port": <你的端口号>,`。
122
  - 获取公共链接:在 `config.json` 中设置 `"share": true,`。注意程序必须在运行,才能通过公共链接访问。
123
  - 在Hugging Face上使用:建议在右上角 **复制Space** 再使用,这样App反应可能会快一点。
124
 
125
  ## 快速上手
126
 
127
+ 在终端执行以下命令:
128
+
129
  ```shell
130
  git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
131
  cd ChuanhuChatGPT
 
141
  一个浏览器窗口将会自动打开,此时您将可以使用 **川虎Chat** 与ChatGPT或其他模型进行对话。
142
 
143
  > **Note**
144
+ >
145
  > 具体详尽的安装教程和使用教程请查看[本项目的wiki页面](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程)。
146
 
147
  ## 疑难杂症解决
148
 
149
+ 在遇到各种问题查阅相关信息前,您可以先尝试 **手动拉取本项目的最新更改<sup>1</sup>** 并 **更新依赖库<sup>2</sup>**,然后重试。步骤为:
150
 
151
+ 1. 点击网页上的 `Download ZIP` 按钮,下载最新代码并解压覆盖,或
152
  ```shell
153
  git pull https://github.com/GaiZhenbiao/ChuanhuChatGPT.git main -f
154
  ```
modules/presets.py CHANGED
@@ -128,6 +128,7 @@ REPLY_LANGUAGES = [
128
  "日本語",
129
  "Español",
130
  "Français",
 
131
  "Deutsch",
132
  "한국어",
133
  "跟随问题语言(不稳定)"
 
128
  "日本語",
129
  "Español",
130
  "Français",
131
+ "Russian",
132
  "Deutsch",
133
  "한국어",
134
  "跟随问题语言(不稳定)"
readme/README_en.md CHANGED
@@ -22,11 +22,7 @@
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
- Streaming / Unlimited conversations / Save history / Preset prompts / Chat with files / Web search <br />
26
- LaTeX rendering / Table rendering / Code highlighting <br />
27
- Auto dark mode / Adaptive web interface / WeChat-like theme <br />
28
- Multi-parameters tuning / Multi-API-Key support / Multi-user support <br />
29
- Compatible with GPT-4 / Local deployment for LLMs
30
  </p>
31
  <a href="https://www.youtube.com/watch?v=MtxS4XZWbJE"><strong>Video Tutorial</strong></a>
32
  ·
@@ -43,35 +39,88 @@
43
 
44
  [![Video Title](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7.jpg)](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7?autoplay=1)
45
 
46
- ## Supported LLM Models
47
 
48
- **LLM models via API**:
49
 
50
- - [ChatGPT](https://chat.openai.com) ([GPT-4](https://openai.com/product/gpt-4))
51
- - [Google PaLM](https://developers.generativeai.google/products/palm)
52
- - [Inspur Yuan 1.0](https://air.inspur.com/home)
53
- - [MiniMax](https://api.minimax.chat/)
54
- - [XMChat](https://github.com/MILVLG/xmchat)
55
 
56
- **LLM models via local deployment**:
57
 
58
- - [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B))
59
- - [LLaMA](https://github.com/facebookresearch/llama)
60
- - [StableLM](https://github.com/Stability-AI/StableLM)
61
- - [MOSS](https://github.com/OpenLMLab/MOSS)
62
 
63
- ## Usage Tips
 
 
 
 
 
 
 
 
64
 
65
- - To better control the ChatGPT, use System Prompt.
66
- - To use a Prompt Template, select the Prompt Template Collection file first, and then choose certain prompt from the drop-down menu.
67
- - To try again if the response is unsatisfactory, use `🔄 Regenerate` button.
68
- - To start a new line in the input box, press <kbd>Shift</kbd> + <kbd>Enter</kbd> keys.
69
- - To quickly switch between input history, press <kbd>↑</kbd> and <kbd>↓</kbd> key in the input box.
70
- - To deploy the program onto a server, set `"server_name": "0.0.0.0", "server_port" <your port number>,` in `config.json`.
71
- - 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.
72
- - 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.
73
 
74
- ## Quickstart
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
75
 
76
  ```shell
77
  git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
@@ -85,21 +134,22 @@ Then make a copy of `config_example.json`, rename it to `config.json`, and then
85
  python ChuanhuChatbot.py
86
  ```
87
 
88
- A browser window will open and you will be able to chat with ChatGPT.
89
 
90
  > **Note**
91
  >
92
- > Please check our [wiki page](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程) for detailed instructions.
 
93
 
94
  ## Troubleshooting
95
 
96
- When you encounter problems, you should try manually pulling the latest changes of this project first. The steps are as follows:
97
 
98
- 1. Download the latest code archive by clicking on `Download ZIP` on the webpage, or
99
  ```shell
100
  git pull https://github.com/GaiZhenbiao/ChuanhuChatGPT.git main -f
101
  ```
102
- 2. Try installing the dependencies again (as this project may have introduced new dependencies)
103
  ```
104
  pip install -r requirements.txt
105
  ```
 
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
+ Compatible with GPT-4 · Chat with files · LLMs local deployment · Web search · Chuanhu Agent · Fine-tuning
 
 
 
 
26
  </p>
27
  <a href="https://www.youtube.com/watch?v=MtxS4XZWbJE"><strong>Video Tutorial</strong></a>
28
  ·
 
39
 
40
  [![Video Title](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7.jpg)](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7?autoplay=1)
41
 
42
+ ## 5.0 Major Update!
43
 
44
+ ![ChuanhuChat5update](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/70903329/f2c2be3a-ea93-4edf-8221-94eddd4a0178)
45
 
 
 
 
 
 
46
 
47
+ <sup>New!</sup> An all-new user interface! So exquisite that it doesn't look like Gradio, it even has a frosted glass effect!
48
 
49
+ <sup>New!</sup> Adapted for mobile devices (including perforated/bezel-less phones), the hierarchy is clearer.
 
 
 
50
 
51
+ <sup>New!</sup> The history is moved to the left for easier use. And supports search (with regular expressions), delete, and rename.
52
+
53
+ <sup>New!</sup> Now you can let the large model automatically name the history (Enabled in the settings or configuration file).
54
+
55
+ <sup>New!</sup> Chuanhu Chat can now be installed as a PWA application for a more native experience! Supported on Chrome/Edge/Safari etc.
56
+
57
+ <sup>New!</sup> Icons adapted for all platforms, looking more comfortable.
58
+
59
+ <sup>New!</sup> Supports Finetune (fine-tuning) GPT 3.5!
60
 
61
+ ## Supported Models
 
 
 
 
 
 
 
62
 
63
+ | API Callable Models | Remarks | Locally Deployed Models | Remarks |
64
+ | :---: | --- | :---: | --- |
65
+ | [ChatGPT(GPT-4)](https://chat.openai.com) | Support fine-tune gpt-3.5 | [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B)) |
66
+ | [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service) | | [LLaMA](https://github.com/facebookresearch/llama) | Support Lora models
67
+ | [Google PaLM](https://developers.generativeai.google/products/palm) | Not support streaming | [StableLM](https://github.com/Stability-AI/StableLM)
68
+ | [iFlytek Starfire Cognition Large Model](https://xinghuo.xfyun.cn) | | [MOSS](https://github.com/OpenLMLab/MOSS)
69
+ | [Inspur Yuan 1.0](https://air.inspur.com/home) | |
70
+ | [MiniMax](https://api.minimax.chat/) |
71
+ | [XMChat](https://github.com/MILVLG/xmchat) | Not support streaming
72
+ | [Midjourney](https://www.midjourney.com/) | Not support streaming
73
+
74
+ ## Usage Tips
75
+
76
+ ### 💪 Powerful Functions
77
+ - **Chuanhu Assistant**: Similar to AutoGPT, automatically solves your problems;
78
+ - **Online Search**: Is ChatGPT's data too old? Give LLM the wings of the internet;
79
+ - **Knowledge Base**: Let ChatGPT help you speed read quantumly! Answer questions based on files.
80
+ - **Local LLM Deployment**: One-click deployment, get your own large language model.
81
+
82
+ ### 🤖 System Prompt
83
+ - The system prompt can effectively enable role-playing by setting prerequisite conditions;
84
+ - ChuanhuChat presets Prompt templates, click `Load Prompt Template`, choose the Prompt template collection first, then choose the Prompt you want in the list below.
85
+
86
+ ### 💬 Basic Conversation
87
+ - If the answer is not satisfactory, you can try the `Regenerate` button again, or directly `Delete this round of conversation`;
88
+ - Input box supports line breaks, press <kbd>Shift</kbd> + <kbd>Enter</kbd> to make one;
89
+ - Using the <kbd>↑</kbd> <kbd>↓</kbd> arrow keys in the input box, you can quickly switch between send records;
90
+ - Generating a new conversation every time is too cumbersome, try the `single-dialogue` function;
91
+ - The small button next to the answer bubble not only allows `one-click copy`, but also lets you `view the original Markdown text`;
92
+ - Specify the answer language, so that ChatGPT will always reply in a certain language.
93
+
94
+ ### 📜 Chat History
95
+ - Dialogue history will be automatically saved, you won't have to worry about not being able to find it after asking;
96
+ - Multi-user history isolation, only you can see them;
97
+ - Rename chat, easy to find in the future;
98
+ - <sup>New!</sup> Magically auto-name the chat, let LLM understand the conversation content, and automatically name the chat for you!
99
+ - <sup>New!</sup> Search chat, supports regular expressions!
100
+
101
+ ### 🖼️ Small and Beautiful Experience
102
+ - Self-developed Small-and-Beautiful theme, gives you a small and beautiful experience;
103
+ - Automatic light and dark color switching, gives you a comfortable experience from morning till night;
104
+ - Perfectly rendering LaTeX / tables / code blocks, supports code highlighting;
105
+ - <sup>New!</sup> Non-linear animations, frosted glass effect, so exquisite it doesn't look like Gradio!
106
+ - <sup>New!</sup> Adapted for Windows / macOS / Linux / iOS / Android, from icon to screen adaptation, gives you the most suitable experience!
107
+ - <sup>New!</sup> Supports PWA app installation for an even more native experience!
108
+
109
+ ### 👨‍💻 Geek Functions
110
+ - <sup>New!</sup> Supports Fine-tuning gpt-3.5!
111
+ - Plenty of available LLM parameters to adjust;
112
+ - Supports API-host switching;
113
+ - Supports custom proxies;
114
+ - Supports multiple api-key load balancing.
115
+
116
+ ### ⚒️ Deployment Related
117
+ - Deployment to the server: Set in `config.json` `"server_name": "0.0.0.0", "server_port": <your port number>,`.
118
+ - Obtain public link: Set in `config.json` `"share": true,`. Note that the program must be running to access it through public links.
119
+ - Use on Hugging Face: It's recommended to **Duplicate the Space** in the top right corner before using, the App response might be faster.
120
+
121
+ ## Quick Start
122
+
123
+ Execute the following commands in the terminal:
124
 
125
  ```shell
126
  git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
 
134
  python ChuanhuChatbot.py
135
  ```
136
 
137
+ A browser window will automatically open, at this point you can use **Chuanhu Chat** to chat with ChatGPT or other models.
138
 
139
  > **Note**
140
  >
141
+ > Please check our [wiki page](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程) for detailed instructions.).
142
+
143
 
144
  ## Troubleshooting
145
 
146
+ When you encounter problems, you should try to **manually pull the latest changes<sup>1</sup>** and **update dependencies<sup>2</sup>** first, then retry. Steps are:
147
 
148
+ 1. Click on the `Download ZIP` button on the website, download the latest code and unzip to replace, or
149
  ```shell
150
  git pull https://github.com/GaiZhenbiao/ChuanhuChatGPT.git main -f
151
  ```
152
+ 2. Try to install dependencies again (the project might have new dependencies)
153
  ```
154
  pip install -r requirements.txt
155
  ```
readme/README_ja.md CHANGED
@@ -22,11 +22,7 @@
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
- ストリーム出力/会話回数無制限/履歴保存/プリセットプロンプト/ファイルへの質問チャット<br>
26
- ウェブ検索/LaTeXレンダリング/表レンダリング/コードハイライト<br>
27
- オートダークモード/アダプティブ・ウェブ・インターフェイス/WeChatライク・テーマ<br />
28
- マルチパラメーターチューニング/マルチAPI-Key対応/マルチユーザー対応<br>
29
- GPT-4対応/LLMのローカルデプロイ可能。
30
  </p>
31
  <a href="https://www.youtube.com/watch?v=MtxS4XZWbJE"><strong>動画チュートリアル</strong></a>
32
  ·
@@ -42,32 +38,85 @@
42
  </div>
43
 
44
  [![Video Title](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7.jpg)](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7?autoplay=1)
45
- ## サポートされている大規模言語モデル
46
 
47
- **APIを通じてアクセス可能な大規模言語モデル**:
48
 
49
- - [ChatGPT](https://chat.openai.com) ([GPT-4](https://openai.com/product/gpt-4))
50
- - [Google PaLM](https://developers.generativeai.google/products/palm)
51
- - [Inspur Yuan 1.0](https://air.inspur.com/home)
52
- - [MiniMax](https://api.minimax.chat/)
53
- - [XMChat](https://github.com/MILVLG/xmchat)
54
 
55
- **ローカルに展開された大規模言語モデル**:
56
 
57
- - [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B))
58
- - [LLaMA](https://github.com/facebookresearch/llama)
59
- - [StableLM](https://github.com/Stability-AI/StableLM)
60
- - [MOSS](https://github.com/OpenLMLab/MOSS)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
61
 
62
  ## 使う上でのTips
63
 
64
- - ChatGPTをより適切に制御するために、システムプロンプトを使用できます。
65
- - プロンプトテンプレートを使用するには、プロンプトテンプレートコレクションを選択し、ドロップダウンメニューから特定のプロンプトを選択。回答が不十分な場合は、`🔄再生成`ボタンを使って再試行します。
66
- - 入力ボックスで改行するには、<kbd>Shift</kbd> + <kbd>Enter</kbd>キーを押してください。
67
- - 入力履歴を素早く切り替えるには、入力ボックスで <kbd>↑</kbd>と<kbd>↓</kbd>キーを押す。
68
- - プログラムをサーバーに展開する��は、`config.json` 内の `"server_name": "0.0.0.0", "server_port": <ポート番号>`を設定してください。
69
- - 共有リンクを取得するには、 `config.json` 内の `"share": true` を設定してください。なお、公開リンクでアクセスするためには、プログラムが実行されている必要があることに注意してください。
70
- - Hugging Face Spacesで使用する場合: より速く、より安全に利用するために、**Duplicate Space**を使用し、自分のスペースでプログラムを実行することをお勧めします。
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
 
72
  ## クイックスタート
73
 
 
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
+ GPT-4対応 · ファイルへの質問チャット · LLMのローカルデプロイ可能 · ウェブ検索 · エージェントアシスタント · Fine-tuneをサポートします
 
 
 
 
26
  </p>
27
  <a href="https://www.youtube.com/watch?v=MtxS4XZWbJE"><strong>動画チュートリアル</strong></a>
28
  ·
 
38
  </div>
39
 
40
  [![Video Title](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7.jpg)](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7?autoplay=1)
 
41
 
42
+ ## ✨ 5.0の重要な更新!
43
 
44
+ ![ChuanhuChat5更新](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/70903329/f2c2be3a-ea93-4edf-8221-94eddd4a0178)
 
 
 
 
45
 
46
+ <sup>新!</sup> 全く新しいユーザーインターフェース!Gradioに比べて精緻で、さらにフロストガラス効果があります!
47
 
48
+ <sup>新!</sup> モバイル端末(画面全体のスマホのパンチホール/ノッチを含む)に対応し、レイヤーがはっきりしてきました。
49
+
50
+ <sup>新!</sup> 履歴が左側に移動し、使いやすくなりました。また、検索(正規表現対応)、削除、リネームが可能です。
51
+
52
+ <sup>新!</sup> 大きなモデルによる履歴の自動命名が可能になりました(設定または設定ファイルで有効化が必要)。
53
+
54
+ <sup>新!</sup> 今では 川虎チャット を PWAアプリケーションとしてインストールすることも可能で、よりネイティブな体験ができます!Chrome/Edge/Safariなどのブラウザをサポート。
55
+
56
+ <sup>新!</sup> 各プラットフォームに適したアイコンで、見ていても気持ちがいい。
57
+
58
+ <sup>新!</sup> Finetune(微調整)GPT 3.5に対応!
59
+
60
+ ## モデルのサポート
61
+
62
+ | API呼び出しモデル | 備考 | ローカルデプロイモデル | 備考 |
63
+ | :---: | --- | :---: | --- |
64
+ | [ChatGPT(GPT-4)](https://chat.openai.com) | gpt-3.5の微調整をサポート | [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B)) |
65
+ | [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service) | | [LLaMA](https://github.com/facebookresearch/llama) | Loraモデルのサポートあり 
66
+ | [Google PaLM](https://developers.generativeai.google/products/palm) | ストリーミング転送はサポートされていません | [StableLM](https://github.com/Stability-AI/StableLM)
67
+ | [讯飞星火认知大模型](https://xinghuo.xfyun.cn) | | [MOSS](https://github.com/OpenLMLab/MOSS)
68
+ | [Inspur Yuan 1.0](https://air.inspur.com/home) | |
69
+ | [MiniMax](https://api.minimax.chat/) |
70
+ | [XMChat](https://github.com/MILVLG/xmchat) | ストリーミング転送はサポートされていません
71
+ | [Midjourney](https://www.midjourney.com/) | ストリーミング転送はサポートされていません
72
 
73
  ## 使う上でのTips
74
 
75
+ ### 💪 パワフルな機能
76
+ - **川虎助理**:AutoGPTに似ており、自動的に問題を解決します。
77
+ - **オンライン検索**:ChatGPTのデータが古い場合は、LLMにネットワークの翼を付けます。
78
+ - **ナレッジベース**:ChatGPTがあなたをクイックリーディングの世界へご招待!ファイルに基づいて質問に答えます。
79
+ - **LLMのローカルデプロイ**:ワンクリックであなた自身の大規模言語モデルをデプロイします。
80
+
81
+ ### 🤖 システムプロンプト
82
+ - システムプロンプトを使用して前提条件を設定すると、ロールプレイが効果的に行えます。
83
+ - 川虎Chatはプロンプトテンプレートを予め設定しており、「プロンプトテンプレートを読み込む」をクリックして、まずプロンプトテンプレートコレクションを選択し、次に下部で希望のプロンプトを選択します。
84
+
85
+ ### 💬 ベーシックな対話
86
+ - もし回答が満足できない場合、「再生成」ボタンを使用して再試行するか、直接「このラウンドの対話を削除」することができます。
87
+ - 入力ボックスは改行をサポートしており、 <kbd>Shift</kbd> + <kbd>Enter</kbd> を押すと改行できます。
88
+ - 入力ボックスで <kbd>↑</kbd> <kbd>↓</kbd> キーを押すと、送信履歴をスピーディに切り替えることができます。
89
+ - 各対話を新しく作成するのは面倒ですか?「単発対話」機能を試してみてください。
90
+ - 回答バブルの横の小さなボタンは「一括コピー」だけでなく、「Markdownの元のテキストを表示」もできます。
91
+ - 回答の言語を指定して、ChatGPTが特定の言語で回答するようにします。
92
+
93
+ ### 📜 履歴記録
94
+ - ダイアログの履歴は自動的に保存されるので、完了後に見つけることができます。
95
+ - 複数のユーザーの履歴は分離されており、他のユーザーは閲覧できません。
96
+ - 履歴の名前を変更することで、将来的な検索を容易にします。
97
+ - <sup>新!</sup> マジカルな自動履歴名付け機能で、LLMが対話内容を理解し、履歴に自動的に名前をつけてくれます!
98
+ - <sup>新!</sup> 正規表現をサポートする履歴検索!
99
+
100
+ ### 🖼️ シンプルな使いやすさ
101
+ - 独自のSmall-and-Beautifulテーマで、シンプルで美しい体験を提供します。
102
+ - 自動的な明暗の切り替えで、早朝から夜まで快適な体験ができます。
103
+ - LaTeX/テーブル/コードブロックを完璧にレンダリングし、コードハイライトがサポートされています。
104
+ - <sup>新!</sup> ノンリニアアニメーション、フロストガラスの効果など、Gradioのように洗練されています!
105
+ - <sup>新!</sup> Windows / macOS / Linux / iOS / Androidに対応し、アイコンからフルスクリーンまで、最適な体験を提供します!
106
+ - <sup>新!</sup> PWAアプリケーションのインストールがサポートされており、よりネイティブな体験ができます!
107
+
108
+ ### 👨‍💻 ギーク向け機能
109
+ - <sup>新!</sup> gpt-3.5のFine-tune(微調整)がサポートされています!
110
+ - 多くのLLMパラメータをカスタマイズできます。
111
+ - api-hostの変更が可能です。
112
+ - カスタムプロキシの設定が可能です。
113
+ - 負荷分散のための複数のapiキーのサポートがあります。
114
+
115
+ ### ⚒️ デプロイに関する情報
116
+ - サーバーへのデプロイ:`config.json`ファイルで`"server_name": "0.0.0.0", "server_port": <あなたのポート番号>,"`を設定します。
117
+ - 共有リンクの取得:`config.json`ファイルで`"share": true,`を設定します。ただし、プログラムが実行されている必要があります。
118
+ - Hugging Faceでの使用:右上のコーナーの「Spaceをコピー」を選択し、それから使用することをおすすめします。これにより、アプリの反応が速くなる場合があります。
119
+
120
 
121
  ## クイックスタート
122
 
readme/README_ru.md CHANGED
@@ -22,11 +22,7 @@
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
- Потоковое вещание / Неограниченное количество разговоров / Сохранение истории / <br /> Предустановленные подсказки / Чат с файлами / Поиск в Интернете <br />
26
- Рендеринг LaTeX/Рендеринг таблиц/Подсветка кода <br />
27
- Автоматический темный режим / Адаптивный веб-интерфейс / Тема в стиле WeChat <br />
28
- Многопараметрическая настройка / Поддержка нескольких ключей API / Многопользовательская поддержка <br />
29
- Совместимость с GPT-4/локальное развертывание для LLM.
30
  </p>
31
  <a href="https://www.youtube.com/watch?v=MtxS4XZWbJE"><strong>Видео туториал</strong></a>
32
  ·
@@ -43,33 +39,83 @@
43
 
44
  [![Video Title](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7.jpg)](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7?autoplay=1)
45
 
46
- ## Поддерживаемые модели LLM
47
 
48
- **Модели LLM через API**:
49
 
50
- - [ChatGPT](https://chat.openai.com) ([GPT-4](https://openai.com/product/gpt-4))
51
- - [Google PaLM](https://developers.generativeai.google/products/palm)
52
- - [Inspur Yuan 1.0](https://air.inspur.com/home)
53
- - [MiniMax](https://api.minimax.chat/)
54
- - [XMChat](https://github.com/MILVLG/xmchat)
55
 
56
- **Модели LLM через локальное развертывание**:
57
 
58
- - [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B))
59
- - [LLaMA](https://github.com/facebookresearch/llama)
60
- - [StableLM](https://github.com/Stability-AI/StableLM)
61
- - [MOSS](https://github.com/OpenLMLab/MOSS)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
62
 
63
  ## Советы по использованию
64
 
65
- - Чтобы лучше контролировать ChatGPT, используйте системную подсказку.
66
- - Чтобы использовать шаблон подсказки, сначала выберите файл коллекции шаблонов подсказок, а затем выберите конкретную подсказку в раскрывающемся меню.
67
- - Чтобы повторить попытку, если ответ неудовлетворительный, используйте кнопку «🔄 Восстановить».
68
- - Чтобы начать новую строку в поле ввода, нажмите клавиши <kbd>Shift </kbd> + <kbd>Enter </kbd>.
69
- - Чтобы быстро переключиться между историей ввода, нажмите клавиши <kbd>↑</kbd> и <kbd>↓</kbd> в поле ввода.
70
- - Чтобы развернуть программу на сервере, установите `"server_name": "0.0.0.0", "server_port" <номер вашего порта>` в `config.json` .
71
- - Чтобы получить общедоступную ссылку, установите `"share": true` в `config.json`. Обратите внимание, что для доступа по общедоступной ссылке программа должна быть запущена.
72
- - Чтобы использовать его в пространстве с обнимающим лицом: рекомендуется **Дублировать пространство** и запустить программу в своем собственном пространстве для более быстрой и безопасной работы.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
73
 
74
  ## Быстрый старт
75
 
 
22
  <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
  </a>
24
  <p>
25
+ Поддержка GPT-4 · Анализ файлов в чате · Локальная установка LLM · Онлайн-поиск · Помощник Agent · Поддержка Fine-tune
 
 
 
 
26
  </p>
27
  <a href="https://www.youtube.com/watch?v=MtxS4XZWbJE"><strong>Видео туториал</strong></a>
28
  ·
 
39
 
40
  [![Video Title](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7.jpg)](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/51039745/0eee1598-c2fd-41c6-bda9-7b059a3ce6e7?autoplay=1)
41
 
42
+ ## Обновление 5.0!
43
 
44
+ ![ChuanhuChat5](https://github.com/GaiZhenbiao/ChuanhuChatGPT/assets/70903329/f2c2be3a-ea93-4edf-8221-94eddd4a0178)
45
 
46
+ <sup>New!</sup> Совершенно новый пользовательский интерфейс! Он такой приятный, не похожий на Gradio, с новым эффектом матового стекла!
 
 
 
 
47
 
48
+ <sup>New!</sup> Адаптация для мобильных устройств (включая экраны с отверстием/выемкой под камеру), иерархия стала более четкой.
49
 
50
+ <sup>New!</sup> История перенесена в левую часть для удобства использования. Поддерживается поиск (с поддержкой регулярных выражений), удаление и переименование.
51
+
52
+ <sup>New!</sup> Теперь можно автоматически давать истории имена для больших моделей (требуется включение в настройках или в конфигурационном файле).
53
+
54
+ <sup>New!</sup> Теперь можно установить Чуаньху Чат в качестве приложения PWA, чтобы повысить нативность! Поддерживаемые браузеры: Chrome/Edge/Safari и другие.
55
+
56
+ <sup>New!</sup> Значок адаптирован для различных платформ, выглядит более комфортно.
57
+
58
+ <sup>New!</sup> Поддержка Fine-tune (микронной настройки) GPT 3.5!
59
+
60
+ ## Поддерживаемые модели
61
+
62
+ | Модель с использованием API | Примечание | Локально развернутые модели | Примечание |
63
+ | :---: | --- | :---: | --- |
64
+ | [ChatGPT (GPT-4)](https://chat.openai.com) | Поддерживает микронастройку gpt-3.5 | [ChatGLM](https://github.com/THUDM/ChatGLM-6B) ([ChatGLM2](https://github.com/THUDM/ChatGLM2-6B)) |
65
+ | [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service) | | [LLaMA](https://github.com/facebookresearch/llama) | Поддерживает модель Lora 
66
+ | [Google PaLM](https://developers.generativeai.google/products/palm) | Не поддерживает потоковую передачу данных | [StableLM](https://github.com/Stability-AI/StableLM)
67
+ | [Xunfei Xinghuo Cognitive Model](https://xinghuo.xfyun.cn) | | [MOSS](https://github.com/OpenLMLab/MOSS)
68
+ | [Inspur Yuan 1.0](https://air.inspur.com/home) | |
69
+ | [MiniMax](https://api.minimax.chat/) |
70
+ | [XMChat](https://github.com/MILVLG/xmchat) | Не поддерживает потоковую передачу данных
71
+ | [Midjourney](https://www.midjourney.com/) | Не поддерживает потоковую передачу данных
72
 
73
  ## Советы по использованию
74
 
75
+ ### 💪 Мощные функции
76
+ - **Chuanhu ассистент**: подобно AutoGPT, полностью автоматизированное решение вашей проблемы;
77
+ - **Поиск в Интернете**: данные ChatGPT устарели? Дайте LLM возможность использовать сеть;
78
+ - **База знаний**: позвольте ChatGPT помочь вам быстро прочитать информацию! Ответить на вопросы в соответствии с файлами.
79
+ - **Локальная установка LLM**: одним щелчком разверните свою собственную модель языка большого размера.
80
+
81
+ ### 🤖 Системный промт
82
+ - Установка предпосылок через системное сообщение позволяет эффективно играть роль персонажа;
83
+ - Чуаньху Чат предоставляет набор системных шаблонов, нажмите "Загрузить шаблон системного сообщения", затем выберите необходимый шаблон ниже.
84
+
85
+ ### 💬 Обычный диалог
86
+ - Если ответ не удовлетворяет вас, можно попробовать снова с помощью кнопки "Перегенерировать" или просто удалить этот раунд диалога;
87
+ - Поле ввода поддерживает перенос строки, нажмите <kbd>Shift</kbd> + <kbd>Enter</kbd>, чтобы сделать перенос строки;
88
+ - В поле ввода можно использовать клавиши <kbd>↑</kbd> и <kbd>↓</kbd>, чтобы быстро переключаться в истории отправки;
89
+ - Создание нового диалога слишком неудобно? Попробуйте функцию "Одиночный диалог";
90
+ - У кнопки возле пузыря с ответом можно не только "скопировать одним нажатием", но и "посмотреть исходный текст в формате Markdown";
91
+ - Укажите язык ответа, чтобы ChatGPT всегда отвечал на определенном языке.
92
+
93
+ ### 📜 История чатов
94
+ - История диалогов будет сохраняться автоматически, не нужно беспокоиться о том, что после вопросов они исчезнут;
95
+ - История диалогов защищена для каждого пользователя, никто кроме вас не может ее видеть;
96
+ - Переименуйте историю диалога, чтобы было удобнее искать в будущем;
97
+ - <sup>New!</sup> Магическое автоматическое именование истории диалога: позволяет LLM понять содержание диалога и автоматически называть историю диалога!
98
+ - <sup>New!</sup> Поиск истории диалога, поддержка регулярных выражений!
99
+
100
+ ### 🖼️ Красивый и компактный интерфейс
101
+ - Собственная тема Small-and-Beautiful принесет вам красивые и компактные впечатления;
102
+ - Автоматическое переключение светлой и темной темы обеспечит комфорт в любое время суток;
103
+ - Идеальное отображение LaTeX / таблиц / блоков кода, поддержка подсветки синтаксиса;
104
+ - <sup>New!</sup> Нелинейная анимация, эффект матового стекла – он такой изысканный, не похожий на Gradio!
105
+ - <sup>New!</sup> Поддержка Windows / macOS / Linux / iOS / Android, от иконки до адаптации под экраны с вырезами, предоставляет оптимальный опыт!
106
+ - <sup>New!</sup> Поддержка установки в качестве PWA-приложения, для более нативного опыта!
107
+
108
+ ### 👨‍💻 Технические возможности
109
+ - <sup>New!</sup> Поддержка Fine-tune (тонкой настройки) gpt-3.5!
110
+ - Множество настраиваемых параметров для LLM;
111
+ - Поддержка изменения api-host;
112
+ - Поддержка настройки настраиваемого прокси-сервера;
113
+ - Поддержка балансировки нагрузки между несколькими ключами API.
114
+
115
+ ### ⚒️ Развертывание на сервере
116
+ - Развертывание на сервере: установите `"server_name": "0.0.0.0", "server_port": <порт>",` в `config.json`.
117
+ - Получение общедоступной ссылки: установите `"share": true` в `config.json`. Обратите внимание, что программа должна быть запущена, чтобы можно было получить доступ по общедоступной ссылке.
118
+ - Использование на Hugging Face: рекомендуется скопировать **Space** в правом верхнем углу, а затем использовать его, чтобы приложение было более отзывчивым.
119
 
120
  ## Быстрый старт
121