更新时间:2024-12-17 GMT+08:00
分享

非分离部署推理服务

本章节介绍如何使用vLLM 0.6.3框架部署并启动推理服务。

什么是非分离部署

全量推理和增量推理在同一节点上进行。

前提条件

  • 已准备好DevServer环境,具体参考资源规格要求。推荐使用“西南-贵阳一”Region上的DevServer和昇腾Snt9b资源。
  • 安装过程需要连接互联网git clone,确保容器可以访问公网。

步骤一 检查环境

  1. SSH登录机器后,检查NPU设备检查。运行如下命令,返回NPU设备信息。
    npu-smi info                    # 在每个实例节点上运行此命令可以看到NPU卡状态
    npu-smi info -l | grep Total    # 在每个实例节点上运行此命令可以看到总卡数,用来确认对应卡数已经挂载
    npu-smi info -t board -i 1 | egrep -i "software|firmware"   #查看驱动和固件版本

    如出现错误,可能是机器上的NPU设备没有正常安装,或者NPU镜像被其他容器挂载。请先正常安装固件和驱动,或释放被挂载的NPU。

    驱动版本要求是23.0.6。如果不符合要求请参考安装固件和驱动章节升级驱动。

  2. 检查docker是否安装。
    docker -v   #检查docker是否安装

    如尚未安装,运行以下命令安装docker。

    yum install -y docker-engine.aarch64 docker-engine-selinux.noarch docker-runc.aarch64
  3. 配置IP转发,用于容器内的网络访问。执行以下命令查看net.ipv4.ip_forward配置项的值,如果为1,可跳过此步骤。
    sysctl -p | grep net.ipv4.ip_forward
    如果net.ipv4.ip_forward配置项的值不为1,执行以下命令配置IP转发。
    sed -i 's/net\.ipv4\.ip_forward=0/net\.ipv4\.ip_forward=1/g' /etc/sysctl.conf
    sysctl -p | grep net.ipv4.ip_forward

步骤二 获取基础镜像

建议使用官方提供的镜像部署推理服务。镜像地址{image_url}获取请参见表1

docker pull {image_url}

步骤三 上传代码包和权重文件

  1. 上传安装依赖软件推理代码AscendCloud-LLM-6.3.911-xxx.zip和算子包AscendCloud-OPP-6.3.911-xxx.zip到主机中,包获取路径请参见表2
  2. 将权重文件上传到DevServer机器中。权重文件的格式要求为Huggingface格式。开源权重文件获取地址请参见表3

    如果使用模型训练后的权重文件进行推理,模型训练及训练后的权重文件转换操作可以参考相关文档章节中提供的模型训练文档。

  3. 权重要求放在磁盘的指定目录,并做目录大小检查,参考命令如下。
    df -h

步骤四 制作推理镜像

解压AscendCloud压缩包及该目录下的推理代码AscendCloud-LLM-6.3.911-xxx.zip和算子包AscendCloud-OPP-6.3.911-xxx.zip,并执行build_image.sh脚本制作推理镜像。安装过程需要连接互联网git clone,请确保机器环境可以访问公网。
unzip AscendCloud-*.zip -d ./AscendCloud && cd ./AscendCloud && unzip AscendCloud-OPP-*.zip && unzip AscendCloud-OPP-*-torch-2.1.0*.zip -d ./AscendCloud-OPP && cd .. && unzip ./AscendCloud/AscendCloud-LLM-*.zip -d ./AscendCloud/AscendCloud-LLM && cd ./AscendCloud/AscendCloud-LLM/llm_inference/ascend_vllm/ && sh build_image.sh --base-image=${base_image} --image-name=${image_name}

参数说明:

  • ${base_image}为基础镜像地址。
  • ${image_name}为推理镜像名称,可自行指定。

运行完后,会生成推理所需镜像。

如果推理需要使用NPU加速图片预处理,适配了llava-1.5模型,启动时需要设置export ENABLE_USE_DVPP=1,需要安装torchvision_npu,可放到镜像制作脚本./AscendCloud/AscendCloud-LLM/llm_inference/ascend_vllm/Dockfile中。内容如下:

git clone https://gitee.com/ascend/vision.git vision_npu
cd vision_npu
git checkout v0.16.0-6.0.rc3
# 安装依赖库 
pip3 install -r requirement.txt
# 编包 
python setup.py bdist_wheel  
# 安装 
cd dist  
pip install torchvision_npu-0.16.*.whl

步骤五 启动容器镜像

