benzeng's picture
Add research code (pipelines, serve.py, agent.py) and docs
fdd71c3 verified
|
Raw History Blame Contribute Delete
10.6 kB

serve.py 使用手册

用 transformers 直接加载 safetensors 版 Spark-X2.5-1.7B 的本地推理服务(无需 ollama/llama.cpp 的自定义架构支持)。 GPU bf16 加载仅占 3.4GB 显存;请求串行处理(无 continuous batching),单流约 14 tok/s。

启动

cd /home/dong/models/UncensoredReseach
.venv/bin/python serve.py [选项]
选项 默认值 说明
--model /home/dong/models/Spark-X2.5-1.7B 模型路径(HF 格式目录)
--host 127.0.0.1 监听地址,外部访问用 0.0.0.0
--port 8000 端口
--device cuda(不可用时 cpu) 推理设备
--dtype bfloat16 bfloat16 / float16 / float32
--thinking on 思维链服务端默认开关:off 时客户端无需任何配置即跳过思考
--ablate off 拒绝方向消融默认开关:on 时所有请求默认做全层方向消融(研究用途)
--directions results/directions.pt 消融方向文件(含 directions_unit 张量)
--ablate-layer 11 取哪一层的方向
--ablate-k 1 消融子空间维度:1=单方向;>1=该层 SVD 前 k 维子空间(MiniCPM5-2B 用 --ablate-k 16 可清除 rank-1 消不掉的顽固残留;需方向文件含训练激活)
--max-context 自适应 输入 token 上限,超限返回 400(流式也会在 SSE 开始前拒绝)。默认:Pascal 老卡+bf16 → 3072;6GB 卡+fp16 → 8192;其他 → 16384。0=不限制(自担 OOM 风险)
--dtype bfloat16 float16 是长上下文的关键:Pascal 没有 bf16 高效注意力内核,prefill 退回 O(n²) math 后端(4K token 就要 2.7GB);fp16 可走 memory-efficient 内核,注意力 O(n)(实测 32K 仅 0.54GB)

典型启动:

.venv/bin/python serve.py --host 0.0.0.0 --port 8000 --thinking off
# 权重正交化派生模型(消融已固化进权重,无需消融开关):
.venv/bin/python serve.py --model /home/dong/models/Spark-X2.5-1.7B-orth-r11 --thinking off

接口

OpenAI 兼容

端点 说明
GET /health 健康检查(返回模型与设备)
GET /v1/models 模型列表(id 为 Spark-X2.5-1.7B)
POST /v1/chat/completions 对话补全,支持 stream=true(SSE)

请求参数:messages、temperature、top_p、top_k、max_tokens(默认 512)、stop、stream、 tools(工具调用,见下节), 以及扩展字段 **enable_thinking**(bool,省略时用服务端 --thinking 默认值,显式传入则覆盖)、 **ablate_refusal**(bool,省略时用服务端 --ablate 默认值;true 时本次生成做全层拒绝方向消融, Ollama 端点在 options.ablate_refusal 传入)、 **ablate_k**(int 1–32,省略时用服务端 --ablate-k;请求级子空间维度,Ollama 端点 options.ablate_k)。

消融强度与能力的权衡(MiniCPM5-2B 实测):k=1–4 良性任务完好但高危顽固指令有残留; k≥8 开始损伤代码等结构化输出;k=16 虽清零顽固集但良性任务明显退化。 日常用 k=1–4,k=16 仅供演示。细节见 MiniCPM5-2B/REPORT.md 第四节。

非流式响应中思维链被拆分:reasoning_content = 思考过程(DeepSeek-R1 风格),content = 正式回答; 附 speed_tok_s 速度指标。

curl http://localhost:8000/v1/chat/completions -H "Content-Type: application/json" -d '{
  "messages": [{"role": "user", "content": "1+1=?"}],
  "max_tokens": 1024, "enable_thinking": true
}'

Ollama 兼容

端点 说明
GET /api/tags 模型列表
POST /api/chat 对话(stream 为 NDJSON;think 开关;options 支持 temperature/top_p/top_k/num_predict)
curl http://localhost:8000/api/chat -d '{
  "model": "Spark-X2.5-1.7B", "stream": false, "think": false,
  "messages": [{"role": "user", "content": "hi"}],
  "options": {"num_predict": 256}
}'

思维链开关的优先级

请求显式传参 > 服务端 --thinking 默认值。

  • 推荐日常以 --thinking off 启动(省 token、响应快、客户端零配置);
  • 需要推理过程时由客户端临时传 enable_thinking: true / think: true 覆盖。

工具调用(MiniCPM5-2B,对齐官方 SGLang minicpm5 解析器约定)

非流式 /v1/chat/completions 和 /api/chat 已支持工具调用全链路:

curl http://localhost:8000/v1/chat/completions -H "Content-Type: application/json" -d '{
  "messages": [{"role": "user", "content": "北京现在天气怎么样?"}],
  "tools": [{"type": "function", "function": {
      "name": "get_weather", "description": "获取指定城市的当前天气",
      "parameters": {"type": "object",
                     "properties": {"city": {"type": "string"}},
                     "required": ["city"]}}}],
  "max_tokens": 200, "enable_thinking": false
}'

行为约定(与官方一致):

  • 模型发起调用时:响应 finish_reason="tool_calls",message.tool_calls 为 OpenAI 结构 (function.arguments 是 JSON 字符串;Ollama 端点为 dict);
  • 工具结果用 role="tool" 消息回传;历史里 assistant 轮的 tool_calls 会原样透传给模板 (arguments 的 JSON 字符串服务端自动转 dict,模板才能重建 <function> XML);
  • 无工具需求时正常作答(不会强行调用);
  • 流式(stream=true)不解析:客户端收到原始 <function ...> XML 文本,需要工具调用请用非流式。

