API Reference¶
This reference documents EasySteer's Python interfaces and its additions to vLLM 0.29.0. Use the linked guides for complete workflows; class pages provide signatures, field types, defaults, and return values from the source.
Engine configuration¶
- Engine configuration: steering startup arguments, CLI equivalents, and concurrent configuration capacity.
- Algorithms and payloads: supported components, graph conditions, transformations, and file formats.
General model-loading and sampling options remain upstream vLLM interfaces. See the upstream LLM API and engine arguments, using documentation that matches your installed vLLM version.
Steering¶
| Interface | Use it to | Guide |
|---|---|---|
| SteeringSpec, VectorSpec, ApplySpec | Describe an intervention and attach it to a request or engine default. | Steering requests |
| Payload classes | Construct validated direction, map, low-rank, concept-pair, or router weights. | Load your weights |
| LLM default and preload methods | Update the default for new requests or preload file-backed weights. | Serving and management |
Capture¶
| Interface | Use it to | Guide |
|---|---|---|
| capture() and CaptureResult | Collect labelled activations and select rows by input sample. | Hidden-state capture |
| SelectSpec | Select prompt and generation rows with the shared selection language. | Select rows |
| vllm.capture | Integrate row metadata, serialization, and worker stream/session types. | Capture execution |
Extraction and extension¶
- Vector extraction and adapters: statistical extractors, ITI, SAE,
StatisticalControlVector, andeasysteer.vectorscheckpoint adapters. Start with extracting vectors. - Algorithm extension API: transformation and graph contracts, registration, and authoring capabilities. Follow the contribution guide when implementing an algorithm.