启动容器镜像前请先按照参数说明修改${}中的参数。docker启动失败会有对应的error提示,启动成功会有对应的docker id生成,并且不会报错。

docker run -itd \
--device=/dev/davinci0 \
--device=/dev/davinci1 \
--device=/dev/davinci2 \
--device=/dev/davinci3 \
--device=/dev/davinci4 \
--device=/dev/davinci5 \
--device=/dev/davinci6 \
--device=/dev/davinci7 \
-v /etc/localtime:/etc/localtime  \
-v /usr/local/Ascend/driver:/usr/local/Ascend/driver \
-v /etc/ascend_install.info:/etc/ascend_install.info \
--device=/dev/davinci_manager \
--device=/dev/devmm_svm \
--device=/dev/hisi_hdc \
-v /var/log/npu/:/usr/slog \
-v /usr/local/sbin/npu-smi:/usr/local/sbin/npu-smi \
-v /sys/fs/cgroup:/sys/fs/cgroup:ro \
-v ${dir}:${container_work_dir} \
--net=host \
--name ${container_name} \
${image_id} \
/bin/bash

参数说明:

  • --device=/dev/davinci0,..., --device=/dev/davinci7:挂载NPU设备,示例中挂载了8张卡davinci0~davinci7。
  • -v ${dir}:${container_work_dir} 代表需要在容器中挂载宿主机的目录。宿主机和容器使用不同的大文件系统,dir为宿主机中文件目录,${container_work_dir}为要挂载到的容器中的目录。为方便两个地址可以相同。
    • 容器不能挂载到/home/ma-user目录,此目录为ma-user用户家目录。如果容器挂载到/home/ma-user下,拉起容器时会与基础镜像冲突,导致基础镜像不可用。
    • driver及npu-smi需同时挂载至容器。
    • 不要将多个容器绑到同一个NPU上,会导致后续的容器无法正常使用NPU功能。
  • --name ${container_name}:容器名称,进入容器时会用到,此处可以自己定义一个容器名称。
  • {image_id} 为docker镜像的ID,即第四步中生成的新镜像id,在宿主机上可通过docker images查询得到。

