hao-ai-lab-FastVideo/docs/api/fastvideo.md

# FastVideo API Reference

This page contains the complete API reference for the FastVideo library.

## fastvideo

### Modules

| Name | Description |
|------|-------------|
| [attention](#fastvideoattention) | Attention mechanisms and backends for video generation |
| [configs](#fastvideoconfigs) | Configuration classes for pipelines, models, and sampling |
| [distributed](#fastvideodistributed) | Distributed execution and communication utilities |
| [entrypoints](#fastvideoentrypoints) | Main API entry points for video generation |
| [models](#fastvideomodels) | Model implementations (transformers, VAEs, schedulers) |
| [pipelines](#fastvideopipelines) | Core pipeline classes for video diffusion |
| [training](#fastvideotraining) | Training utilities and helpers |
| [workflow](#fastvideoworkflow) | Workflow management and orchestration |
| [dataset](#fastvideodataset) | Dataset handling and preprocessing |
| [layers](#fastvideolayers) | Custom neural network layers |
| [platforms](#fastvideoplatforms) | Platform-specific implementations |
| [utils](#fastvideoutils) | Utility functions and helpers |
| [worker](#fastvideoworker) | Execution workers for video generation |

## fastvideo.attention

::: fastvideo.attention
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.configs

::: fastvideo.configs
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

### Submodules

#### fastvideo.configs.pipelines

::: fastvideo.configs.pipelines
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

#### fastvideo.configs.models

::: fastvideo.configs.models
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

#### fastvideo.api.sampling_param

::: fastvideo.api.sampling_param
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

## fastvideo.distributed

::: fastvideo.distributed
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.entrypoints

::: fastvideo.entrypoints
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.models

::: fastvideo.models
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

### Submodules

#### fastvideo.models.registry

::: fastvideo.models.registry
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

#### fastvideo.models.loader

::: fastvideo.models.loader
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

## fastvideo.registry

::: fastvideo.registry
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 3

## fastvideo.pipelines

::: fastvideo.pipelines
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

### Submodules

#### fastvideo.pipelines.composed_pipeline_base

::: fastvideo.pipelines.composed_pipeline_base
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

#### fastvideo.pipelines.lora_pipeline

::: fastvideo.pipelines.lora_pipeline
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

#### fastvideo.pipelines.pipeline_batch_info

::: fastvideo.pipelines.pipeline_batch_info
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

#### fastvideo.pipelines.pipeline_registry

::: fastvideo.pipelines.pipeline_registry
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

#### fastvideo.pipelines.stages

::: fastvideo.pipelines.stages
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 4

## fastvideo.training

::: fastvideo.training
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.workflow

::: fastvideo.workflow
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.dataset

::: fastvideo.dataset
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.layers

::: fastvideo.layers
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.platforms

::: fastvideo.platforms
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3

## fastvideo.utils

::: fastvideo.utils
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      heading_level: 3

## fastvideo.worker

::: fastvideo.worker
    options:
      show_source: true
      show_root_heading: true
      show_root_toc_entry: true
      show_submodules: true
      heading_level: 3