vLLM Spark2_5 Plugin
This document targets Linux systems and Bash-compatible shells. The commands use POSIX paths and assume a Linux vLLM environment at
.venv/.
This package restores Spark2_5 support to vLLM as an out-of-tree general plugin. It enables loading and serving Spark2_5 models without modifying the vLLM source tree. The plugin registers:
Spark2_5ForCausalLM, the Spark2_5 model implementation;- the
spark2_5Transformers configuration (model_type: "spark2_5"); and - the Spark2_5 XML/KV tool-call parser, registered under the vLLM parser name
spark25.
The implementation is vendored from vLLM commit
81efe7883f30582696b69f9b9ea93c4819a8c608 and uses vLLM's existing runtime
layers. It does not contain custom CUDA kernels or require a separate build.
Spark2_5 model capabilities
Spark2_5 is a causal language model that supports hybrid sliding-window/full attention, head-wise attention output gating, tensor parallelism, pipeline parallelism, configurable RoPE parameters, and checkpoint weight loading.
Hybrid attention
Each layer can use either sliding-window attention or full attention. The mode
is selected from layer_types, with independent sliding-window and RoPE
configuration for the supported attention types.
Head-wise attention output gating
Spark2_5 can apply a learned gate to each attention head before the heads are merged and passed to the output projection:
sigmoid(g_proj(hidden_states))
Grouped-query attention and tensor parallelism
Query and KV heads are partitioned or replicated according to the tensor
parallel world size. The implementation uses vLLM's
QKVParallelLinear, ColumnParallelLinear, and RowParallelLinear layers.
Pipeline parallelism
Spark2_5ForCausalLM implements SupportsPP and uses vLLM's pipeline-parallel
layer construction and IntermediateTensors to transfer hidden states and
residuals between pipeline stages.
Optimized MLP and checkpoint loading
The MLP combines the gate and up projections with
MergedColumnParallelLinear, applies GeluAndMul, and uses a row-parallel
down projection. AutoWeightsLoader and WeightsMapper map Hugging Face
checkpoint weights into this packed projection layout.
Linux prerequisites
Use a supported Linux Python environment with vLLM already installed. GPU deployments must have a compatible NVIDIA driver and the CUDA/PyTorch runtime required by that vLLM installation. The plugin itself adds no system packages or compiled extensions.
From the vLLM repository root, activate the environment before running the commands below:
source .venv/bin/activate
Install
Install vLLM first, then install this package into the same Python
environment. The editable install is important because vLLM discovers the
plugin through the vllm.general_plugins entry-point metadata.
# From the vLLM checkout containing this directory.
uv pip install -e ./Spark-plugin --no-deps
If the directory has been renamed to vllm-spark2_5-plugin, use that directory
name in the command instead. --no-deps prevents the plugin from replacing
the vLLM installation already selected for the environment. The vLLM parser
stack requires OpenAI Python SDK 2.25.0 or newer:
uv pip install -U "openai>=2.25.0"
Verify that the entry point is visible to the same interpreter used to launch vLLM:
.venv/bin/python -c "from importlib.metadata import entry_points; \
print([(e.name, e.value) for e in entry_points(group='vllm.general_plugins')])"
The output should include an entry similar to:
('spark2_5', 'vllm_spark2_5_plugin:register')
Adding src/ to PYTHONPATH alone is not sufficient for normal plugin
discovery because entry points come from installed package metadata.
First successful use
Start the OpenAI-compatible server with the parser name spark25:
vllm serve /path/to/spark2_5-model \
--trust-remote-code \
--enable-auto-tool-choice \
--tool-call-parser spark25 \
--chat-template /path/to/chat_template.jinja \
--served-model-name Spark2_5
The parser name is spark25, not spark2_5: spark2_5 identifies the model
configuration, while spark25 is the name registered in ToolParserManager.
For a small local test deployment, consider --enforce-eager and lower values
for --max-model-len, --max-num-batched-tokens, and
--gpu-memory-utilization as appropriate for the available device.
When the server starts, look for the plugin's registration log:
vllm-spark2_5-plugin: registered Spark2_5ForCausalLM -> ...
If vLLM already provides Spark2_5ForCausalLM, the plugin logs a stand-down
message and leaves the in-tree implementation active. To explicitly use this
vendored implementation, set:
SPARK2_5_PLUGIN_OVERRIDE=1 vllm serve /path/to/spark2_5-model \
--trust-remote-code \
--enable-auto-tool-choice \
--tool-call-parser spark25 \
--chat-template /path/to/chat_template.jinja
Tool-call format
The parser recognizes Spark2_5 XML/KV tool calls of this form:
<tool_call>get_weather
<arg_key>city</arg_key><arg_value>Paris</arg_value>
<arg_key>days</arg_key><arg_value>3</arg_value>
</tool_call>
It converts declared integer, number, boolean, and JSON values to their
corresponding JSON types and returns standard vLLM ToolCall objects. Unknown
tool names are not emitted as tool calls.
Performance
The following serving benchmark used 500 concurrent requests. All requests completed successfully; hardware, model revision, and generation settings should be recorded separately when reproducing these numbers.
| Metric | Result |
|---|---|
| Successful requests | 500 |
| Failed requests | 0 |
| Benchmark duration | 4.70 s |
| Total input tokens | 762,489 |
| Total generated tokens | 63,478 |
| Request throughput | 106.42 req/s |
| Output token throughput | 13,510.08 tok/s |
| Peak output token throughput | 16,452.00 tok/s |
| Total token throughput | 175,791.36 tok/s |
| Peak concurrent requests | 500 |
Latency
| Metric | Mean | Median | P99 |
|---|---|---|---|
| TTFT | 2122.04 ms | 2111.73 ms | 4169.35 ms |
| TPOT | 11.58 ms | 13.39 ms | 14.13 ms |
| ITL | 12.34 ms | 11.13 ms | 32.92 ms |
These results represent a 100% request success rate, 106.42 requests/s, approximately 13.5K output tokens/s, and 175.8K total tokens/s at peak concurrency of 500. Decode latency had a mean TPOT of 11.58 ms and a P99 of 14.13 ms; TTFT was 2.12 s on average and 4.17 s at P99.
Compatibility and maintenance
The model implementation depends on vLLM's internal runtime-layer APIs. The
TESTED_VLLM value in src/vllm_spark2_5_plugin/__init__.py records the vLLM
revision from which the implementation was extracted. When upgrading vLLM,
retest the plugin and re-vendor the model files if an internal API has moved.
The plugin logs both the tested revision and the running vLLM version when it registers, making version drift visible in the server log.
Tests
The plugin smoke tests do not require a GPU or model weights. After installing the plugin in the test environment, run:
.venv/bin/python -m pytest Spark-plugin/tests/test_smoke.py -q
The tests verify both the public registration entry point and a complete Spark2_5 XML tool-call parse.
Plugin loading and allowlists
General plugins are loaded automatically by vLLM unless VLLM_PLUGINS is set
as an allowlist. If an allowlist is used, the entry-point name is spark2_5:
VLLM_PLUGINS=spark2_5 vllm serve /path/to/spark2_5-model \
--tool-call-parser spark25 \
--chat-template /path/to/chat_template.jinja
VLLM_PLUGINS=spark25 is not equivalent: spark25 is the tool-parser name, not
the general-plugin entry-point name.
Troubleshooting
invalid tool call parser: spark2_5
Use --tool-call-parser spark25. The plugin registers the parser under spark25.
NamespaceTool cannot be imported from openai.types.responses
Upgrade the OpenAI Python SDK in the same environment that launches vLLM:
uv pip install -U "openai>=2.25.0"
The model architecture is unsupported
The plugin was not discovered by the running interpreter. Reinstall it into that environment and inspect the entry points:
uv pip install -e ./Spark-plugin --no-deps
.venv/bin/python -c "from importlib.metadata import entry_points; \
print([(e.name, e.value) for e in entry_points(group='vllm.general_plugins')])"
If VLLM_PLUGINS is set, include spark2_5 in the allowlist.
The plugin reports that Spark2_5 is already supported
This is expected when the installed vLLM contains the model. Set
SPARK2_5_PLUGIN_OVERRIDE=1 only when the vendored implementation must be used.
The plugin logs an import traceback
The entry-point loader catches plugin import failures and continues starting
vLLM. Check the complete server log for the original traceback, then compare
the running vLLM version with the vendored reference commit recorded in
src/vllm_spark2_5_plugin/__init__.py.
Project layout
Spark-plugin/
+-- src/vllm_spark2_5_plugin/
| +-- __init__.py # register() and entry-point integration
| +-- spark2_5.py # vendored Spark2_5 model
| +-- spark2_5_config.py # Transformers configuration
| +-- spark2_5_tool_parser.py # Spark2_5 XML/KV parser
+-- tests/
| +-- test_smoke.py # registration and parser smoke tests
+-- pyproject.toml
License
Apache-2.0. The vendored vLLM implementation retains its upstream copyright headers.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vllm_spark2_5_plugin-0.1.0.tar.gz.
File metadata
- Download URL: vllm_spark2_5_plugin-0.1.0.tar.gz
- Upload date:
- Size: 20.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2d8e14f2075c6dea01fc9efffeb37569fc8e7b5d96547b34652c3bfd6f80f403
|
|
| MD5 |
dac33b7b6acaaf603f77af2e847e600e
|
|
| BLAKE2b-256 |
c55f4e2c55acad8b055f9336a1034ffffad04a728004a2edde05a0b946d6d7c7
|
File details
Details for the file vllm_spark2_5_plugin-0.1.0-py3-none-any.whl.
File metadata
- Download URL: vllm_spark2_5_plugin-0.1.0-py3-none-any.whl
- Upload date:
- Size: 18.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d6aaae51f7ed793ce5a17a49f1e47fcae35cc2a454ec5c40789394df9f2e5b2d
|
|
| MD5 |
f8cc89fecf27f4d63c59735e294d8ad2
|
|
| BLAKE2b-256 |
2ada96cb45a93f6091107b3b45dc7c5c7685ce588cb0d484a254a65a0e3b1f87
|