步骤六 启动推理服务

  1. 进入容器。
    docker exec -it -u ma-user ${container-name} /bin/bash
  2. 评估推理资源。运行如下命令,返回NPU设备信息可用的卡数。
    npu-smi info       # 启动推理服务之前检查卡是否被占用、端口是否被占用,是否有对应运行的进程

    如出现错误,可能是机器上的NPU设备没有正常安装,或者NPU镜像被其他容器挂载。请先正常安装固件和驱动,或释放被挂载的NPU。

    驱动版本要求是23.0.6。如果不符合要求请参考安装固件和驱动章节升级驱动。启动后容器默认端口是8080。

  3. 配置需要使用的NPU卡为容器中的第几张卡。例如:实际使用的是容器中第1张卡,此处填写“0”。
    export ASCEND_RT_VISIBLE_DEVICES=0

    如果启动服务需要使用多张卡,则按容器中的卡号依次编排。例如:实际使用的是容器中第1张和第2张卡,此处填写为“0,1”,以此类推。

    export ASCEND_RT_VISIBLE_DEVICES=0,1
    通过命令npu-smi info查询NPU卡为容器中的第几张卡。例如下图查询出两张卡,如果希望使用第一和第二张卡,则“export ASCEND_RT_VISIBLE_DEVICES=0,1”,注意编号不是填4、5。
    图1 查询结果
  4. 配置环境变量。
    export USE_PFA_HIGH_PRECISION_MODE=1
    # PFA算子(全量prefill阶段的flash-attention)是否使用高精度模式;默认值为1表示开启。针对Qwen2-7B模型和Qwen2-57b模型,必须开启此配置,否则精度会异常;其他模型不建议开启,会影响首token时延增加5%~10%。
    
    export USE_IFA_HIGH_PRECISION_MODE=1
    # IFA算子(增量decode阶段的flash-attention)是否使用高精度模式;默认值为0表示不开启。针对Qwen2-7B、Qwen2-57b、Qwen2-72B,在长序列下需要开启,否则会有概率性精度异常;其他模型不建议开启,会影响增量时延增加5%~10%。
    
    export USE_PREFIX_HIGH_PRECISION_MODE=1
    # 针对Qwen2-7B、Qwen2-72B模型,在开启prefix-caching时,需要同时使用带有prefix-caching的高精度attention算子避免精度异常。需要和prefix-caching特性一起使用,如果不使用prefix-caching特性则不配置该环境变量。
  5. 如果要开启图模式,请配置以下5个环境变量,并且启动服务时不要添加enforce-eager参数。
    export INFER_MODE=PTA  # 开启PTA模式,如果不使用图模式,请关闭该环境变量
    export PTA_TORCHAIR_DECODE_GEAR_ENABLE=1   # 开启动态分档功能
    export PTA_TORCHAIR_DECODE_GEAR_LIST=2,4,6,8,16,32    # 设置动态分档的档位,根据实际情况设置,另外请不要设置档位1(DeepSeek V2 236B W8A8 模型建议最大设置4个档位)
    export VLLM_ENGINE_ITERATION_TIMEOUT_S=1500    # 设置vllm请求超时时间(DeepSeek V2 236B W8A8 模型建议调大为6000)
    export HCCL_OP_EXPANSION_MODE=AIV    #可选

    通过PTA_TORCHAIR_DECODE_GEAR_LIST设置动态分档位后,在PTA模式下,会根据服务启动时的max_num_seqs参数对档位进行调整,使得最终的最大档位为max_num_seqs,因此,请根据使用场景合理设置动态分档以及max_num_seqs参数,避免档位过大导致图编译错误。

    在MoE模型上推荐使用图模式部署,包括mixtral-8x7B、qwen2-57B、deepseek-v2-lite-16B、deepseek-v2-236B-W8A8。当前MoE模型图模式启动不支持multi step。

    MoE模型依赖MindSpeed,当使用MoE模型推理时,需提前安装:

    git clone https://gitee.com/ascend/MindSpeed.git
    cd MindSpeed
    git checkout a956b907ef3b0787d2a38577eb5b702f5b7e715d #推荐commit
    pip install -e .

    开启图模式后,服务第一次响应请求时会有一个较长时间的图编译过程,并且会在当前目录下生成.torchair_cache文件夹来保存图编译的缓存文件。当服务第二次启动时,可通过缓存文件来快速完成图编译的过程,避免长时间的等待,并且基于图编译缓存文件来启动服务可获得更优的推理性能,因此请在有图编译缓存文件的前提下启动服务。另外,当启动服务时的模型或者参数发生改变时,请删除.torchair_cache文件夹,避免由于缓存文件与实际推理不匹配而报错。

  6. 如果要使用eagle投机,配置环境变量,使eagle投机对齐论文版本实现。目前默认开启此模式,如果不开启,目前vllm0.6.3版本与实验室版本权重无法对齐,会导致小模型精度问题。
    export EAGLE_USE_SAFE_AI_LAB_STYLE=1  # eagle投机对基于 https://github.com/SafeAILab/EAGLE/ 版本实现,默认开启
    export ENABLE_SPEC_METRIC=0  # 是否关闭投机推理的metric采集功能,关闭有助于提升投机推理性能,默认关闭
    如果需要使用eagle投机推理功能,需要进入 lm_tools/spec_decode/EAGLE 文件夹,使用convert_eagle_ckpt_to_vllm_compatible.py脚本进行权重转换。转换命令为
    python convert_eagle_ckpt_to_vllm_compatible.py --base-path 大模型权重地址 --draft-path 小模型权重地址 --base-weight-name 大模型包含lm_head的权重文件名 --draft-weight-name 小模型权重文件名

    具体可参考章节eagle投机小模型训练中的步骤五:训练生成权重转换成可以支持vLLM推理的格式

  7. 如果需要增加模型量化功能,启动推理服务前,先参考使用AWQ量化使用SmoothQuant量化使用GPTQ量化章节对模型做量化处理
  8. 启动服务与请求。此处提供vLLM服务API接口启动和OpenAI服务API接口启动2种方式。详细启动服务与请求方式参考:https://docs.vllm.ai/en/latest/getting_started/quickstart.html

    以下服务启动介绍的是在线推理方式,离线推理请参见https://docs.vllm.ai/en/latest/getting_started/quickstart.html#offline-batched-inference

    • 方式一:通过OpenAI服务API接口启动服务【推荐,在vllm-0.6.0之后的版本性能更好】

      在llm_inference/ascend_vllm/目录下通OpenAI服务API接口启动服务,具体操作命令如下,可以根据参数说明修改配置。

      (1)非多模态

      python -m vllm.entrypoints.openai.api_server --model ${container_model_path} \
      --max-num-seqs=256 \
      --max-model-len=4096 \
      --max-num-batched-tokens=4096 \
      --tensor-parallel-size=1 \
      --block-size=128 \
      --host=${docker_ip} \
      --port=8080 \
      --gpu-memory-utilization=0.9 \
      --num-scheduler-steps=8 \
      --trust-remote-code \
      --enforce-eager

      (2)多模态

      当前支持Llava、InternVL2、MiniCPM、qwen2-vl模型,具体模型和权重地址参见表3,推荐显卡数量参见表1

      export VLLM_IMAGE_FETCH_TIMEOUT=100
      export VLLM_ENGINE_ITERATION_TIMEOUT_S=600
      # PYTORCH_NPU_ALLOC_CONF优先设置为expandable_segments:True
      # 如果有涉及虚拟显存相关的报错,可设置为expandable_segments:False
      export PYTORCH_NPU_ALLOC_CONF=expandable_segments:True
      
      python -m vllm.entrypoints.openai.api_server --model ${container_model_path} \
      --max-num-seqs=256 \
      --max-model-len=4096 \
      --max-num-batched-tokens=4096 \
      --tensor-parallel-size=1 \
      --block-size=128 \
      --chat-template ${chat_template_path} \
      --dtype ${dtype} \
      --host=${docker_ip} \
      --port=${port} \
      --gpu-memory-utilization=0.9 \
      --trust-remote-code

      多模态推理服务启动模板参数说明如下:

      • VLLM_IMAGE_FETCH_TIMEOUT:图片下载时间环境变量。
      • VLLM_ENGINE_ITERATION_TIMEOUT_S:服务间隔最大时长,超过会报timeout错误。
      • PYTORCH_NPU_ALLOC_CONF=expandable_segments:True;允许分配器最初创建一个段,然后在以后需要更多内存时扩展它的大小。开启时可能提升模型性能。报错则关闭。
      • --chat-template:对话构建模板,可选参数。如:

        (1)llava chat-template:${vllm_path}/examples/template_llava.jinja

    • 方式二:通过vLLM服务API接口启动服务

      在llm_inference/ascend_vllm/目录下通过vLLM服务API接口启动服务,具体操作命令如下,API Server的命令相关参数说明如下,可以根据参数说明修改配置。

      python -m vllm.entrypoints.api_server --model ${container_model_path} \
      --max-num-seqs=256 \
      --max-model-len=4096 \
      --max-num-batched-tokens=4096 \
      --tensor-parallel-size=1 \
      --block-size=128 \
      --host=${docker_ip} \
      --port=8080 \
      --gpu-memory-utilization=0.9 \
      --trust-remote-code \
      --enforce-eager
    • 方式三:多机部署vLLM服务API接口启动服务(可选)

      当单机显存无法放下模型权重时,可选用该种方式部署;该种部署方式,需要机器在同一个集群,NPU卡之间IP能够ping通方可,具体步骤如下:

      1. 查看卡IP。
        for i in $(seq 0 7);do hccn_tool -i $i -ip -g;done
      2. 检查卡之间的网络是否通。
        # 在另一个节点上执行,29.81.3.172是上一步输出的ipaddr的值
        hccn_tool -i 0 -ping -g address 29.81.3.172
      3. 启动Ray集群。
        # 指定通信网卡,使用ifconfig查看,找到和主机IP一致的网卡名
        export GLOO_SOCKET_IFNAME=enp67s0f5
        export TP_SOCKET_IFNAME=enp67s0f5
        export RAY_EXPERIMENTAL_NOSET_ASCEND_RT_VISIBLE_DEVICES=1
        # 指定可使用的卡
        export ASCEND_RT_VISIBLE_DEVICES=0,1,2,3,4,5,6,7
        # 将其中一个节点设为头节点
        ray start --head --num-gpus=8
        # 在其他节点执行
        ray start --address='10.170.22.18:6379' --num-gpus=8
        • --num-gpus:要跟ASCEND_RT_VISIBLE_DEVICES指定的可用卡数一致。
        • --address:头节点IP+端口号,头节点创建成功后,会有打印。
      4. 正常启服务即可。
    推理服务基础参数说明如下:
    • --model ${container_model_path}:模型地址,模型格式是HuggingFace的目录格式。即步骤三 上传代码包和权重文件上传的HuggingFace权重文件存放目录。如果使用了量化功能,则使用推理模型量化章节转换后的权重。如果使用的是训练后模型转换为HuggingFace格式的地址,还需要有Tokenizer原始文件。
    • --max-num-seqs:最大同时处理的请求数,超过后在等待池等候处理。
    • --max-model-len:推理时最大输入+最大输出tokens数量,输入超过该数量会直接返回。max-model-len的值必须小于config.json文件中的"seq_length"的值,否则推理预测会报错。config.json存在模型对应的路径下,例如:${container_work_dir}/chatglm3-6b/config.json。不同模型推理支持的max-model-len长度不同,具体差异请参见附录:基于vLLM不同模型推理支持最小卡数和最大序列说明
    • --max-num-batched-tokens:prefill阶段,最多会使用多少token,必须大于或等于--max-model-len,推荐使用4096或8192。
    • --dtype:模型推理的数据类型。支持FP16和BF16数据类型推理。float16表示FP16,bfloat16表示BF16。如果不指定,则根据输入数据自动匹配数据类型。使用不同的dtype会影响模型精度。如果使用开源权重,建议不指定dtype,使用开源权重默认的dtype。
    • --tensor-parallel-size:模型并行数。取值需要和启动的NPU卡数保持一致,可以参考附录:基于vLLM不同模型推理支持最小卡数和最大序列说明。此处举例为1,表示使用单卡启动服务。
    • --block-size:kv-cache的block大小,推荐设置为128。当前仅支持64和128。
    • --num-scheduler-steps: 默认为1,推荐设置为8。用于mult-step调度。每次调度生成多个token,可以降低时延。开启投机推理后无需配置该参数,否则会导致投机推理启动报错。
    • --multi-step-stream-outputs: 设置false后,mult-step会关闭流式输出提升性能,一次将返回num-scheduler-steps个token。
    • --host=${docker_ip}:服务部署的IP,${docker_ip}替换为宿主机实际的IP地址,默认为None,举例:参数可以设置为0.0.0.0。
    • --port:服务部署的端口。
    • --gpu-memory-utilization:NPU使用的显存比例,复用原vLLM的入参名称,默认为0.9。
    • --trust-remote-code:是否相信远程代码。
    • --distributed-executor-backend:多卡推理启动后端,可选值为"ray"或者"mp",其中"ray"表示使用ray进行启动多卡推理,"mp"表示使用python多进程进行启动多卡推理。默认使用"mp"后端启动多卡推理。
    • --enforce-eager:未设置INFER_MODE环境变量时,部分模型会默认使用CANNGraph图模式启动来提升性能,设置该参数后将关闭图模式。CANNGraph图模式目前支持llama和qwen2系列大语言模型单卡场景,包含该系列AWQ量化模型,其他场景(如Multi-lora)暂未支持。小模型如Qwen2-1.5B和Qwen2-0.5B推荐不设置该参数。
    • --disable-async-output-proc:关闭异步后处理特性,关闭后性能会下降。
    高阶参数说明:
    • --enable-prefix-caching:如果prompt的公共前缀较长或者多轮对话场景下推荐使用prefix-caching特性。在推理服务启动脚本中添加此参数表示使用prefix-caching特性,不添加表示不使用。开启该特性后,如果模型长度>8192,则需要在启动推理服务前添加如下环境变量降低显存占用;否则在长序列的推理中会触发Out of Memory,导致推理服务不可用。
      export USE_PREFIX_HIGH_PRECISION_MODE=1
    • 如果需要使用multi-lora特性;需要在推理服务启动命令中额外添加如下命令。
      --enable-lora \
      --lora-modules lora1=/path/to/lora/adapter1/ lora2=/path/to/lora/adapter2/ \
      --max-lora-rank=16 \
      --max-loras=32 \
      --max-cpu-loras=32

      --enable-lora表示开启lora挂载。

      --lora-modules后面添加挂载的lora列表,要求lora地址权重是huggingface格式,当前支持QKV-proj、O-proj、gate_up_proj、down_proj模块的挂载。

      --max-lora-rank表示挂载lora的最大rank数量,支持8、16、32、64。

      --max-loras 表示支持的最大lora个数,最大32。

      --max-cpu-loras要求配置和--max-loras相同。

      发请求时model指定为lora1或者lora2即为LoRA推理。

    • --quantization:推理量化参数。当使用量化功能,则在推理服务启动脚本中增加该参数,如果未使用量化功能,则无需配置。根据使用的量化方式配置,可选择awqsmoothquant或者GPTQ方式。该参数可与投机推理配合使用,实现投机校验模型的量化功能。
    • --enable-chunked-prefill:chunked-prefill特性参数,不传入默认为None即不启用;在不定长、短输入、短输出、大并发场景下推荐使用,需配合--max-num-batched-tokens使用,建议max-num-batched-tokens设置为2048或更大。
    • --speculative-model ${container_draft_model_path}:投机草稿模型地址,模型格式是HuggingFace的目录格式。即步骤三 上传代码包和权重文件上传的HuggingFace权重文件存放目录。投机草稿模型为与--model入参同系列,但是权重参数远小于--model指定的模型。如果未使用投机推理功能,则无需配置。
    • --speculative-draft-tensor-parallel-size: 投机模型使用tp数,因为投机模型较小,多卡并行时通信会降低性能,故此处需要设置为1。
    • --num-speculative-tokens:投机推理草稿模型每次推理的token数。如果未使用投机推理功能,则无需配置。参数--num-speculative-tokens需要和--speculative-model ${container_draft_model_path}同时使用。
    • --served-model-name:vllm服务后台id。
    服务启动后,会打印如下类似信息。
    server launch time cost: 15.443044185638428 s INFO:     Started server process [2878]INFO:     Waiting for application startup. INFO:     Application startup complete. INFO:     Uvicorn running on http://0.0.0.0:8080 (Press CTRL+C to quit)

