Skip to content

vllm_omni.engine.cfg_companion_tracker

CFG companion request tracker for the Omni orchestrator.

Encapsulates all bookkeeping for Classifier-Free Guidance companion requests (parent/companion ID mapping, completion tracking, deferred forwarding, and cleanup).

logger module-attribute

logger = getLogger(__name__)

CfgCompanionTracker

Manages CFG companion request lifecycle in the orchestrator scheduling loop.

abort_parents

abort_parents(request_ids: list[str]) -> list[str]

all_companions_done

all_companions_done(parent_id: str) -> bool

cleanup_parent

cleanup_parent(parent_id: str) -> list[str]

defer_parent

defer_parent(
    parent_id: str, engine_outputs: Any, stage_id: int
) -> None

Hold parent result while waiting for companions to finish.

get_companion_request_ids

get_companion_request_ids(parent_id: str) -> dict[str, str]

Return {role: companion_request_id} for a parent.

get_parent_id

get_parent_id(req_id: str) -> str | None

Return the parent request id for a companion, or None.

has_companions

has_companions(parent_id: str) -> bool

is_companion

is_companion(req_id: str) -> bool

on_companion_completed

on_companion_completed(companion_id: str) -> str | None

Mark done. Returns parent_id only if parent is pending and all companions finished.

pop_companion_outputs

pop_companion_outputs(parent_id: str) -> list[Any]

Pop companion outputs (role-registration order) for bundling into set_engine_outputs.

pop_pending_parent

pop_pending_parent(parent_id: str) -> dict[str, Any] | None

register_companion

register_companion(
    parent_id: str, role: str, companion_id: str
) -> None

register_parent

register_parent(parent_id: str) -> None

set_companion_output

set_companion_output(
    companion_id: str, output: Any
) -> None

Stash companion engine output for the parent to bundle at forward time.