82 lines
No EOL
2.2 KiB
Markdown
82 lines
No EOL
2.2 KiB
Markdown
# 🦙 Python Bindings for `llama.cpp`
|
|
|
|
[](https://pypi.org/project/llama-cpp-python/)
|
|
[](https://pypi.org/project/llama-cpp-python/)
|
|
[](https://pypi.org/project/llama-cpp-python/)
|
|
[](https://pypi.org/project/llama-cpp-python/)
|
|
|
|
Simple Python bindings for **@ggerganov's** [`llama.cpp`](https://github.com/ggerganov/llama.cpp) library.
|
|
This package provides:
|
|
|
|
- Low-level access to C API via `ctypes` interface.
|
|
- High-level Python API for text completion
|
|
- OpenAI-like API
|
|
- LangChain compatibility
|
|
|
|
## Installation
|
|
|
|
Install from PyPI:
|
|
|
|
```bash
|
|
pip install llama-cpp-python
|
|
```
|
|
|
|
## Usage
|
|
|
|
```python
|
|
>>> from llama_cpp import Llama
|
|
>>> llm = Llama(model_path="models/7B/...")
|
|
>>> output = llm("Q: Name the planets in the solar system? A: ", max_tokens=32, stop=["Q:", "\n"], echo=True)
|
|
>>> print(output)
|
|
{
|
|
"id": "cmpl-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
"object": "text_completion",
|
|
"created": 1679561337,
|
|
"model": "models/7B/...",
|
|
"choices": [
|
|
{
|
|
"text": "Q: Name the planets in the solar system? A: Mercury, Venus, Earth, Mars, Jupiter, Saturn, Uranus, Neptune and Pluto.",
|
|
"index": 0,
|
|
"logprobs": None,
|
|
"finish_reason": "stop"
|
|
}
|
|
],
|
|
"usage": {
|
|
"prompt_tokens": 14,
|
|
"completion_tokens": 28,
|
|
"total_tokens": 42
|
|
}
|
|
}
|
|
```
|
|
|
|
## Development
|
|
|
|
```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
|
|
```
|
|
|
|
## API Reference
|
|
|
|
::: llama_cpp.Llama
|
|
options:
|
|
members:
|
|
- __init__
|
|
- tokenize
|
|
- detokenize
|
|
- create_embedding
|
|
- create_completion
|
|
- __call__
|
|
- token_bos
|
|
- token_eos
|
|
show_root_heading: true
|
|
|
|
::: llama_cpp.llama_cpp
|
|
options:
|
|
show_if_no_docstring: true
|
|
|
|
## License
|
|
|
|
This project is licensed under the terms of the MIT license. |