实现备注:MiniCPM5 的 <function/</function>/<param/</param> 是特殊 token, 生成段解码不能用 skip_special_tokens=True(否则标签被剥掉只剩残片)——serve.py 的 decode_generated 保留这几个标签、剔除其他控制 token。官方文档(SGLang 部署页)同样要求 skip_special_tokens=False,与此一致。

官方推荐路径参考:https://github.com/OpenBMB/MiniCPM/blob/main/docs/deployment/sglang.md (SGLang + --tool-call-parser minicpm5,解析器在 PR #25600,需源码安装)。 本机 GTX 1060(Pascal,compute capability 6.1)不满足 SGLang/vLLM/FlashInfer 的 sm_75+ 内核要求, 故 serve.py 自实现了等价链路;如换到 Turing 及以上显卡,可无缝切到官方 SGLang 方案。

配套:项目根目录的 agent.py 是一个极简工具调用 Agent(系统提示+工具定义仅 ~150 token), 用于驱动小模型跑多轮工具任务做能力测试:

.venv/bin/python agent.py --yes "创建 /tmp/x.txt 写入 hello,再读回确认"   # 已实测通过

内置 run_shell(默认逐条确认,--yes 跳过)、read_file(分段读)、write_file 三个工具; --budget 控制对话 token 预算(超限自动省略最老的工具输出),--out-chars 截断单次输出。

服务其他模型(MiniCPM5-2B 已验证)

serve.py 与模型无关,加 --model 即可(MiniCPM5-2B 是标准 Llama 架构,直接加载):

.venv/bin/python serve.py --model /home/dong/models/MiniCPM5-2B --port 8000 --thinking on \
    --directions MiniCPM5-2B/results/directions.pt --ablate-layer 23
# 清除顽固残留(rank-1 消不掉的高危类别)用 k=16 子空间消融:
.venv/bin/python serve.py --model /home/dong/models/MiniCPM5-2B --thinking on \
    --directions MiniCPM5-2B/results/directions.pt --ablate-layer 23 --ablate-k 16
# rank-1 权重正交化派生模型(消融已固化,无需 --ablate):
.venv/bin/python serve.py --model /home/dong/models/MiniCPM5-2B-orth-r23 --thinking on

权重固化变体选择:MiniCPM5-2B-orth-r23(rank-1)干净可用但有 12–22% 顽固残留; MiniCPM5-2B-orth-k16 / -k16-v3(k=16 子空间固化)虽清零但无害输出退化,仅作研究标本,不建议日常服务—— "清零且无损"的形态目前只有上面的 hook 版 --ablate-k 16。

注意事项:

  1. **--ablate 时必须同时改 --directions 和 --ablate-layer**——默认值是 Spark 的方向(layer 11); 两模型 hidden 同为 2048,错配不会报错但消的是别的模型的方向。MiniCPM5-2B 的决策层是 23。
  2. MiniCPM5 的 tokenizer 会返回 token_type_ids,serve.py 已在 build_inputs 里剔除(Llama forward 不接受)。
  3. MiniCPM5-2B 单方向消融只能把拒绝率降到 ~12–22%(研究结论:多通路拒绝), 所以 ablate_refusal=true 下部分有害请求仍会拒绝,属预期行为,不是开关失效。
  4. MODEL_ID 从 --model 目录名自动派生(/v1/models、响应里的 model 字段)。

客户端接入(Cherry Studio)

设置 → 模型服务 → 添加 OpenAI 类型提供商:

  • API 地址:http://localhost:8000/v1(WSL2 不通 localhost 时用 WSL 的 eth0 IP)
  • API 密钥:任意(serve.py 不鉴权)
  • 模型:手动添加 Spark-X2.5-1.7B
  • 思维链控制:会话设置 → 自定义参数 → 添加 enable_thinking(布尔) ——注意:输入框的思考开关按钮只对 Qwen 等被识别模型生效,自托管模型须用自定义参数

注意事项

  1. 串行服务:并发请求排队,不报错但会等待;不适合多用户并发。
  2. token 预算:思维链会消耗 max_tokens,开思考时建议 ≥1024,否则正式回答可能被截断。
  3. 显存上限(6GB 卡实测):MiniCPM5-2B 权重占 5.0GB,剩余 ~1GB 要同时容纳 KV cache (42层 GQA ≈86KB/token)和注意力工作区。长上下文的真实包线:
    • bf16(默认):Pascal 上 SDPA 只剩 math 后端,prefill 显存 O(n²),安全上限 ≈3K token;
    • fp16(--dtype float16):memory-efficient 内核可用,注意力 O(n),瓶颈转为 KV cache, 安全上限 ≈8K token(7.2K 流式实测通过,峰值 6.0GB 贴线);
    • 超过上限服务端返回 400;症状若是后台 OutOfMemoryError 则是老版本问题,现已在流内返回错误文本并正常收尾。 需要更长上下文只能缩短历史,或换更大显存的卡。
  4. 与研究管线的关系:本服务走的是 src/model_utils.py 同一加载路径(trust_remote_code + transformers 4.57.1 + torch 2.7.1+cu126,GTX 1060 可用); vLLM 不可用(要求 compute capability ≥ 7.5,且不支持 spark2_5 自定义架构),GGUF 版需配合定制 ollama(../ollama-spark)。