Boyang ZHONG
dc72a35f4e
For n > 1, the image endpoints returned one preview grid instead of n images. The endpoints now run one model batch, save each decoded sample as its own file, and return one URL or base64 item for each image. This applies to generations and edits. A keyword-only return_samples field (default False) is added to OutputConfig, SamplingParam and ForwardBatch. Batched image requests set it and do not build preview frames. The worker keeps the sample tensor for these requests, and non-output ranks clear the field. Defaults and positional arguments do not change.
51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# V1 API
|
|
|
|
FastVideo's V1 API provides a streamlined interface for video generation tasks with powerful customization options. This page documents the primary components of the API.
|
|
|
|
## Video Generator
|
|
|
|
This class will be the primary Python API for generating videos and images.
|
|
|
|
::: fastvideo.entrypoints.video_generator.VideoGenerator
|
|
options:
|
|
show_root_heading: true
|
|
show_source: false
|
|
members:
|
|
- from_pretrained
|
|
heading_level: 3
|
|
|
|
`VideoGenerator.from_pretrained()` should be the primary way of creating a new video generator.
|
|
|
|
## Configuring FastVideo
|
|
|
|
The following two classes `PipelineConfig` and `SamplingParam` are used to configure initialization and sampling parameters, respectively.
|
|
|
|
### PipelineConfig
|
|
|
|
::: fastvideo.configs.pipelines.base.PipelineConfig
|
|
options:
|
|
show_root_heading: true
|
|
show_source: false
|
|
members:
|
|
- from_pretrained
|
|
- dump_to_json
|
|
heading_level: 4
|
|
|
|
### SamplingParam
|
|
|
|
::: fastvideo.api.sampling_param.SamplingParam
|
|
options:
|
|
show_root_heading: true
|
|
show_source: false
|
|
members:
|
|
- from_pretrained
|
|
heading_level: 4
|
|
|
|
### Returning samples without previews
|
|
|
|
Set `OutputConfig(return_samples=True, return_frames=False, save_video=False)`
|
|
to receive the decoded CPU tensor in `GenerationResult.samples` without building
|
|
preview grids or writing media. Pixel samples retain the existing float `[0, 1]`
|
|
contract. `return_frames=True` continues to return both samples and preview frames.
|
|
The legacy sampling/keyword interface accepts the same `return_samples` option.
|