Home

Awesome

<a name="readme-top"></a>

<!-- TODO -->

Info Apache License

<!-- 项目LOGO --> <br /> <div align="center"> <a href="https://airyuan.cn/home"> <img src="docs/images/favicon.png" alt="Logo" width="400" height="160"> </a> <p align="center"> Yuan LLM 开源项目对话应用 <br /> <a href="https://airyuan.cn/home"><strong> 源官网 »</strong></a> <br /> <br /> </p>

English / 简体中文

</div>

:tada: 最近更新


<!-- TODO --> <!-- TABLE OF CONTENTS --> <details> <summary>目录</summary> <ol> <li> <a href="#about-the-project">关于</a> <ul> <li><a href="#built-with">构建</a></li> </ul> </li> <li> <a href="#getting-started">开始</a> <ul> <li><a href="#1-deploy-with-docker">Docker部署</a></li> <li><a href="#2-deploy-with-source">源码部署</a></li> </ul> </li> <li><a href="#roadmap">产品规划</a></li> <li><a href="#contributing">贡献</a></li> <li><a href="#license">许可</a></li> </ol> </details> <!-- 关于 -->

关于

<!-- TODO -->

YuanChat Screen Shot

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

<p align="right">(<a href="#readme-top">回到顶端</a>)</p>

构建

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

FastAPIVueNodeJS

<p align="right">(<a href="#readme-top">回到顶端</a>)</p> <!-- GETTING STARTED -->

开始

1. Docker 部署

1.1 依赖条件

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

1.2 部署

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

<!-- TODO -->
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

<p align="right">(<a href="#readme-top">回到顶端</a>)</p>

2. 源码部署

<!-- TODO -->

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

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 定制修改

  welcomeHeader: '我是源Chat,基于源2.0大模型的对话应用。',
  welcomeParagraph1: '我能够进行多轮对话,回答领域问题,协助人们进行应用文写作和艺术创作。',

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

2.3 验证

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

YuanChat Screen Shot

<!-- ROADMAP -->

产品规划

<p align="right">(<a href="#readme-top">回到顶端</a>)</p> <!-- CONTRIBUTING -->

贡献

<!-- TODO -->

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

如果你对我们有更好的建议,请将仓库 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
<p align="right">(<a href="#readme-top">回到顶端</a>)</p> <!-- LICENSE -->

许可

<!-- TODO -->

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

<p align="right">(<a href="#readme-top">回到顶端</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->