mirror of
https://github.com/csunny/DB-GPT.git
synced 2025-08-07 11:23:40 +00:00
docs: update readme + llama-2 feat (#348)
add content for readme add llama-2 at features
This commit is contained in:
commit
c2df1c27ea
45
README.md
45
README.md
@ -8,11 +8,25 @@
|
||||
<a href="https://github.com/csunny/DB-GPT">
|
||||
<img alt="forks" src="https://img.shields.io/github/forks/csunny/db-gpt?style=social" />
|
||||
</a>
|
||||
<a href="https://opensource.org/licenses/MIT">
|
||||
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
|
||||
</a>
|
||||
<a href="https://github.com/csunny/DB-GPT/releases">
|
||||
<img alt="Release Notes" src="https://img.shields.io/github/release/csunny/DB-GPT" />
|
||||
</a>
|
||||
<a href="https://github.com/csunny/DB-GPT/issues">
|
||||
<img alt="Open Issues" src="https://img.shields.io/github/issues-raw/csunny/DB-GPT" />
|
||||
</a>
|
||||
<a href="https://discord.gg/jDD5FwHh">
|
||||
<img alt="Discord" src="https://dcbadge.vercel.app/api/server/jDD5FwHh?compact=true&style=flat" />
|
||||
</a>
|
||||
<a href="https://codespaces.new/csunny/DB-GPT">
|
||||
<img alt="Open in GitHub Codespaces" src="https://github.com/codespaces/badge.svg" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
||||
[**简体中文**](README.zh.md) |[**Discord**](https://discord.gg/rBgtJW8U) |[**Documents**](https://db-gpt.readthedocs.io/en/latest/)|[**Wechat**](https://github.com/csunny/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC)
|
||||
|
||||
[**简体中文**](README.zh.md) |[**Discord**](https://discord.gg/jDD5FwHh) |[**Documents**](https://db-gpt.readthedocs.io/en/latest/)|[**Wechat**](https://github.com/csunny/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC)
|
||||
|
||||
</div>
|
||||
|
||||
@ -20,7 +34,16 @@
|
||||
|
||||
DB-GPT is an experimental open-source project that uses localized GPT large models to interact with your data and environment. With this solution, you can be assured that there is no risk of data leakage, and your data is 100% private and secure.
|
||||
|
||||
[](https://star-history.com/#csunny/DB-GPT)
|
||||
|
||||
## Contents
|
||||
- [install](#install)
|
||||
- [demo](#demo)
|
||||
- [introduction](#introduction)
|
||||
- [features](#features)
|
||||
- [contribution](#contribution)
|
||||
- [acknowledgement](#acknowledgement)
|
||||
- [roadmap](#roadmap)
|
||||
- [contract](#contact-information)
|
||||
|
||||
## Demo
|
||||
|
||||
@ -84,8 +107,11 @@ Currently, we have released multiple key features, which are listed below to dem
|
||||
- Support for unstructured data such as PDF, TXT, Markdown, CSV, DOC, PPT, and WebURL
|
||||
|
||||
- Multi LLMs Support
|
||||
- Supports multiple large language models, currently supporting Vicuna (7b, 13b), ChatGLM-6b (int4, int8), guanaco(7b,13b,33b), Gorilla(7b,13b)
|
||||
- TODO: codegen2, codet5p
|
||||
- Supports multiple large language models, currently supporting Vicuna (7b, 13b), ChatGLM-6b (int4, int8), guanaco(7b,13b,33b), Gorilla(7b,13b), 🔥 llama-2(7b, 13b, 70b)
|
||||
- TODO: baichuan(7b, 13b)
|
||||
|
||||
|
||||
[](https://star-history.com/#csunny/DB-GPT)
|
||||
|
||||
|
||||
## Introduction
|
||||
@ -151,7 +177,7 @@ This project is standing on the shoulders of giants and is not going to work wit
|
||||
|
||||
## Contribution
|
||||
|
||||
- Please run `black .` before submitting the code.
|
||||
- Please run `black .` before submitting the code. contributing guidelines, [how to contribution](https://github.com/csunny/DB-GPT/blob/main/CONTRIBUTING.md)
|
||||
|
||||
## RoadMap
|
||||
|
||||
@ -164,4 +190,9 @@ This project is standing on the shoulders of giants and is not going to work wit
|
||||
The MIT License (MIT)
|
||||
|
||||
## Contact Information
|
||||
We are working on building a community, if you have any ideas about building the community, feel free to contact us. [Discord](https://discord.gg/rBgtJW8U)
|
||||
We are working on building a community, if you have any ideas about building the community, feel free to contact us.
|
||||
[](https://discord.gg/jDD5FwHh)
|
||||
|
||||
<p align="center">
|
||||
<img src="./assets/wechat.jpg" width="300px" />
|
||||
</p>
|
55
README.zh.md
55
README.zh.md
@ -7,9 +7,24 @@
|
||||
<a href="https://github.com/csunny/DB-GPT">
|
||||
<img alt="forks" src="https://img.shields.io/github/forks/csunny/db-gpt?style=social" />
|
||||
</a>
|
||||
<a href="https://opensource.org/licenses/MIT">
|
||||
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
|
||||
</a>
|
||||
<a href="https://github.com/csunny/DB-GPT/releases">
|
||||
<img alt="Release Notes" src="https://img.shields.io/github/release/csunny/DB-GPT" />
|
||||
</a>
|
||||
<a href="https://github.com/csunny/DB-GPT/issues">
|
||||
<img alt="Open Issues" src="https://img.shields.io/github/issues-raw/csunny/DB-GPT" />
|
||||
</a>
|
||||
<a href="https://discord.gg/jDD5FwHh">
|
||||
<img alt="Discord" src="https://dcbadge.vercel.app/api/server/rBgtJW8U?compact=true&style=flat" />
|
||||
</a>
|
||||
<a href="https://codespaces.new/csunny/DB-GPT">
|
||||
<img alt="Open in GitHub Codespaces" src="https://github.com/codespaces/badge.svg" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
[**English**](README.md)|[**Discord**](https://discord.gg/rBgtJW8U) |[**Documents**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/)|[**微信**](https://github.com/csunny/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC)
|
||||
[**English**](README.md)|[**Discord**](https://discord.gg/jDD5FwHh) |[**Documents**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/)|[**微信**](https://github.com/csunny/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC)
|
||||
|
||||
</div>
|
||||
|
||||
@ -19,11 +34,17 @@
|
||||
|
||||
DB-GPT 是一个开源的以数据库为基础的GPT实验项目,使用本地化的GPT大模型与您的数据和环境进行交互,无数据泄露风险,100% 私密
|
||||
|
||||
[](https://star-history.com/#csunny/DB-GPT)
|
||||
|
||||
|
||||
[DB-GPT视频介绍](https://www.bilibili.com/video/BV1SM4y1a7Nj/?buvid=551b023900b290f9497610b2155a2668&is_story_h5=false&mid=%2BVyE%2Fwau5woPcUKieCWS0A%3D%3D&p=1&plat_id=116&share_from=ugc&share_medium=iphone&share_plat=ios&share_session_id=5D08B533-82A4-4D40-9615-7826065B4574&share_source=GENERIC&share_tag=s_i×tamp=1686307943&unique_k=bhO3lgQ&up_id=31375446)
|
||||
## 目录
|
||||
- [安装](#安装)
|
||||
- [效果演示](#效果演示)
|
||||
- [架构方案](#架构方案)
|
||||
- [特性简介](#特性一览)
|
||||
- [贡献](#贡献)
|
||||
- [感谢](#感谢)
|
||||
- [路线图](#路线图)
|
||||
- [联系我们](#联系我们)
|
||||
|
||||
[DB-GPT视频介绍](https://www.bilibili.com/video/BV1au41157bj/)
|
||||
|
||||
## 效果演示
|
||||
|
||||
@ -83,10 +104,12 @@ https://github.com/csunny/DB-GPT/assets/13723926/55f31781-1d49-4757-b96e-7ef6d3d
|
||||
- 非结构化数据支持包括PDF、MarkDown、CSV、WebURL
|
||||
|
||||
- 多模型支持
|
||||
- 支持多种大语言模型, 当前已支持Vicuna(7b,13b), ChatGLM-6b(int4, int8), guanaco(7b,13b,33b), Gorilla(7b,13b)
|
||||
- TODO: codet5p, codegen2
|
||||
- 支持多种大语言模型, 当前已支持Vicuna(7b,13b), ChatGLM-6b(int4, int8), guanaco(7b,13b,33b), Gorilla(7b,13b), 🔥 llama-2(7b, 13b, 70b)
|
||||
- TODO: baichuan(7b, 13b)
|
||||
|
||||
|
||||
[](https://star-history.com/#csunny/DB-GPT)
|
||||
|
||||
## 架构方案
|
||||
DB-GPT基于 [FastChat](https://github.com/lm-sys/FastChat) 构建大模型运行环境,并提供 vicuna 作为基础的大语言模型。此外,我们通过LangChain提供私域知识库问答能力。同时我们支持插件模式, 在设计上原生支持Auto-GPT插件。我们的愿景是让围绕数据库和LLM构建应用程序更加简便和便捷。
|
||||
|
||||
@ -136,12 +159,6 @@ Run the Python interpreter and type the commands:
|
||||
>>> nltk.download()
|
||||
```
|
||||
|
||||
我们提供了全新的的用户界面,可以通过我们的用户界面使用DB-GPT, 同时关于我们项目相关的一些代码跟原理介绍,我们也准备了以下几篇参考文章。
|
||||
1. [大模型实战系列(1) —— 强强联合Langchain-Vicuna应用实战](https://zhuanlan.zhihu.com/p/628750042)
|
||||
2. [大模型实战系列(2) —— DB-GPT 阿里云部署指南](https://zhuanlan.zhihu.com/p/629467580)
|
||||
3. [大模型实战系列(3) —— DB-GPT插件模型原理与使用](https://zhuanlan.zhihu.com/p/629623125)
|
||||
|
||||
|
||||
## 感谢
|
||||
|
||||
项目取得的成果,需要感谢技术社区,尤其以下项目。
|
||||
@ -162,7 +179,9 @@ Run the Python interpreter and type the commands:
|
||||
|
||||
这是一个用于数据库的复杂且创新的工具, 我们的项目也在紧急的开发当中, 会陆续发布一些新的feature。如在使用当中有任何具体问题, 优先在项目下提issue, 如有需要, 请联系如下微信,我会尽力提供帮助,同时也非常欢迎大家参与到项目建设中。
|
||||
|
||||
## Licence
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
# 路线图
|
||||
|
||||
@ -171,12 +190,10 @@ Run the Python interpreter and type the commands:
|
||||
</p>
|
||||
|
||||
## 联系我们
|
||||
微信群已超扫码加群上限, 进群请添加如下微信帮拉进群。
|
||||
|
||||
--------------
|
||||
|xy643854343|mingtian2635|chenB305|cfq1612784863|
|
||||
|-----------|----------|-----------|---------------|
|
||||
## Licence
|
||||
<p align="center">
|
||||
<img src="./assets/wechat.jpg" width="300px" />
|
||||
</p>
|
||||
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 142 KiB After Width: | Height: | Size: 248 KiB |
Loading…
Reference in New Issue
Block a user