Docs /Templates/ sinapsis-huggingface-diffusers

ImageToVideoGenXLDiffusers

sinapsis-huggingface-diffusersHuggingFacehuggingfacediffusersmodelsgenerative

Python template · sinapsis_huggingface_diffusers.templates.image_to_video_gen_xl_diffusers

Overview

This class implements a specific template for image-to-video generation using Hugging Face's diffusers. The `ImageToVideoGenXLDiffusers` class inherits from the `ImageToImageDiffusers` template to define how to handle converting input images into videos with the I2VGen-XL pipeline.

Parameters to be used inside generation_params can be seen at HuggingFace documentation: https://huggingface.co/docs/diffusers/api/pipelines/i2vgenxl

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-huggingface-diffusers==1.0.0
uv pip install sinapsis-huggingface-diffusers==1.0.0
uv add sinapsis-huggingface-diffusers==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

seed
int | list[int] | None
Optional
Default: null
deviceRequired
typing.Literal['cuda', 'cpu']
Required
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
model_path
typing.Literal['stable-diffusion-v1-5/stable-diffusion-v1-5', 'stabilityai/stable-diffusion-2-1', 'CompVis/stable-diffusion-v1-4', 'Qwen/Qwen-Image-Edit']
Optional
Default: "stable-diffusion-v1-5/stable-diffusion-v1-5"
torch_dtype
typing.Literal['float16', 'float32']
Optional
Default: "float16"
model_cache_dir
str
Optional
Default: "/home/ariel/.cache/sinapsis"
overwrite_images
bool
Optional
Default: false
generation_params

Task-specific parameters for video generation, such as `num_frames` and `target_fps`.

ImageToVideoGenerationParams
Optional
Default: null
width
int | None
Optional
Default: null
height
int | None
Optional
Default: null
prompt
str | list[str] | None
Optional
Default: null
num_frames

The total number of frames to generate in the video. Defaults to 16.

int | None
Optional
Default: 16
target_fps

The target frames per second for the generated video.

int | None
Optional
Default: null
guidance_scale
float | None
Optional
Default: 7.5
negative_prompt
str | list[str] | None
Optional
Default: null
num_inference_steps
int | None
Optional
Default: 50
num_images_per_prompt
int | None
Optional
Default: 1
num_videos_per_prompt

The number of different videos to generate from the same input image and prompt.

int | None
Optional
Default: null
enable_model_cpu_offload
bool
Optional
Default: false

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: ImageToVideoGenXLDiffusers
  class_name: ImageToVideoGenXLDiffusers
  template_input: InputTemplate
  attributes:
    model_path: '/path/to/diffusers/model'
    model_cache_dir: /path/to/cache/dir
    device: 'cuda'
    torch_dtype: float16
    enable_model_cpu_offload: false
    generation_params: {}
    overwrite_images: false
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "ImageToVideoGenXLDiffusers"
    class_name: "ImageToVideoGenXLDiffusers"
    attributes:
      seed: null
      device: "<required>"
      model_path: "stable-diffusion-v1-5/stable-diffusion-v1-5"
      torch_dtype: "float16"
      model_cache_dir: "/home/ariel/.cache/sinapsis"
      overwrite_images: false
      generation_params:
        width: null
        height: null
        prompt: null
        num_frames: 16
        target_fps: null
        guidance_scale: 7.5
        negative_prompt: null
        num_inference_steps: 50
        num_images_per_prompt: 1
        num_videos_per_prompt: null
      enable_model_cpu_offload: false

Inheritance

Immediate parent: sinapsis_huggingface_diffusers.templates.image_to_image_diffusers.ImageToImageDiffusers

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.