259 lines
7.8 KiB
YAML
259 lines
7.8 KiB
YAML
site_name: FastVideo
|
|
site_description: A unified inference and post-training framework for accelerated video generation
|
|
site_author: FastVideo Team
|
|
site_url: https://haoailab.com/FastVideo/
|
|
|
|
# Documentation directory
|
|
docs_dir: docs
|
|
exclude_docs: |
|
|
README.md
|
|
generate_examples.py
|
|
**/__pycache__/**
|
|
|
|
# Repository
|
|
repo_name: hao-ai-lab/FastVideo
|
|
repo_url: https://github.com/hao-ai-lab/FastVideo
|
|
edit_uri: edit/main/docs/
|
|
|
|
# Configuration
|
|
theme:
|
|
name: material
|
|
favicon: assets/logos/icon_simple.svg
|
|
palette:
|
|
- media: "(prefers-color-scheme)"
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
toggle:
|
|
icon: material/brightness-2
|
|
name: Switch to system preference
|
|
features:
|
|
- content.action.edit
|
|
- content.code.annotate
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
- navigation.instant
|
|
- navigation.instant.progress
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.tracking
|
|
- navigation.top
|
|
- navigation.path
|
|
- search.highlight
|
|
- search.share
|
|
- toc.follow
|
|
icon:
|
|
logo: material/book-open-variant
|
|
font:
|
|
text: Roboto
|
|
code: Roboto Mono
|
|
|
|
# Native MkDocs hooks
|
|
hooks:
|
|
- docs/generate_examples.py
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search:
|
|
lang: en
|
|
- autorefs
|
|
- glightbox
|
|
- git-revision-date-localized:
|
|
# exclude autogenerated files
|
|
exclude:
|
|
- examples/*
|
|
- getting_started/examples/*
|
|
- inference/examples/*
|
|
- training/examples/*
|
|
- distillation/examples/*
|
|
- minify:
|
|
minify_html: true
|
|
minify_js: true
|
|
minify_css: true
|
|
cache_safe: true
|
|
js_files: [assets/copy-page.js, assets/cookbook.js]
|
|
css_files: [assets/custom.css]
|
|
- api-autonav:
|
|
modules: ["fastvideo"]
|
|
api_root_uri: "api"
|
|
on_implicit_namespace_package: skip
|
|
exclude:
|
|
- "re:fastvideo\\._.*"
|
|
- "fastvideo.tests"
|
|
- "fastvideo.third_party"
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
paths: [.]
|
|
options:
|
|
docstring_style: google
|
|
# Avoid flooding build logs with existing API docstring lint debt.
|
|
docstring_options:
|
|
warnings: false
|
|
show_source: true
|
|
show_root_heading: true
|
|
show_root_toc_entry: true
|
|
show_symbol_type_heading: true
|
|
show_object_full_path: true
|
|
show_category_heading: true
|
|
signature_crossrefs: true
|
|
show_if_no_docstring: false
|
|
show_signature_annotations: true
|
|
separate_signature: true
|
|
merge_init_into_class: true
|
|
show_bases: true
|
|
show_root_full_path: false
|
|
show_root_members_full_path: false
|
|
inventories:
|
|
- https://docs.python.org/3/objects.inv
|
|
|
|
|
|
# Markdown extensions
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
# line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.emoji
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.critic
|
|
- pymdownx.details
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
# For in page [TOC] (not sidebar)
|
|
- toc:
|
|
permalink: true
|
|
- mdx_truly_sane_lists
|
|
|
|
# Page tree
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: getting_started/installation.md
|
|
- Apple Silicon FastWan: getting_started/installation/mps.md
|
|
- Quick Start: getting_started/quick_start.md
|
|
- V1 API: getting_started/v1_api.md
|
|
- Cookbook:
|
|
- Model Families: cookbook/index.md
|
|
- Wan: cookbook/wan.md
|
|
- LTX: cookbook/ltx.md
|
|
- Hunyuan: cookbook/hunyuan.md
|
|
- Cosmos: cookbook/cosmos.md
|
|
- Kandinsky 5: cookbook/kandinsky5.md
|
|
- FLUX: cookbook/flux.md
|
|
- GLM-Image: cookbook/glm-image.md
|
|
- Z-Image: cookbook/z-image.md
|
|
- Stable Diffusion: cookbook/stable-diffusion.md
|
|
- MiniMax H3: cookbook/minimax-h3.md
|
|
- LongCat: cookbook/longcat.md
|
|
- Stable Audio: cookbook/stable-audio.md
|
|
- MMAudio: cookbook/mmaudio.md
|
|
- Matrix Game: cookbook/matrix-game.md
|
|
- TurboDiffusion: cookbook/turbodiffusion.md
|
|
- Inference:
|
|
- Quick Start: inference/inference_quick_start.md
|
|
- Configuration: inference/configuration.md
|
|
- Offloading: inference/offloading.md
|
|
- Optimizations: inference/optimizations.md
|
|
- ComfyUI: inference/comfyui.md
|
|
- Support Matrix: inference/support_matrix.md
|
|
- CLI: inference/cli.md
|
|
- Add Pipeline: inference/add_pipeline.md
|
|
- Examples:
|
|
- Examples Index: inference/examples/examples_inference_index.md
|
|
- Basic: inference/examples/basic.md
|
|
- Optimizations: inference/examples/optimizations.md
|
|
- LTX-2.3: inference/examples/ltx2_3.md
|
|
- LTX-2.3 Gradio Demo: inference/examples/gradio_local_demo_ltx2_3.md
|
|
- STA Mask Search (Archived): inference/examples/sta_mask_search.md
|
|
- Training:
|
|
- Overview: training/overview.md
|
|
- Training Infrastructure: training/train_infra.md
|
|
- Experiment Tracking: training/trackers.md
|
|
- Data Preprocessing: training/data_preprocess.md
|
|
- Fine-tuning: training/finetune.md
|
|
- Attn-QAT Training: training/attn_qat.md
|
|
- Examples:
|
|
- Training Index: training/examples/examples_training_index.md
|
|
- Wan T2V 1.3B: training/examples/wan_t2v_1.3B.md
|
|
- Wan I2V 14B 480p: training/examples/wan_i2v_14B_480p.md
|
|
- Wan2.1 Fun 1.3B InP: training/examples/Wan2.1-Fun-1.3B-InP.md
|
|
- Wan2.1 VSA: training/examples/Wan2.1-VSA.md
|
|
- Fine-tuning: training/examples/finetune.md
|
|
- Distillation:
|
|
- Data Preprocessing: distillation/data_preprocess.md
|
|
- DMD: distillation/dmd.md
|
|
- AnyFlow: distillation/anyflow.md
|
|
- Attention:
|
|
- Overview: attention/index.md
|
|
- Video Sparse Attention: attention/vsa/index.md
|
|
- Sliding Tile Attention (Archived): attention/sta/index.md
|
|
- Backend Development: contributing/attention_backend.md
|
|
- Utilities:
|
|
- LoRA: utilities/lora.md
|
|
- Debugging: utilities/debugging.md
|
|
- Design:
|
|
- Overview: design/overview.md
|
|
- Training Architecture: design/training_architecture.md
|
|
- Server Contracts:
|
|
- Overview: design/server_contracts/index.md
|
|
- OpenAI HTTP: design/server_contracts/openai.md
|
|
- Streaming WebSocket: design/server_contracts/streaming.md
|
|
- Dynamo Integration: design/server_contracts/dynamo.md
|
|
- Developer Guide:
|
|
- Overview: contributing/overview.md
|
|
- Developer Environment:
|
|
- Index: contributing/developer_env/index.md
|
|
- Docker: contributing/developer_env/docker.md
|
|
- RunPod: contributing/developer_env/runpod.md
|
|
- Pull Requests: contributing/pull_requests.md
|
|
- CI/CD Architecture: contributing/ci_architecture.md
|
|
- Testing: contributing/testing.md
|
|
- Performance Benchmarks: contributing/performance_benchmarks.md
|
|
- Profiling: contributing/profiling.md
|
|
- Activation Trace: contributing/activation_trace.md
|
|
- Coding Agents: contributing/coding_agents.md
|
|
- Dreamverse Development: contributing/dreamverse-development.md
|
|
- Attention Backend Development: contributing/attention_backend.md
|
|
- API Reference:
|
|
- Overview: api/index.md
|
|
|
|
|
|
# Extra
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/hao-ai-lab/FastVideo
|
|
version:
|
|
provider: mike
|
|
|
|
# Custom CSS
|
|
extra_css:
|
|
- assets/custom.css
|
|
|
|
# Custom JavaScript
|
|
extra_javascript:
|
|
- assets/copy-page.js
|
|
- assets/cookbook.js
|