🦾 OpenLLM: Self-Hosting LLMs Made Easy

OpenLLM lets developers run any open-source LLMs as OpenAI-compatible API endpoints with a single command.

• 🔬 Build for fast and production usages
• 🚂 Support a wide range of open-source LLMs including llama3, qwen2, gemma, etc and fine-tuned or quantized versions
• ⛓️ OpenAI-compatible API, easy to integrate with any openai dependent Apps
• 💬 Built-in ChatGPT like UI to interact with the LLM directly
• 🔥 Accelerated LLM decoding with state-of-the-art inference backends
• 🌥️ Optionally deploy to K8S or BentoCloud for an enterprise-grade LLM API service

Install OpenLLM with pip. OpenLLM currently supports Python 3.9 and above:

pip install openllm

One can then run:

openllm hello

to explore models interactively. It will guide you to run LLMs either locally or in the cloud.

OpenLLM supports a variety of state-of-the-art LLMs. Here are some of the models supported by OpenLLM, each listed with a commonly used model size.

...

For the full model list, see the OpenLLM models repository.

To start an LLM server locally, use the openllm serve command and specify the model version.

openllm serve llama3:8b

The server will be accessible at http://localhost:3000, providing OpenAI-compatible APIs for interaction. You can call the endpoints with different frameworks and tools that support OpenAI-compatible APIs. Typically, you may need to specify the following:

• The API host address: By default, the LLM is hosted at http://localhost:3000.
• The model name: The name can be different depending on the tool you use.
• The API key: The API key used for client authentication. This is optional.

Here are some examples:

from openai import OpenAI

client = OpenAI(base_url='http://localhost:3000/v1', api_key='na')

# Use the following func to get the available models
# model_list = client.models.list()
# print(model_list)

chat_completion = client.chat.completions.create(
    model="meta-llama/Meta-Llama-3-8B-Instruct",
    messages=[
        {
            "role": "user",
            "content": "Explain superconductors like I'm five years old"
        }
    ],
    stream=True,
)
for chunk in chat_completion:
    print(chunk.choices[0].delta.content or "", end="")

from llama_index.llms.openai import OpenAI

llm = OpenAI(api_bese="http://localhost:3000/v1", model="meta-llama/Meta-Llama-3-8B-Instruct", api_key="dummy")
...

OpenLLM provides a chat user interface (UI) at the /chat endpoint for an LLM server. You can visit the chat UI at http://localhost:3000/chat and start different conversations with the model.

To start a chat conversation in the CLI, use the openllm run command and specify the model version.

openllm run llama3:8b

A model repository in OpenLLM represents a catalog of available LLMs that you can run. OpenLLM provides a default model repository that includes the latest open-source LLMs like Llama 3, Mistral, and Qwen2, hosted at this GitHub repository. To see all available models from the default and any added repository, use:

openllm model list

To ensure your local list of models is synchronized with the latest updates from all connected repositories, run:

openllm repo update

To review a model’s information, run:

openllm model get llama3:8b

You can contribute to the default model repository by adding new models that others can use. This involves creating and submitting a Bento of the LLM. For more information, check out this example pull request.

You can add your own repository to OpenLLM with custom models. To do so, follow the format in the default OpenLLM model repository with a bentos directory to store custom LLMs. You need to build your Bentos with BentoML and submit them to your model repository.

First, prepare your custom models in a bentos directory following the guidelines provided by BentoML to build Bentos. Check out the default model repository for an example and read the Developer Guide for details.

Then, register your custom model repository with OpenLLM:

openllm repo add <repo-name> <repo-url>

Note: Currently, OpenLLM only supports adding public repositories.

OpenLLM supports LLM cloud deployment via BentoML, the unified model serving framework, and BentoCloud, an AI inference platform for enterprise AI teams. BentoCloud provides fully-managed infrastructure optimized for LLM inference with autoscaling, model orchestration, observability, and many more, allowing you to run any AI model in the cloud.

Sign up for BentoCloud for free and log in. Then, run openllm deploy to deploy a model to BentoCloud:

openllm deploy llama3:8b

Once the deployment is complete, you can run model inference on the BentoCloud console:

OpenLLM is actively maintained by the BentoML team. Feel free to reach out and join us in our pursuit to make LLMs more accessible and easy to use 👉 Join our Slack community!

Also, engage with like-minded individuals passionate about LLMs, AI, and more on the OpenLLM Discord!

As an open-source project, we welcome contributions of all kinds, such as new features, bug fixes, and documentation. Here are some of the ways to contribute:

• Repost a bug by creating a GitHub issue.
• Submit a pull request or help review other developers’ pull requests.
• Add an LLM to the OpenLLM default model repository so that other users can run your model. See the pull request template.
• Check out the Developer Guide to learn more.

This project uses the following open-source projects:

• bentoml/bentoml for production level model serving
• blrchen/chatgpt-lite for a fancy Web Chat UI
• chujiezheng/chat_templates
• astral-sh/uv for blazing fast model requirements installing

We are grateful to the developers and contributors of these projects for their hard work and dedication.