From 57db1f957029a649e9d0f6d1f5934744a6fa58f3 Mon Sep 17 00:00:00 2001 From: Andrei Betlen Date: Tue, 18 Jul 2023 20:26:25 -0400 Subject: [PATCH] Update development docs for scikit-build-core. Closes #490 --- README.md | 11 ++++++++++- docs/index.md | 5 ++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8145902..2b564de 100644 --- a/README.md +++ b/README.md @@ -190,17 +190,26 @@ If you find any issues with the documentation, please open an issue or submit a This package is under active development and I welcome any contributions. -To get started, clone the repository and install the package in development mode: +To get started, clone the repository and install the package in editable / development mode: ```bash git clone --recurse-submodules git@github.com:abetlen/llama-cpp-python.git cd llama-cpp-python +# Upgrade pip (required for editable mode) +pip install --upgrade pip + # Install with pip pip install -e . # if you want to use the fastapi / openapi server pip install -e .[server] + +# to install all optional dependencies +pip install -e .[all] + +# to clear the local build cache +make clean ``` # How does this compare to other Python bindings of `llama.cpp`? diff --git a/docs/index.md b/docs/index.md index 7d5ccc3..e820b5f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -82,9 +82,12 @@ To get started, clone the repository and install the package in development mode ```bash git clone git@github.com:abetlen/llama-cpp-python.git +cd llama-cpp-python git submodule update --init --recursive # Will need to be re-run any time vendor/llama.cpp is updated -python3 setup.py develop + +pip install --upgrade pip +pip install -e .[all] ``` ## License