Skip to content

Commit

Permalink
docs: Update README to have better links
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasyager committed Sep 8, 2023
1 parent 21e4ffb commit 9eeb951
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![pypi version shield](https://img.shields.io/pypi/v/llama-cpp-guidance)](https://img.shields.io/pypi/v/llama-cpp-guidance)

The `llama-cpp-guidance` package provides an LLM client compatibility layer between `llama-cpp-python` and `guidance`.
The `llama-cpp-guidance` package provides an LLM client compatibility layer between [llama-cpp-python] and [guidance].

## Installation

Expand All @@ -12,6 +12,9 @@ The `llama-cpp-guidance` package can be installed using pip.
pip install llama-cpp-guidance
```

> [!INFO]
> It is highly recommended that you follow the installation instructions for [llama-cpp-python] after installing `llama-cpp-guidance` to ensure that you have hardware acceleration setup appropriately.
## Basic Usage

Once installed, you can use the `LlamaCpp` class like any other guidance-compatible LLM class.
Expand All @@ -37,3 +40,6 @@ print(output)
```console
The best thing about the beach is that there’s always something to do.
```

[llama-cpp-python]: https://github.com/abetlen/llama-cpp-python/
[guidance]: https://github.com/guidance-ai/guidance/

0 comments on commit 9eeb951

Please sign in to comment.