From d0e4da64440954b84a32d51970564a61dd14d685 Mon Sep 17 00:00:00 2001 From: junewgl <45283002+junewgl@users.noreply.github.com> Date: Tue, 2 Jan 2024 14:49:36 +0800 Subject: [PATCH] docs: add paper link and citation (#1006) --- README.md | 16 +++++++++------- README.zh.md | 15 ++++++++------- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 09d0701b3..f0102762d 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,8 @@
-[**简体中文**](README.zh.md) | [**Discord**](https://discord.gg/7uQnPuveTY) | [**Documents**](https://docs.dbgpt.site) | [**Wechat**](https://github.com/eosphoros-ai/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) | [**Community**](https://github.com/eosphoros-ai/community) +[**简体中文**](README.zh.md) | [**Discord**](https://discord.gg/7uQnPuveTY) | [**Documents**](https://docs.dbgpt.site) | [**Wechat**](https://github.com/eosphoros-ai/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) | [**Community**](https://github.com/eosphoros-ai/community) | [**Paper**](https://arxiv.org/pdf/2312.17449.pdf) + ## What is DB-GPT? @@ -255,14 +256,15 @@ As of October 10, 2023, through the fine-tuning of an open-source model with 13 The MIT License (MIT) ## Citation -Please consider citing our project if you find it useful: +If you find `DB-GPT` useful for your research or development, please cite the following paper: ```bibtex -@software{db-gpt, - author = {DB-GPT Team}, - title = {{DB-GPT}}, - url = {https://github.com/eosphoros-ai/DB-GPT}, - year = {2023} +@article{xue2023dbgpt, + title={DB-GPT: Empowering Database Interactions with Private Large Language Models}, + author={Siqiao Xue and Caigao Jiang and Wenhui Shi and Fangyin Chen and Keting Chen and Hongjun Yang and Zhiping Zhang and Jianshan He and Hongyang Zhang and Ganglin Wei and Wang Zhao and Fan Zhou and Danrui Qi and Hong Yi and Shaodong Liu and Faqiang Chen}, + year={2023}, + journal={arXiv preprint arXiv:2312.17449}, + url={https://arxiv.org/abs/2312.17449} } ``` diff --git a/README.zh.md b/README.zh.md index 6bb1028a7..5ee50f194 100644 --- a/README.zh.md +++ b/README.zh.md @@ -30,7 +30,7 @@ -[**English**](README.md)|[**Discord**](https://discord.gg/7uQnPuveTY)|[**文档**](https://www.yuque.com/eosphoros/dbgpt-docs/bex30nsv60ru0fmx)|[**微信**](https://github.com/csunny/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC)|[**社区**](https://github.com/eosphoros-ai/community) +[**English**](README.md) | [**Discord**](https://discord.gg/7uQnPuveTY) | [**文档**](https://www.yuque.com/eosphoros/dbgpt-docs/bex30nsv60ru0fmx) | [**微信**](https://github.com/csunny/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) | [**社区**](https://github.com/eosphoros-ai/community) | [**Paper**](https://arxiv.org/pdf/2312.17449.pdf) ## DB-GPT 是什么? @@ -290,14 +290,15 @@ The MIT License (MIT) [More Information about Text2SQL finetune](https://github.com/eosphoros-ai/DB-GPT-Hub) ## 引用 -如果您觉得我们的项目有用,请考虑引用我们的项目: +如果您发现`DB-GPT`对您的研究或开发有用,请引用以下论文: ```bibtex -@software{db-gpt, - author = {DB-GPT Team}, - title = {{DB-GPT}}, - url = {https://github.com/eosphoros-ai/DB-GPT}, - year = {2023} +@article{xue2023dbgpt, + title={DB-GPT: Empowering Database Interactions with Private Large Language Models}, + author={Siqiao Xue and Caigao Jiang and Wenhui Shi and Fangyin Chen and Keting Chen and Hongjun Yang and Zhiping Zhang and Jianshan He and Hongyang Zhang and Ganglin Wei and Wang Zhao and Fan Zhou and Danrui Qi and Hong Yi and Shaodong Liu and Faqiang Chen}, + year={2023}, + journal={arXiv preprint arXiv:2312.17449}, + url={https://arxiv.org/abs/2312.17449} } ```