Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 4.49 KB

DEVELOPMENT.md

File metadata and controls

113 lines (79 loc) · 4.49 KB
Raw

Developer Guide

This Developer Guide is designed to help you contribute to the OpenLLM project. Follow these steps to set up your development environment and learn the process of contributing to our open-source project.

Join our Discord Channel and reach out to us if you have any question!

Table of Contents

Setting Up Your Development Environment

Before you can start developing, you'll need to set up your environment:

  1. Ensure you have Git, and Python3.8+ installed.

  2. Fork the OpenLLM repository from GitHub.

  3. Clone the forked repository from GitHub:

    git clone git@github.com:username/OpenLLM.git && cd openllm

  4. Add the OpenLLM upstream remote to your local OpenLLM clone:

    git remote add upstream git@github.com:bentoml/OpenLLM.git

  5. Configure git to pull from the upstream remote:

    git switch main # ensure you're on the main branch
git fetch upstream --tags
git branch --set-upstream-to=upstream/main

  6. (Optional) Link .python-version-default to .python-version:

    ln .python-version-default .python-version

Development Workflow

There are a few ways to contribute to the repository structure for OpenLLM:

Adding new models

  1. recipe.yaml contains all related-metadata for generating new LLM-based bentos. To add a new LLM, the following structure should be adhere to:
"<model_name>:<model_tag>":
  project: vllm-chat
  service_config:
    name: phi3
    traffic:
      timeout: 300
    resources:
      gpu: 1
      gpu_type: nvidia-tesla-l4
  engine_config:
    model: microsoft/Phi-3-mini-4k-instruct
    max_model_len: 4096
    dtype: half
  chat_template: phi-3

  • <model_name> represents the type of model to be supported. Currently supports phi3, llama2, llama3, gemma

  • <model_tag> emphasizes the type of model and its related metadata. The convention would include <model_size>-<model_type>-<precision>[-<quantization>] For example:

    • microsoft/Phi-3-mini-4k-instruct should be represented as 3.8b-instruct-fp16.
    • TheBloke/Llama-2-7B-Chat-AWQ would be 7b-chat-awq-4bit

  • project would be used as the basis for the generated bento. Currently, most models should use vllm-chat as default.

  • service_config entails all BentoML-related configuration to run this bento.

Note

We recommend to include the following field for service_config:

  • name should be the same as <model_name>
  • resources includes the available accelerator that can run this models. See more here

  • engine_config are fields to be used for vLLM engine. See more supported arguments in AsyncEngineArgs. We recommend to always include model, max_model_len, dtype and trust_remote_code.

  • If the model is a chat model, chat_template should be used. Add the appropriate chat_template under chat_template directory should you decide to do so.

  1. You can then run BENTOML_HOME=$(openllm repo default)/bentoml/bentos python make.py <model_name>:<model_tag> to generate the required bentos.

  2. You can then submit a Pull request to openllm with the recipe changes

Adding bentos

OpenLLM now also manages a generated bento repository. If you update and modify and generated bentos, make sure to update the recipe and added the generated bentos under bentoml/bentos.

Adding repos

If you wish to create a your own managed git repo, you should follow the structure of bentoml/openllm-models.

To add your custom repo, do openllm repo add <repo_alias> <git_url>