documentation and cleanup

This commit is contained in:
Richard Guo
2023-05-11 11:02:44 -04:00
parent 113d04dce3
commit 3368924229
5 changed files with 46 additions and 26 deletions

View File

@@ -1,11 +1,9 @@
# Python GPT4All
This package contains a set of Python bindings that runs the `llmodel` C-API.
This package contains a set of Python bindings around the `llmodel` C-API.
# Local Installation Instructions
TODO: Right now instructions in main README still depend on Qt6 setup. To setup Python bindings, we just need `llmodel` to be built which is much simpler. However, in the future, the below installation instructions should be sequentially organized such that we expect the main README's instructions were followed first.
## Local Build Instructions
1. Setup `llmodel`
@@ -23,7 +21,6 @@ Confirm that `libllmodel.*` exists in `gpt4all-backend/llmodel/build`.
```
cd ../../gpt4all-bindings/python
pip3 install -r requirements.txt
pip3 install -e .
```