Skip to content
Snippets Groups Projects
Unverified Commit 3418b11a authored by Jerry Liu's avatar Jerry Liu Committed by GitHub
Browse files

add setup files to build python package (#35)

parent efb2c7e3
No related branches found
No related tags found
No related merge requests found
include gpt_index/py.typed
include gpt_index/VERSION
include LICENSE
\ No newline at end of file
...@@ -18,14 +18,12 @@ That's where the **GPT Index** data structures come in. Instead of relying on wo ...@@ -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. 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 ## 💻 Example Usage
```
pip install gpt-index
```
Examples are in the `examples` folder. Indices are in the `indices` folder (see list of indices below). 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: To build a tree index do the following:
...@@ -48,6 +46,13 @@ To query, ...@@ -48,6 +46,13 @@ To query,
index.query("<question_text>?", child_branch_factor=1) 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 ## Index Details
......
0.0.3 0.0.4
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment