- 🔥 [2024-06-14]
not found libllama.dll
问题修复补丁 👉 - 🔥 [2024-05-31] YuanChat V0.5 通用版本升级:知识库、网络检索、插件市场、模型管理功能增强 👉
- 🔥 [2024-04-29] 全新YuanChat个人助手版本:多模型推理(with ModelScope)、RAG检索、网络搜索、文档阅读,支持CPU Only运行 👉
- 🔥 [2024-04-23] YuanChat全面升级:知识库、网络检索、全新交互体验、适配intel XPU 👉
- 🔥 [2024-03-06] [基于llamacpp的Yuanchat.exe使用教程 👉](./docs/基于llamacpp的 Yuanchat.exe 使用教程.md)
- 🔥 [2024-02-29] 支持网络搜索增强 👉
- 🔥 [2024-02-04] 推出 Windows 桌面版 YuanChat.exe 👉
- 🔥 [2024-01-05] 笔记本上快速部署Yuan大模型和YuanChat 👉
Table of Contents
YuanChat
is a part of Yuan-2.0 project, it is a client side application for Yuan-2.0. YuanChat
provides an easy way to make users communicate with Yuan-2.0, users can easily test and use Yuan-2.0 LLM models.
Thanks for these awesome projects:
Before deploy with docker, you need to install:
- Docker 18.03+
- Yuan-2.0, deploy docker instruction, run inference get model request url
http://127.0.0.1:8000
instruction - Chrome
We provide a prebuilt image for YuanChat
, you can directly deploy this project with one command.
docker run --rm -d --name yuanchat -p 5050:5050 -e YUAN_2_URL=http://ip:port/yuan yuanmodel/yuanchat:latest
Here, YUAN_2_URL=http://ip:port/yuan
is the url of Yuan-2.0 model server, ip is the ip address of your Yuan-2.0 server,
and the port is the server port. eg. http://192.168.1.1:8000/yuan
.
Open link http://localhost:5050 in browser , if everything ok, you will see this page:
Build and deploy your own version with source code.
Before deploy with source code, you need to setup development environment:
- Python 3.8+
- nodejs 18+
- Yuan-2.0, deploy docker instruction, run inference get model request url http://127.0.0.1:8000
- Chrome
git clone https://github.com/IEIT-Yuan/YuanChat.git
cd YuanChat/src/webui
npm install
npm run build
For more webui details, please read the webui README
If your Yuan-2.0
model server address is not http://127.0.0.1:8000
, you need to specify the to the right server address in YuanChat/src/python/yuan_processing/as_constants.py
for param YUAN_2_URL
,
such as YUAN_2_URL=http://192.168.1.1:8000/yuan
For more python server details, please read the python server README
cd YuanChat
pip install -r requirements.txt
cd YuanChat
bash start.sh
-
To modify the logo in the upper left corner of the Yuan Chat Web UI, you need replace
/src/webui/public/logo.png
with a pre prepared logo image. It is recommended that the image size be 120 * 48. -
To modify the welcome message for the conversation in the Yuan Chat, you need modify the language configuration in
/src/webui/src/locales/lang/en.js
. Specifically, the following content needs to be modified:
welcomeHeader: 'I am YuanChat, a dialogue application based on Yuan 2.0 large language model.',
welcomeParagraph1:'I am capable of engaging in multi-turn conversations, answering domain-specific questions, and assisting individuals in application writing and artistic creation.',
- To modify the recommended questions of the Yuan Chat, you need modify the content in
/src/webui/public/recommends.json
.
When you are in the local development mode of the web UI (please refer to README), the above modifications will take effect immediately. If you want to deploy, please refer to Deploy with source
Open link http://localhost:5050 in browser , if everything ok, you will see this page:
- Add README_zh.md
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the YuanChat License
. See YuanChat LICENSE file for more information.
Distributed under the Apache License 2.0
. See LICENSE file for more information.