步骤七 推理请求

使用命令测试推理服务是否正常启动。服务启动命令中的参数设置请参见表1

  • 方式一:通过OpenAI服务API接口启动服务使用以下推理测试命令。${docker_ip}替换为实际宿主机的IP地址。如果启动服务未添加served-model-name参数,${container_model_path}的值请与model参数的值保持一致,如果使用了served-model-name参数,${container_model_path}请替换为实际使用的模型名称。
    curl -X POST http://${docker_ip}:8080/v1/chat/completions \
    -H "Content-Type: application/json" \
    -d '{
        "model": "${container_model_path}",
        "messages": [
            {
                "role": "user",
                "content": "hello"
            }
        ],
        "max_tokens": 100,
        "top_k": -1,
        "top_p": 1,
        "temperature": 0,
        "ignore_eos": false,
        "stream": false
    }'
  • 方式二:通过vLLM服务API接口启动服务使用以下推理测试命令。下面以Llama系列模型采样方式支持presence_penalty参数的发送请求为例。此处的接口8080需和Step4 启动容器镜像中设置的宿主机端口保持一致。${docker_ip}替换为实际宿主机的IP地址。
    curl -X POST http://${docker_ip}:8080/generate \
    -H "Content-Type: application/json" \
    -d '{
    "prompt": "hello",
    "max_tokens": 100,
    "temperature": 0,
    "ignore_eos": false,
    "presence_penalty":2
     }'

    下面以Llama系列模型采样方式支持length_penalty参数的发送请求为例。${docker_ip}替换为实际宿主机的IP地址。

    curl -X POST http://${docker_ip}:8080/generate \
    -H "Content-Type: application/json" \
    -d '{
    "prompt": "hello",
    "max_tokens": 100,
    "top_p": 1,
    "temperature": 0,
    "ignore_eos": false,
    "top_k": -1,
    "use_beam_search":true,
    "best_of":2,
    "length_penalty":2
     }'

