Skip to content

IEIT-Yuan/YuanChat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b3e6016 · Feb 21, 2025

History

46 Commits
Nov 20, 2024
Dec 17, 2024
Oct 25, 2024
Feb 29, 2024
Jan 4, 2024
Jan 3, 2024
Jan 3, 2024
Feb 21, 2025
Jun 14, 2024
Jan 3, 2024
Jan 3, 2024
Feb 29, 2024
Jan 3, 2024
Jan 3, 2024

Repository files navigation

Info Apache License


Logo

Yuan LLM 开源项目对话应用
源官网 »

English / 简体中文

🎉 最近更新


目录
  1. 关于
  2. 开始
  3. 产品规划
  4. 贡献
  5. 许可

关于

YuanChat Screen Shot

源ChatYuan-2.0 项目的一部分, 作为Yuan-2.0的一个客户端应用. 源Chat 提供了一种简单的交互方式,可以让用户很轻松的使用 Yuan-2.0, 用户可以很方便的进行测试以及使用。

(回到顶端)

构建

本项目基于下面这些优秀的项目:

FastAPIVueNodeJS

(回到顶端)

开始

1. Docker 部署

1.1 依赖条件

首先,在您使用 Docker 部署之前,您需要先安装:

1.2 部署

我们提供了一个制作好的源Chat镜像,一条命令就可以完成项目的部署操作。

docker run --rm -d --name yuanchat -p 5050:5050 -e YUAN_2_URL=http://ip:port/yuan yuanmodel/yuanchat:latest

这里, YUAN_2_URL=http://ip:port/yuanYuan-2.0模型服务的地址,ip 是你部署Yuan-2.0服务的节点 ip,port 是服务对外端口,例如,你可以这样写:http://192.168.1.1:8000/yuan

1.3 验证

在浏览器中访问链接:http://localhost:5050,如果部署正确,那么你将会看到这个页面:

YuanChat Screen Shot

(回到顶端)


2. 源码部署

用源码创建并部署属于你自己的版本

2.1 依赖条件

在源码部署之前,你需要安装以下开发环境

2.2 部署

2.2.1 下载源码
git clone https://github.com/IEIT-Yuan/YuanChat.git
2.2.2 生成静态文件
cd YuanChat/src/webui
npm install
npm run build

获取更多 webui 详细信息,请参考 README

2.2.3 修改项目配置文件

如果你的Yuan-2.0 模型服务的地址不是http://127.0.0.1:8000,你需要在YuanChat/src/python/yuan_processing/as_constants.pyYUAN_2_URL参数指定正确的地址,例如:YUAN_2_URL=http://192.168.1.1:8000/yuan

获取更多 python 服务端详细信息,请参考 README

2.2.4 安装 python 依赖包
cd YuanChat
pip install -r requirements.txt
2.2.5 启动 python 服务
cd YuanChat
bash start.sh

2.2.6 Web UI 定制修改

  • 修改源 Chat Web UI 左上角的 Logo,需要将 /src/webui/public/logo.png 替换为提前准备好的 Logo 图片,建议图片尺寸为 120*48。

  • 修改源 Chat 的对话欢迎语,需要修改 /src/webui/src/locales/lang/zh-CN.js 中的多语言配置,具体要修改以下内容:

  welcomeHeader: '我是源Chat,基于源2.0大模型的对话应用。',
  welcomeParagraph1: '我能够进行多轮对话,回答领域问题,协助人们进行应用文写作和艺术创作。',
  • 修改源 Chat 的对话推荐问题,需要修改 /src/webui/public/recommends.json 中的内容。

当你处于 web UI 的本地开发模式(请参考 README),以上修改将立即生效。如果要部署,请参考源码部署章节

2.3 验证

在浏览器中访问链接 http://localhost:5050,如果部署正确,那么你将会看到这个页面:

YuanChat Screen Shot

产品规划

  • 增加 README 中文文档
  • 增加 windows+GPU 部署说明

(回到顶端)

贡献

贡献使得开源社区成为一个学习、激励和创造的绝佳场所。非常感谢您的任何贡献。

如果你对我们有更好的建议,请将仓库 fork 下来,并创建一个 pr。您也可以简单点,用标签“优化”给我们提一个问题。 别忘了给这个项目打一颗星!再次感谢!

  1. 从仓库 Fork 项目
  2. 创建一个你的分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的变更 (git commit -m 'Add some AmazingFeature')
  4. 将代码 push 到你的远程分支 (git push origin feature/AmazingFeature)
  5. 提交 Pull Request

(回到顶端)

许可

YuanChat License下分发. 获取更多信息请参考 YuanChat LICENSE .
Apache License 2.0下分发. 获取更多信息请参考 LICENSE .

(回到顶端)