[feat] [2/n] Improve API: add initial support in video_generator (#1220)

Author: SolitaryThinker

examples/inference/basic/README.md

@@ -28,6 +28,11 @@ For an example running DMD+VSA inference:
 python examples/inference/basic/basic_dmd.py
 ```
 
+For the typed config/request path added during the inference API refactor:
+```
+python examples/inference/basic/basic_dmd_new_api.py
+```
+
 ## Basic Walkthrough
 
 All you need to generate videos using multi-gpus from state-of-the-art diffusion pipelines is the following few lines!

examples/inference/basic/basic_dmd_new_api.py

@@ -0,0 +1,98 @@
+import os
+import time
+
+from fastvideo import VideoGenerator
+from fastvideo.api import (
+    EngineConfig,
+    GenerationRequest,
+    GeneratorConfig,
+    OffloadConfig,
+    OutputConfig,
+    PipelineSelection,
+)
+
+OUTPUT_PATH = "video_samples_dmd2_typed"
+
+
+def main():
+    os.environ["FASTVIDEO_ATTENTION_BACKEND"] = "VIDEO_SPARSE_ATTN"
+
+    model_name = "FastVideo/FastWan2.1-T2V-1.3B-Diffusers"
+    generator_config = GeneratorConfig(
+        model_path=model_name,
+        engine=EngineConfig(
+            num_gpus=1,
+            use_fsdp_inference=False,
+            offload=OffloadConfig(
+                text_encoder=True,
+                pin_cpu_memory=True,
+                dit=False,
+                vae=False,
+            ),
+        ),
+        # PR 2 still routes a few advanced inference knobs through the
+        # compatibility bridge until they get first-class typed fields.
+        pipeline=PipelineSelection(
+            experimental={
+                "VSA_sparsity": 0.8,
+            },
+        ),
+    )
+
+    load_start_time = time.perf_counter()
+    generator = VideoGenerator.from_config(generator_config)
+    load_end_time = time.perf_counter()
+    load_time = load_end_time - load_start_time
+
+    prompt = (
+        "A neon-lit alley in futuristic Tokyo during a heavy rainstorm at night. "
+        "The puddles reflect glowing signs in kanji, advertising ramen, karaoke, "
+        "and VR arcades. A woman in a translucent raincoat walks briskly with an "
+        "LED umbrella. Steam rises from a street food cart, and a cat darts "
+        "across the screen. Raindrops are visible on the camera lens, creating "
+        "a cinematic bokeh effect."
+    )
+    request = GenerationRequest(
+        prompt=prompt,
+        output=OutputConfig(
+            output_path=OUTPUT_PATH,
+            save_video=True,
+            return_frames=False,
+        ),
+    )
+
+    start_time = time.perf_counter()
+    result = generator.generate(request)
+    end_time = time.perf_counter()
+    gen_time = end_time - start_time
+
+    prompt2 = (
+        "A majestic lion strides across the golden savanna, its powerful frame "
+        "glistening under the warm afternoon sun. The tall grass ripples gently "
+        "in the breeze, enhancing the lion's commanding presence. The tone is "
+        "vibrant, embodying the raw energy of the wild. Low angle, steady "
+        "tracking shot, cinematic."
+    )
+    request2 = GenerationRequest(
+        prompt=prompt2,
+        output=OutputConfig(
+            output_path=OUTPUT_PATH,
+            save_video=True,
+            return_frames=False,
+        ),
+    )
+
+    start_time = time.perf_counter()
+    result2 = generator.generate(request2)
+    end_time = time.perf_counter()
+    gen_time2 = end_time - start_time
+
+    print(f"Time taken to load model: {load_time} seconds")
+    print(f"Time taken to generate video: {gen_time} seconds")
+    print(f"First output written to: {result.video_path}")
+    print(f"Time taken to generate video2: {gen_time2} seconds")
+    print(f"Second output written to: {result2.video_path}")
+
+
+if __name__ == "__main__":
+    main()

fastvideo/api/__init__.py

@@ -30,13 +30,15 @@
     load_serve_config,
     parse_config,
 )
+from fastvideo.api.results import GenerationResult
 
 __all__ = [
     "CompileConfig",
     "ComponentConfig",
     "ContinuationState",
     "ConfigValidationError",
     "EngineConfig",
+    "GenerationResult",
     "GenerationPlan",
     "GenerationRequest",
     "GeneratorConfig",