Main API Reference

This page documents the primary interface for World Engine.

WorldEngine

class world_engine.WorldEngine(model_uri, quant=None, model_config_overrides=None, device=None, dtype=torch.bfloat16)

Bases: object

__init__(model_uri, quant=None, model_config_overrides=None, device=None, dtype=torch.bfloat16)

model_uri: HF URI or local folder containing model.safetensors and config.yaml quant: None | w8a8 | nvfp4

reset()

Reset state for new generation

set_prompt(prompt)

Apply text conditioning for T2V

append_frame(img, ctrl=None)

gen_frame(ctrl=None, return_img=True)

prep_inputs(x, ctrl=None)

CtrlInput

class world_engine.CtrlInput(button=<factory>, mouse=(0.0, 0.0), scroll_wheel=0)

Bases: object

button: Set[int]

mouse: Tuple[float, float] = (0.0, 0.0)

scroll_wheel: int = 0

__init__(button=<factory>, mouse=(0.0, 0.0), scroll_wheel=0)