From 3418b11a5ae07454e59390c70fe7fd63145e23ba Mon Sep 17 00:00:00 2001 From: Jerry Liu <jerryjliu98@gmail.com> Date: Tue, 22 Nov 2022 01:11:01 -0800 Subject: [PATCH] add setup files to build python package (#35) --- MANIFEST.in | 3 +++ README.md | 17 +++++++++++------ gpt_index/VERSION | 2 +- gpt_index/indices/keyword_table/__init__.py | 0 gpt_index/indices/list/__init__.py | 0 gpt_index/indices/tree/__init__.py | 0 gpt_index/py.typed | 0 7 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 MANIFEST.in create mode 100644 gpt_index/indices/keyword_table/__init__.py create mode 100644 gpt_index/indices/list/__init__.py create mode 100644 gpt_index/indices/tree/__init__.py create mode 100644 gpt_index/py.typed diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000000..567a63cc13 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include gpt_index/py.typed +include gpt_index/VERSION +include LICENSE \ No newline at end of file diff --git a/README.md b/README.md index 7b5d0b928f..231d9d4efa 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,12 @@ That's where the **GPT Index** data structures come in. Instead of relying on wo The high-level design exercise of this project is to test the capability of GPT-3 as a general-purpose processor to organize and retrieve data. From our current understanding, related works have used GPT-3 to reason with external db sources (see below); this work links reasoning with knowledge building. -## 🔧 Dependencies - -The main third-party package requirements are `transformers`, `openai`, and `langchain`. - -All requirements should be contained within the `setup.py` file. To run the package locally without building the wheel, simply do `pip install -r requirements.txt`. - ## 💻 Example Usage +``` +pip install gpt-index +``` + Examples are in the `examples` folder. Indices are in the `indices` folder (see list of indices below). To build a tree index do the following: @@ -48,6 +46,13 @@ To query, index.query("<question_text>?", child_branch_factor=1) ``` +## 🔧 Dependencies + +The main third-party package requirements are `transformers`, `openai`, and `langchain`. + +All requirements should be contained within the `setup.py` file. To run the package locally without building the wheel, simply do `pip install -r requirements.txt`. + + ## Index Details diff --git a/gpt_index/VERSION b/gpt_index/VERSION index bcab45af15..81340c7e72 100644 --- a/gpt_index/VERSION +++ b/gpt_index/VERSION @@ -1 +1 @@ -0.0.3 +0.0.4 diff --git a/gpt_index/indices/keyword_table/__init__.py b/gpt_index/indices/keyword_table/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/gpt_index/indices/list/__init__.py b/gpt_index/indices/list/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/gpt_index/indices/tree/__init__.py b/gpt_index/indices/tree/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/gpt_index/py.typed b/gpt_index/py.typed new file mode 100644 index 0000000000..e69de29bb2 -- GitLab