服务的API与vLLM官网相同,此处介绍关键参数。详细参数解释请参见官网https://docs.vllm.ai/en/stable/dev/sampling_params.html

表1 请求服务参数说明

参数

是否必选

默认值

参数类型

描述

model

Str

通过OpenAI服务API接口启动服务时,推理请求必须填写此参数。取值必须和启动推理服务时的model ${container_model_path}参数保持一致。

通过vLLM服务API接口启动服务时,推理请求不涉及此参数。

prompt

-

Str

请求输入的问题。

max_tokens

16

Int

每个输出序列要生成的最大tokens数量。

top_k

-1

Int

控制要考虑的前几个tokens的数量的整数。设置为-1表示考虑所有tokens。

适当降低该值可以减少采样时间。

top_p

1.0

Float

控制要考虑的前几个tokens的累积概率的浮点数。必须在 (0, 1] 范围内。设置为1表示考虑所有tokens。

temperature

1.0

Float

控制采样的随机性的浮点数。较低的值使模型更加确定性,较高的值使模型更加随机。0表示贪婪采样。

stop

None

None/Str/List

用于停止生成的字符串列表。返回的输出将不包含停止字符串。

例如:["你","好"],生成文本时遇到"你"或者"好"将停止文本生成。

stream

False

Bool

