Files
hao-ai-lab-FastVideo/docs
65cb91ed70 [docs] streaming: Dynamo native-backend integration reference
docs/design/server_contracts/dynamo.md documents the integration shape
the ai-dynamo/dynamo native backend package consumes. Per the refactor
decision, no Dynamo code lives in FastVideo — the backend package
ships in the Dynamo repo at components/src/dynamo/fastvideo/ with the
layout mirroring components/src/dynamo/sglang/.

Captured here:

* the 8-symbol public surface Dynamo imports (VideoGenerator plus
  ContinuationState, GenerationRequest, SamplingConfig, InputConfig,
  OutputConfig, VideoEvent, VideoResult) and what is available today
  vs. what lands in PR 7.10
* target backend package layout matching the sglang template
* full NvCreateVideoRequest <-> GenerationRequest mapping table and
  VideoFinalEvent <-> NvVideosResponse reverse mapping
* worked examples: aggregated handler (works today with generate_video
  + asyncio.to_thread), streaming handler (post-PR 7.10 via
  generate_async), health check payload (swapping to
  default_health_check_request() after PR 7.10)
* init function sketch, registration (ModelType::Videos fast path),
  args adapter
* contract guarantees that let the adapter be written once and not
  chase FastVideo drift
* explicit no-import list for the adapter

Also wires the server_contracts/ section into mkdocs.yml under Design.

Co-authored-by: Junda (David) Su <90978028+Davids048@users.noreply.github.com>
Co-authored-by: Matthew Noto <99706358+RandNMR73@users.noreply.github.com>
Co-authored-by: XOR-op <17672363+XOR-op@users.noreply.github.com>
Co-authored-by: Zhang Peiyuan <42993249+jzhang38@users.noreply.github.com>
2026-05-07 13:37:25 -07:00
..
2026-02-23 15:14:42 -08:00
2026-02-19 14:23:32 -08:00
2026-03-09 18:58:56 -07:00
2026-02-23 15:14:42 -08:00
2026-02-23 15:14:42 -08:00

FastVideo Documentation

This directory contains the FastVideo documentation built with MkDocs.

Build the docs locally

# Install dependencies
uv pip install -r requirements-mkdocs.txt

# Serve docs with live reload (recommended for development)
mkdocs serve

# Or build static site
mkdocs build

View the docs

Development server (with live reload)

mkdocs serve

Then open your browser to: http://127.0.0.1:8000

Static build

mkdocs build
python -m http.server -d site/

Then open your browser to: http://localhost:8000

Automatic Deployment

Documentation is automatically built and deployed to GitHub Pages when changes are pushed to the main branch via the .github/workflows/infra-docs.yml workflow.