From 4021e9a597b88cb0f211ffd29121f20fa83f934d Mon Sep 17 00:00:00 2001
From: csunny <cfqsunny@163.com>
Date: Wed, 24 May 2023 21:59:04 +0800
Subject: [PATCH] docs: add docs for db-gpt

---
 docs/conf.py   | 10 +++++++++-
 docs/index.rst | 21 +++++++++++++++++++++
 pyproject.toml | 38 ++++++++++++++++++++++++++++++++++++--
 3 files changed, 66 insertions(+), 3 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index f09019218..1aef5c03e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -6,10 +6,18 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+import toml
+
 project = 'DB-GPT'
 copyright = '2023, csunny'
 author = 'csunny'
-release = '0.0.6'
+
+with open("../pyproject.toml") as f:
+    data = toml.load(f)
+
+version = data["tool"]["poetry"]["version"]
+release = version
+html_title = project + " " + version
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
diff --git a/docs/index.rst b/docs/index.rst
index 95877b81d..603ac2049 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,6 +9,27 @@ Welcome to DB-GPT!
 
 | **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.
 
+| **Features**
+Currently, we have released multiple key features, which are listed below to demonstrate our current capabilities:
+
+- SQL language capabilities
+  - SQL generation
+  - SQL diagnosis
+
+- Private domain Q&A and data processing
+  - Database knowledge Q&A
+  - Data processing
+
+- Plugins
+  - Support custom plugin execution tasks and natively support the Auto-GPT plugin, such as:
+
+- Unified vector storage/indexing of knowledge base
+  - Support for unstructured data such as PDF, Markdown, CSV, and WebURL
+
+- Milti LLMs Support
+  - Supports multiple large language models, currently supporting Vicuna (7b, 13b), ChatGLM-6b (int4, int8)
+  - TODO: codegen2, codet5p
+
 Getting Started
 -----------------
 | How to get started using DB-GPT to interact with your data and environment.
diff --git a/pyproject.toml b/pyproject.toml
index c335294f0..12834cedd 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,15 +1,49 @@
 [tool.poetry]
 name = "db-gpt"
 version = "0.0.6"
-description = ""
-authors = ["csunny <cfqsunny@163.com>"]
+description = "Interact with your data and environment privately"
+authors = []
 readme = "README.md"
+license = "MIT"
 packages = [{include = "db_gpt"}]
+repository = "https://www.github.com/csunny/DB-GPT"
 
 [tool.poetry.dependencies]
 python = "^3.10"
+accelerate = "^0.16"
 
 
+[tool.poetry.group.docs.dependencies]
+autodoc_pydantic = "^1.8.0"
+myst_parser = "^0.18.1"
+nbsphinx = "^0.8.9"
+sphinx = "^4.5.0"
+sphinx-autobuild = "^2021.3.14"
+sphinx_book_theme = "^0.3.3"
+sphinx_rtd_theme = "^1.0.0"
+sphinx-typlog-theme = "^0.8.0"
+sphinx-panels = "^0.6.0"
+toml = "^0.10.2"
+myst-nb = "^0.17.1"
+linkchecker = "^10.2.1"
+sphinx-copybutton = "^0.5.1"
+
+[tool.poetry.group.test.dependencies]
+# The only dependencies that should be added are
+# dependencies used for running tests (e.g., pytest, freezegun, response).
+# Any dependencies that do not meet that criteria will be removed.
+pytest = "^7.3.0"
+pytest-cov = "^4.0.0"
+pytest-dotenv = "^0.5.2"
+duckdb-engine = "^0.7.0"
+pytest-watcher = "^0.2.6"
+freezegun = "^1.2.2"
+responses = "^0.22.0"
+pytest-asyncio = "^0.20.3"
+lark = "^1.1.5"
+pytest-mock  = "^3.10.0"
+pytest-socket = "^0.6.0"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"