是否开启流式推理。默认为False,表示不开启流式推理。

n

1

Int

返回多条正常结果。

约束与限制:

不使用beam_search场景下,n取值建议为1≤n≤10。如果n>1时,必须确保不使用greedy_sample采样。也就是top_k > 1; temperature > 0。

使用beam_search场景下,n取值建议为1<n≤10。如果n=1,会导致推理请求失败。

说明:

n建议取值不超过10,n值过大会导致性能劣化,显存不足时,推理请求会失败。

use_beam_search

False

Bool

是否使用beam_search替换采样。

约束与限制:使用该参数时,如下参数需按要求设置:

n>1

top_p = 1.0

top_k = -1

temperature = 0.0

presence_penalty

0.0

Float

presence_penalty表示会根据当前生成的文本中新出现的词语进行奖惩。取值范围[-2.0,2.0]。

frequency_penalty

0.0

Float

frequency_penalty会根据当前生成的文本中各个词语的出现频率进行奖惩。取值范围[-2.0,2.0]。

length_penalty

1.0

Float

length_penalty表示在beam search过程中,对于较长的序列,模型会给予较大的惩罚。

如果要使用length_penalty,必须添加如下三个参数,并且需将use_beam_search参数设置为true,best_of参数设置大于1,top_k固定为-1。

