Keldos chinwh2019 MZhao commited on
Commit
bd5237a
1 Parent(s): 903e549

doc: translate README to English (#629)

Browse files

* doc: add README_en.md

* doc: add language switch links

* doc: revise README_en.md

* polish the header part

* Update README_en.md

* doc: add instructions for localization

---------

Co-authored-by: chinwh2019 <125436349+chinwh2019@users.noreply.github.com>
Co-authored-by: MZhao <70903329+MZhao-ouo@users.noreply.github.com>

Files changed (2) hide show
  1. README.md +5 -0
  2. README_en.md +124 -0
README.md CHANGED
@@ -1,3 +1,8 @@
 
 
 
 
 
1
  <h1 align="center">川虎 Chat 🐯 Chuanhu Chat</h1>
2
  <div align="center">
3
  <a href="https://github.com/GaiZhenBiao/ChuanhuChatGPT">
 
1
+ <div align="right">
2
+ <!-- 语言: -->
3
+ 简体中文 | <a title="English" href="README_en.md">English</a>
4
+ </div>
5
+
6
  <h1 align="center">川虎 Chat 🐯 Chuanhu Chat</h1>
7
  <div align="center">
8
  <a href="https://github.com/GaiZhenBiao/ChuanhuChatGPT">
README_en.md ADDED
@@ -0,0 +1,124 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <div align="right">
2
+ <!-- Language: -->
3
+ <a title="Chinese" href="README.md">简体中文</a> | English
4
+ </div>
5
+
6
+ <h1 align="center">川虎 Chat 🐯 Chuanhu Chat</h1>
7
+ <div align="center">
8
+ <a href="https://github.com/GaiZhenBiao/ChuanhuChatGPT">
9
+ <img src="https://user-images.githubusercontent.com/70903329/227087087-93b37d64-7dc3-4738-a518-c1cf05591c8a.png" alt="Logo" height="156">
10
+ </a>
11
+
12
+ <p align="center">
13
+ <h3>Lightweight and User-friendly Web-UI for LLMs including ChatGPT/ChatGLM/LLaMA</h3>
14
+ <p align="center">
15
+ <a href="https://github.com/GaiZhenbiao/ChuanhuChatGPT/blob/main/LICENSE">
16
+ <img alt="Tests Passing" src="https://img.shields.io/github/license/GaiZhenbiao/ChuanhuChatGPT" />
17
+ </a>
18
+ <a href="https://gradio.app/">
19
+ <img alt="GitHub Contributors" src="https://img.shields.io/badge/Base-Gradio-fb7d1a?style=flat" />
20
+ </a>
21
+ <a href="https://t.me/tkdifferent">
22
+ <img alt="GitHub pull requests" src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" />
23
+ </a>
24
+ <p>
25
+ Real-time replies / 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
+ ·
33
+ <a href="https://www.youtube.com/watch?v=77nw7iimYDE"><strong>2.0 Introduction</strong></a>
34
+ ·
35
+ <a href="https://www.youtube.com/watch?v=x-O1jjBqgu4"><strong>3.0 Introduction & Tutorial</strong></a>
36
+ ||
37
+ <a href="https://huggingface.co/spaces/JohnSmith9982/ChuanhuChatGPT"><strong>Online trial</strong></a>
38
+ ·
39
+ <a href="https://huggingface.co/login?next=%2Fspaces%2FJohnSmith9982%2FChuanhuChatGPT%3Fduplicate%3Dtrue"><strong>One-Click deployment</strong></a>
40
+ </p>
41
+ <p align="center">
42
+ <img alt="Animation Demo" src="https://user-images.githubusercontent.com/51039745/226255695-6b17ff1f-ea8d-464f-b69b-a7b6b68fffe8.gif" />
43
+ </p>
44
+ </p>
45
+ </div>
46
+
47
+ ## Usage Tips
48
+ - To better control the ChatGPT, use System Prompt.
49
+ - To use a Prompt Template, select the Prompt Template Collection file first, and then choose certain prompt from the drop-down menu.
50
+ - To try again if the response is unsatisfactory, use `🔄 Regenerate` button.
51
+ - To start a new line in the input box, press <kbd>Shift</kbd> + <kbd>Enter</kbd> keys.
52
+ - To quickly switch between input history, press <kbd>↑</kbd> and <kbd>↓</kbd> key in the input box.
53
+ - To deploy the program onto a server, change the last line of the program to `demo.launch(server_name="0.0.0.0", server_port=<your port number>)`.
54
+ - To get a public shared link, change the last line of the program to `demo.launch(share=True)`. Please be noted that the program must be running in order to be accessed via a public link.
55
+ - 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.
56
+
57
+ ## Installation
58
+
59
+ ```shell
60
+ git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git
61
+ cd ChuanhuChatGPT
62
+ pip install -r requirements.txt
63
+ ```
64
+
65
+ Then make a copy of `config_example.json`, rename it to `config.json`, and then fill in your API-Key and other settings in the file.
66
+
67
+ ```shell
68
+ python ChuanhuChatbot.py
69
+ ```
70
+
71
+ A browser window will open and you will be able to chat with ChatGPT.
72
+
73
+ > **Note**
74
+ >
75
+ > Please check our [wiki page](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程) for detailed instructions.
76
+
77
+ ## Troubleshooting
78
+
79
+ When you encounter problems, you should try manually pulling the latest changes of this project first. The steps are as follows:
80
+
81
+ 1. Download the latest code archive by clicking on `Download ZIP` on the webpage, or
82
+ ```shell
83
+ git pull https://github.com/GaiZhenbiao/ChuanhuChatGPT.git main -f
84
+ ```
85
+ 2. Try installing the dependencies again (as this project may have introduced new dependencies)
86
+ ```
87
+ pip install -r requirements.txt
88
+ ```
89
+ 3. Update Gradio
90
+ ```
91
+ pip install gradio --upgrade --force-reinstall
92
+ ```
93
+
94
+ Generally, you can solve most problems by following these steps.
95
+
96
+ If the problem still exists, please refer to this page: [Frequently Asked Questions (FAQ)](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/常见问题)
97
+
98
+ This page lists almost all the possible problems and solutions. Please read it carefully.
99
+
100
+ ## More Information
101
+
102
+ More information could be found in our [wiki](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki):
103
+
104
+ - [How to contribute a translation](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/Localization)
105
+ - [How to make a contribution](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/贡献指南)
106
+ - [How to cite the project](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用许可#如何引用该项目)
107
+ - [Project changelog](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/更新日志)
108
+ - [Project license](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用许可)
109
+
110
+ ## Starchart
111
+
112
+ [![Star History Chart](https://api.star-history.com/svg?repos=GaiZhenbiao/ChuanhuChatGPT&type=Date)](https://star-history.com/#GaiZhenbiao/ChuanhuChatGPT&Date)
113
+
114
+ ## Contributors
115
+
116
+ <a href="https://github.com/GaiZhenbiao/ChuanhuChatGPT/graphs/contributors">
117
+ <img src="https://contrib.rocks/image?repo=GaiZhenbiao/ChuanhuChatGPT" />
118
+ </a>
119
+
120
+ ## Sponsor
121
+
122
+ 🐯 If you find this project helpful, feel free to buy me a coke or a cup of coffee~
123
+
124
+ <img width="250" alt="image" src="https://user-images.githubusercontent.com/51039745/226920291-e8ec0b0a-400f-4c20-ac13-dafac0c3aeeb.JPG">