From b9a4513363267dcc1f4b77d709ac3333fc889c6e Mon Sep 17 00:00:00 2001 From: Andrei Betlen Date: Sun, 2 Apr 2023 21:03:39 -0400 Subject: [PATCH] Update README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 6e631b0..de08def 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,33 @@ pip install llama-cpp-python } ``` +# Documentation + +Documentation is available at [https://abetlen.github.io/llama-cpp-python](https://abetlen.github.io/llama-cpp-python). +If you find any issues with the documentation, please open an issue or submit a PR. + +# Development + +This package is under active development and I welcome any contributions. + +To get started, clone the repository and install the package in development mode: + +```bash +git clone git@github.com:abetlen/llama-cpp-python.git +git submodule update --init --recursive +# Will need to be re-run any time vendor/llama.cpp is updated +python3 setup.py develop +``` + +# How does this compare to other Python bindings of `llama.cpp`? + +I wrote this package for my own use, I had two goals in mind: + +- Provide a simple process to install `llama.cpp` and access the full C API in `llama.h` from Python +- Provide a high-level Python API that can be used as a drop-in replacement for the OpenAI API so existing apps can be easily ported to use `llama.cpp` + +Any contributions and changes to this package will be made with these goals in mind. + # License This project is licensed under the terms of the MIT license.