Skip to main content

ESA Local-LLM is a llama.cpp server in Docker with OpenAI Style Endpoints.

Project description

ESA Local-LLM

ESA Local-LLM is a llama.cpp server in Docker with OpenAI Style Endpoints that allows you to send the model name as the name of the model as it appears in the model list, for example Mistral-7B-OpenOrca. It will automatically download the model from Hugging Face if it isn't already downloaded and configure the server for you. It automatically configures the server based on your CPU, RAM, and GPU. It is designed to be as easy as possible to get started with running local models.

Table of Contents 📖

Run with Docker

You can choose to run with Docker or Docker Compose. Both are not needed. Instructions to run with Docker Compose can be found here.

Replace the environment variables with your desired settings. Assumptions will be made on all of these values if you choose to accept the defaults.

  • ESA_LOCAL_LLM_API_KEY - The API key to use for the server. If not set, the server will not require an API key.
  • THREADS - The number of threads to use. Default is your CPU core count minus 1.

The following are only applicable to NVIDIA GPUs:

  • GPU_LAYERS - The number of layers to use on the GPU. Default is 0.
  • MAIN_GPU - The GPU to use for the main model. Default is 0.

Prerequisites

Run without NVIDIA GPU support

docker pull experian-sales-advisor/esa-local-llm:cpu
docker run -d --name esa-local-llm -p 8091:8091 experian-sales-advisor/esa-local-llm:cpu -e THREADS="10" -e ESA_LOCAL_LLM_API_KEY=""

Run with NVIDIA GPU support

If you're using an NVIDIA GPU, you can use the CUDA version of the server. You must have the NVIDIA Container Toolkit installed if using NVIDIA GPU.

docker pull experian-sales-advisor/esa-local-llm:cuda
docker run -d --name esa-local-llm -p 8091:8091 --gpus all experian-sales-advisor/esa-local-llm:cuda -e THREADS="10" -e GPU_LAYERS="0" -e MAIN_GPU="0" -e ESA_LOCAL_LLM_API_KEY=""

OpenAI Style Endpoint Usage

OpenAI Style endpoints available at http://localhost:8091/ by default. Documentation can be accessed at that url when the server is running. There are examples for each of the endpoints in the Examples Jupyter Notebook.

Shout Outs

  • ggerganov/llama.cpp - For constantly improving the ability for anyone to run local models. It is one of my favorite and most exciting projects on GitHub.
  • abetlen/llama-cpp-python - For making it easy to extend the functionality of llama.cpp in Python.
  • TheBloke - For helping enable the ability to run local models by quantizing them and sharing them with a great readme on how to use them in every repository.
  • Meta - For the absolutely earth shattering open source releases of the LLaMa models and all other contributions they have made to Open Source.
  • OpenAI - For setting good standards for endpoints and making great models.
  • Hugging Face - For making it easy to use and share models.
  • As much as I hate to do it, I can't list all of the amazing people building and fine tuning local models, but you know who you are. Thank you for all of your hard work and contributions to the community!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

esa-local-llm-0.0.14.tar.gz (57.3 kB view details)

Uploaded Source

Built Distribution

esa_local_llm-0.0.14-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file esa-local-llm-0.0.14.tar.gz.

File metadata

  • Download URL: esa-local-llm-0.0.14.tar.gz
  • Upload date:
  • Size: 57.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for esa-local-llm-0.0.14.tar.gz
Algorithm Hash digest
SHA256 2d9a3005de4d1769c02c2512eb2b13df93bf1b399c84880130a7274d4a7df260
MD5 300dfc0c936fefc3ccadd02592dcdf30
BLAKE2b-256 85b8ef12f13f6b24f7d39377c00fed7c75974bb52ed0abc643778f5ae4132d59

See more details on using hashes here.

File details

Details for the file esa_local_llm-0.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for esa_local_llm-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 0b80472596ad451296bfc301a02e566d9992d6c434fc09b350fa27e7db9470cc
MD5 44195e06f1e3664afa31134a763d74fa
BLAKE2b-256 ba7d7ddfd220c9f9e3af9036ee0a5c37aeea465eeeda044b551d08031a20712b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page