"top_k": -1

"use_beam_search":true

"best_of":2

ignore_eos

False

Bool

ignore_eos表示是否忽略EOS并且继续生成token。

guided_json

None

Union[str, dict, BaseModel]

使用openai启动服务,如果需要使用JSON Schema时要配置guided_json参数。

JSON Schema使用专门的关键字来描述数据结构,例如标题title、 类型type、属性properties,必需属性required 、定义definitions等,JSON Schema通过定义对象属性、类型、格式的方式来引导模型生成一个包含用户信息的JSON对象。

如果希望使用JSON Schema,guided_json的写法可参考outlines: Structured Text Generation中的“Efficient JSON generation following a JSON Schema”样例,如下图所示。

图2 guided_json样例
如果想在发送的请求中包含上述guided_json架构,可参考以下代码。如果prompt未提供充足信息可能导致返回的json文件部分结果为空。
curl -X POST http://${docker_ip}:8080/v1/completions \
-H "Content-Type: application/json" \
-d '{
    "model": "${container_model_path}",
    "prompt": "Meet our valorous character, named Knight, who has reached the age of 32. Clad in impenetrable plate armor, Knight is well-prepared for any battle. Armed with a trusty sword and boasting a strength score of 90, this character stands as a formidable warrior on the field.Please provide details for this character, including their Name, Age, preferred Armor, Weapon, and Strength",
    "max_tokens": 200,
    "temperature": 0,
    "guided_json": "{\"title\": \"Character\", \"type\": \"object\", \"properties\": {\"name\": {\"title\": \"Name\", \"maxLength\": 10, \"type\": \"string\"}, \"age\": {\"title\": \"Age\", \"type\": \"integer\"}, \"armor\": {\"$ref\": \"#/definitions/Armor\"}, \"weapon\": {\"$ref\": \"#/definitions/Weapon\"}, \"strength\": {\"title\": \"Strength\", \"type\": \"integer\"}}, \"required\": [\"name\", \"age\", \"armor\", \"weapon\", \"strength\"], \"definitions\": {\"Armor\": {\"title\": \"Armor\", \"description\": \"An enumeration.\", \"enum\": [\"leather\", \"chainmail\", \"plate\"], \"type\": \"string\"}, \"Weapon\": {\"title\": \"Weapon\", \"description\": \"An enumeration.\", \"enum\": [\"sword\", \"axe\", \"mace\", \"spear\", \"bow\", \"crossbow\"], \"type\": \"string\"}}}"
}'
  • 方式三 online_serving.py 发送请求(单图单轮对话)

由于多模态推理涉及图片的编解码,所以采用脚本方式调用服务API。脚本中需要配置的参数如表2脚本参数说明所示。

import base64
import requests
import argparse
import json
from typing import List
# Function to encode the image
def encode_image(image_path):
  with open(image_path, "rb") as image_file:
    return base64.b64encode(image_file.read()).decode('utf-8')

def get_stop_token_ids(model_path):
    with open(f"{model_path}/config.json") as file:
        data = json.load(file)
        if data.get('architectures')[0] == "InternVLChatModel":
            return [0, 92543, 92542]
    return None

