与 HuggingFace 集成

与 HuggingFace 集成#

本文档描述了 vLLM 如何与 HuggingFace 库集成。我们将逐步解释当我们运行 vllm serve 时幕后会发生什么。

假设我们想要通过运行 vllm serve Qwen/Qwen2-7B 来服务流行的 QWen 模型。

  1. model 参数是 Qwen/Qwen2-7B。vLLM 通过检查相应的配置文件 config.json 来确定此模型是否存在。请参阅此代码片段以了解具体实现。在此过程中

    • 如果 model 参数对应于现有的本地路径，vLLM 将直接从此路径加载配置文件。

    • 如果 model 参数是由用户名和模型名称组成的 HuggingFace 模型 ID，vLLM 将首先尝试使用 HuggingFace 本地缓存中的配置文件，使用 model 参数作为模型名称，--revision 参数作为修订版本。有关 HuggingFace 缓存如何工作的更多信息，请参阅他们的网站。

    • 如果 model 参数是 HuggingFace 模型 ID，但在缓存中未找到，vLLM 将从 HuggingFace 模型 Hub 下载配置文件。有关具体实现，请参阅此函数。输入参数包括 model 参数作为模型名称，--revision 参数作为修订版本，以及环境变量 HF_TOKEN 作为访问模型 Hub 的令牌。在我们的例子中，vLLM 将下载 config.json 文件。

  2. 在确认模型存在后，vLLM 加载其配置文件并将其转换为字典。有关具体实现，请参阅此代码片段。

  3. 接下来，vLLM 检查配置字典中的 model_type 字段，以生成要使用的配置对象。vLLM 直接支持一些 model_type 值；请参阅此处以获取列表。如果 model_type 不在列表中，vLLM 将使用 AutoConfig.from_pretrained 加载配置类，参数为 model、--revision 和 --trust_remote_code。请注意

    • HuggingFace 也有其自己的逻辑来确定要使用的配置类。它将再次使用 model_type 字段在 transformers 库中搜索类名；请参阅此处以获取支持模型的列表。如果找不到 model_type，HuggingFace 将使用配置 JSON 文件中的 auto_map 字段来确定类名。具体来说，它是 auto_map 下的 AutoConfig 字段。有关示例，请参阅DeepSeek。

    • auto_map 下的 AutoConfig 字段指向模型仓库中的模块路径。为了创建配置类，HuggingFace 将导入模块并使用 from_pretrained 方法加载配置类。这通常可能导致任意代码执行，因此仅在启用 --trust_remote_code 时执行。

  4. 随后，vLLM 将一些历史补丁应用于配置对象。这些主要与 RoPE 配置相关；有关具体实现，请参阅此处。

  5. 最后，vLLM 可以访问我们要初始化的模型类。vLLM 使用配置对象中的 architectures 字段来确定要初始化的模型类，因为它在其注册表中维护了从架构名称到模型类的映射。如果在注册表中找不到架构名称，则表示 vLLM 不支持此模型架构。对于 Qwen/Qwen2-7B，architectures 字段是 ["Qwen2ForCausalLM"]，它对应于 vLLM 代码中的 Qwen2ForCausalLM 类。此类将根据各种配置自行初始化。

除此之外，vLLM 还在两个方面依赖 HuggingFace。

  1. 分词器：vLLM 使用 HuggingFace 的分词器来对输入文本进行分词。分词器使用 AutoTokenizer.from_pretrained 加载，其中 model 参数作为模型名称，--revision 参数作为修订版本。也可以通过在 vllm serve 命令中指定 --tokenizer 参数来使用来自另一个模型的分词器。其他相关参数包括 --tokenizer-revision 和 --tokenizer-mode。请查看 HuggingFace 的文档以了解这些参数的含义。此部分逻辑可以在get_tokenizer 函数中找到。值得注意的是，在获得分词器后，vLLM 会在 get_cached_tokenizer 中缓存分词器的一些昂贵属性。

  2. 模型权重：vLLM 使用 model 参数作为模型名称，--revision 参数作为修订版本，从 HuggingFace 模型 Hub 下载模型权重。vLLM 提供了参数 --load-format 来控制从模型 Hub 下载哪些文件。默认情况下，它将尝试加载 safetensors 格式的权重，如果 safetensors 格式不可用，则回退到 PyTorch bin 格式。我们也可以传递 --load-format dummy 以跳过下载权重。

    • 建议使用 safetensors 格式，因为它在分布式推理中加载效率高，并且可以防止任意代码执行。有关 safetensors 格式的更多信息，请参阅文档。此部分逻辑可以在此处找到。请注意

这完成了 vLLM 和 HuggingFace 之间的集成。

总而言之，vLLM 从 HuggingFace 模型 Hub 或本地目录读取配置文件 config.json、分词器和模型权重。它使用来自 vLLM、HuggingFace transformers 的配置类，或者从模型的仓库加载配置类。