vllm/docs/source/models/supported_models.rst

73 lines
3.1 KiB
ReStructuredText
Raw Normal View History

2023-06-02 22:35:17 -07:00
.. _supported_models:
Supported Models
================
vLLM supports a variety of generative Transformer models in `HuggingFace Transformers <https://huggingface.co/models>`_.
2023-06-17 03:07:40 -07:00
The following is the list of model architectures that are currently supported by vLLM.
2023-06-02 22:35:17 -07:00
Alongside each architecture, we include some popular models that use it.
.. list-table::
:widths: 25 25 50
2023-06-02 22:35:17 -07:00
:header-rows: 1
* - Architecture
- Models
- Example HuggingFace Models
2023-08-22 11:51:44 -07:00
* - :code:`AquilaForCausalLM`
- Aquila
2023-08-22 11:51:44 -07:00
- :code:`BAAI/Aquila-7B`, :code:`BAAI/AquilaChat-7B`, etc.
2023-07-25 15:25:12 -07:00
* - :code:`BaiChuanForCausalLM`
- Baichuan
2023-08-14 11:57:31 +08:00
- :code:`baichuan-inc/Baichuan-7B`, :code:`baichuan-inc/Baichuan-13B-Chat`, etc.
2023-07-03 13:12:35 -07:00
* - :code:`BloomForCausalLM`
- BLOOM, BLOOMZ, BLOOMChat
- :code:`bigscience/bloom`, :code:`bigscience/bloomz`, etc.
2023-08-02 14:04:39 -07:00
* - :code:`FalconForCausalLM`
- Falcon
- :code:`tiiuae/falcon-7b``, :code:`tiiuae/falcon-40b`, :code:`tiiuae/falcon-rw-7b`, etc.
2023-06-02 22:35:17 -07:00
* - :code:`GPT2LMHeadModel`
- GPT-2
- :code:`gpt2`, :code:`gpt2-xl`, etc.
* - :code:`GPTBigCodeForCausalLM`
- StarCoder, SantaCoder, WizardCoder
- :code:`bigcode/starcoder`, :code:`bigcode/gpt_bigcode-santacoder`, :code:`WizardLM/WizardCoder-15B-V1.0`, etc.
* - :code:`GPTJForCausalLM`
- GPT-J
- :code:`EleutherAI/gpt-j-6b`, :code:`nomic-ai/gpt4all-j`, etc.
2023-06-02 22:35:17 -07:00
* - :code:`GPTNeoXForCausalLM`
- GPT-NeoX, Pythia, OpenAssistant, Dolly V2, StableLM
- :code:`EleutherAI/gpt-neox-20b`, :code:`EleutherAI/pythia-12b`, :code:`OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5`, :code:`databricks/dolly-v2-12b`, :code:`stabilityai/stablelm-tuned-alpha-7b`, etc.
2023-08-22 11:51:44 -07:00
* - :code:`InternLMForCausalLM`
- InternLM
- :code:`internlm/internlm-7b`, :code:`internlm/internlm-chat-7b`, etc.
2023-06-02 22:35:17 -07:00
* - :code:`LlamaForCausalLM`
2023-07-20 11:38:27 -07:00
- LLaMA, LLaMA-2, Vicuna, Alpaca, Koala, Guanaco
- :code:`meta-llama/Llama-2-13b-hf`, :code:`meta-llama/Llama-2-70b-hf`, :code:`openlm-research/open_llama_13b`, :code:`lmsys/vicuna-13b-v1.3`, :code:`young-geng/koala`, etc.
2023-07-03 16:51:47 -07:00
* - :code:`MPTForCausalLM`
2023-07-03 16:47:53 -07:00
- MPT, MPT-Instruct, MPT-Chat, MPT-StoryWriter
- :code:`mosaicml/mpt-7b`, :code:`mosaicml/mpt-7b-storywriter`, :code:`mosaicml/mpt-30b`, etc.
2023-06-02 22:35:17 -07:00
* - :code:`OPTForCausalLM`
- OPT, OPT-IML
- :code:`facebook/opt-66b`, :code:`facebook/opt-iml-max-30b`, etc.
* - :code:`QWenLMHeadModel`
2023-08-22 11:51:44 -07:00
- Qwen
- :code:`Qwen/Qwen-7B`, :code:`Qwen/Qwen-7B-Chat`, etc.
2023-06-02 22:35:17 -07:00
2023-06-17 03:07:40 -07:00
If your model uses one of the above model architectures, you can seamlessly run your model with vLLM.
2023-06-02 22:35:17 -07:00
Otherwise, please refer to :ref:`Adding a New Model <adding_a_new_model>` for instructions on how to implement support for your model.
2023-06-19 20:03:40 -07:00
Alternatively, you can raise an issue on our `GitHub <https://github.com/vllm-project/vllm/issues>`_ project.
2023-06-02 22:35:17 -07:00
.. tip::
The easiest way to check if your model is supported is to run the program below:
.. code-block:: python
2023-06-17 03:07:40 -07:00
from vllm import LLM
2023-06-02 22:35:17 -07:00
llm = LLM(model=...) # Name or path of your model
output = llm.generate("Hello, my name is")
print(output)
2023-06-17 03:07:40 -07:00
If vLLM successfully generates text, it indicates that your model is supported.