def post_img(args):
    # Path to your image
    image_path = args.image_path
    # Getting the base64 string
    image_base64 = encode_image(image_path)
    stop_token_ids = args.stop_token_ids if args.stop_token_ids is not None else get_stop_token_ids(args.model_path)
    headers = {
      "Content-Type": "application/json"
    }
    payload = {
      "model": args.model_path,
      "messages": [
        {
          "role": "user",
          "content": [
            {
              "type": "text",
              "text": args.text
            },
            {
              "type": "image_url",
              "image_url": {
                "url": f"data:image/jpeg;base64,{image_base64}"
              }
            }
          ]
        }
      ],
      "max_tokens": args.max_tokens,
      "temperature": args.temperature,
      "ignore_eos": args.ignore_eos,
      "stream": args.stream,
      "top_k": args.top_k,
      "top_p": args.top_p,
      "stop_token_ids": stop_token_ids,
      "repetition_penalty": args.repetition_penalty,
    }
    response = requests.post(f"http://{args.docker_ip}:{args.served_port}/v1/chat/completions", headers=headers, json=payload)
    print(response.json())

if __name__ == "__main__":
    parser = argparse.ArgumentParser()
    # 必填
    parser.add_argument("--model-path", type=str, required=True)
    parser.add_argument("--image-path", type=str, required=True)
    parser.add_argument("--docker-ip", type=str, required=True)
    parser.add_argument("--served-port", type=str, required=True)
    parser.add_argument("--text", type=str, required=True)
    # 选填
    parser.add_argument("--temperature", type=float, default=0) # 输出结果的随机性。可选
    parser.add_argument("--ignore-eos", type=bool, default=False) # 在生成过程中是否忽略结束符号,在生成EOS token后继续生成token。可选
    parser.add_argument("--top-k", type=int, default=-1) # 参数控制着生成结果的多样性。其值越小,生成的文本就越独特,但可能缺乏连贯性。相反,其值越大,文本就越连贯,但多样性也会降低。可选
    parser.add_argument("--top-p", type=int, default=1.0) # 参数的取值范围为0到1。值越小,生成的内容就越意外,但可能牺牲连贯性。值越大,内容就越连贯,但意外性也会减弱。可选
    parser.add_argument("--stream", type=int, default=False) # 是否开启流式推理。默认为False,表示不开启流式推理。
    parser.add_argument("--max-tokens", type=int, default=16) # 生成序列的最大长度。必选
    parser.add_argument("--repetition-penalty", type=float, default=1.0) # 减少重复生成文本的概率。可选
    parser.add_argument("--stop-token-ids", nargs='+', type=int, default=None) # 停止tokens列表。可选
    args = parser.parse_args()
    post_img(args)

运行此脚本:

python online_serving.py --model-path ${container_model_path} --image-path ${image_path} --docker-ip ${docker_ip} --served-port ${port} --text 图片内容是什么
表2 脚本参数说明

参数

是否必须

参数类型

描述

image_path

str

传给模型的图片路径

payload

json

单图单轮对话的post请求json, 可参考表2.请求服务json参数说明

docker_ip

str

启动多模态openAI服务的主机ip

served_port

str

启动多模态openAI服务的端口号

表3 请求服务json参数说明

参数

是否必须

默认值

参数类型

描述

model

Str

通过OpenAI服务API接口启动服务时,推理请求必须填写此参数。取值必须和启动推理服务时的model ${container_model_path}参数保持一致。

messages

-

Dict

请求输入的问题和图片。`role`: 表示消息的发送者,这里只能为用户。`content`: 表示消息的内容,类型为list。单图单轮对话content必须包含两个元素,第一个元素type字段取值为text,表示文本类型, text字段取值为输入问题的字符串。 第二个元素`type`字段取值为image_url, 表示图片类型,image_url字段取值为是输入图片的base64编码。

max_tokens

16

Int

每个输出序列要生成的最大tokens数量。

top_k

-1

Int

控制要考虑的前几个tokens的数量的整数。设置为-1表示考虑所有tokens。适当降低该值可以减少采样时间。

top_p

1.0

Float

控制要考虑的前几个tokens的累积概率的浮点数。必须在 (0, 1] 范围内。设置为1表示考虑所有tokens。

temperature

1.0

Float

控制采样的随机性的浮点数。较低的值使模型更加确定性,较高的值使模型更加随机。0表示贪婪采样。

stream

False

Bool

是否开启流式推理。默认为False,表示不开启流式推理。

ignore_eos

False

Bool

ignore_eos表示是否忽略EOS并且继续生成token。

repetition_penalty

1.0

Float

减少重复生成文本的概率。

stop_token_ids

None

Int

停止tokens列表。internvl2和minicpmv需要传入,参考离线推理脚本examples/offline_inference_vision_language.py的stop_token_ids。

相关文档