Skip to content

vllm_omni.engine.messages

AbortRequestMessage

Bases: EngineQueueMessage

request_ids instance-attribute

request_ids: list[str]

type class-attribute instance-attribute

type: Literal['abort'] = 'abort'

AddCompanionRequestMessage

Bases: EngineQueueMessage

companion_id instance-attribute

companion_id: str

companion_prompt_text instance-attribute

companion_prompt_text: object | None

parent_id instance-attribute

parent_id: str

prompt instance-attribute

prompt: EngineCoreRequest

role instance-attribute

role: str

sampling_params_list instance-attribute

sampling_params_list: list[OmniSamplingParams]

type class-attribute instance-attribute

type: Literal["add_companion_request"] = (
    "add_companion_request"
)

CollectiveRPCRequestMessage

Bases: EngineQueueMessage

args instance-attribute

args: tuple[object, ...]

kwargs instance-attribute

kwargs: dict[str, object]

method instance-attribute

method: str

rpc_id instance-attribute

rpc_id: str

stage_ids instance-attribute

stage_ids: list[int] | None

timeout class-attribute instance-attribute

timeout: float | None = None

type class-attribute instance-attribute

type: Literal['collective_rpc'] = 'collective_rpc'

CollectiveRPCResultMessage

Bases: EngineQueueMessage

method instance-attribute

method: str

results instance-attribute

results: list[object]

rpc_id instance-attribute

rpc_id: str

stage_ids instance-attribute

stage_ids: list[int]

type class-attribute instance-attribute

type: Literal["collective_rpc_result"] = (
    "collective_rpc_result"
)

EngineQueueMessage

Bases: Struct

ErrorMessage

Bases: EngineQueueMessage

error instance-attribute

error: str

fatal class-attribute instance-attribute

fatal: bool = False

request_id class-attribute instance-attribute

request_id: str | None = None

stage_id class-attribute instance-attribute

stage_id: int | None = None

type class-attribute instance-attribute

type: Literal['error'] = 'error'

OutputMessage

Bases: EngineQueueMessage

engine_outputs instance-attribute

engine_outputs: OmniRequestOutput

finished instance-attribute

finished: bool

metrics class-attribute instance-attribute

metrics: StageRequestStats | None = None

replica_id class-attribute instance-attribute

replica_id: int | None = None

request_id instance-attribute

request_id: str

stage_id instance-attribute

stage_id: int

stage_submit_ts class-attribute instance-attribute

stage_submit_ts: float | None = None

type class-attribute instance-attribute

type: Literal['output'] = 'output'

RegisterRemoteReplicaMessage

Bases: EngineQueueMessage

replica_id instance-attribute

replica_id: int

stage_id instance-attribute

stage_id: int

type class-attribute instance-attribute

type: Literal["register_remote_replica"] = (
    "register_remote_replica"
)

ShutdownRequestMessage

Bases: EngineQueueMessage

type class-attribute instance-attribute

type: Literal['shutdown'] = 'shutdown'

StageMetricsMessage

Bases: EngineQueueMessage

metrics instance-attribute

replica_id class-attribute instance-attribute

replica_id: int | None = None

request_id instance-attribute

request_id: str

stage_id instance-attribute

stage_id: int

stage_submit_ts class-attribute instance-attribute

stage_submit_ts: float | None = None

type class-attribute instance-attribute

type: Literal['stage_metrics'] = 'stage_metrics'

StageSubmissionMessage

Bases: EngineQueueMessage

enqueue_ts instance-attribute

enqueue_ts: float

final_output_stage_ids class-attribute instance-attribute

final_output_stage_ids: list[int] | None = None

final_stage_id instance-attribute

final_stage_id: int

original_prompt instance-attribute

original_prompt: EngineCoreRequest | PromptType

output_prompt_text instance-attribute

output_prompt_text: object | None

preprocess_ms instance-attribute

preprocess_ms: float

prompt instance-attribute

prompt: EngineCoreRequest | PromptType

request_id instance-attribute

request_id: str

request_timestamp instance-attribute

request_timestamp: float

sampling_params_list instance-attribute

sampling_params_list: list[OmniSamplingParams]

type instance-attribute

type: Literal['add_request', 'streaming_update']

UnregisterRemoteReplicaMessage

Bases: EngineQueueMessage

input_addr instance-attribute

input_addr: str

stage_id instance-attribute

stage_id: int

type class-attribute instance-attribute

type: Literal["unregister_remote_replica"] = (
    "unregister_remote_replica"
)