Hugging Face's logo

Diffusers documentation

Latte

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.43.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Latte

latte text-to-video

Latte : Latent Diffusion Transformer pour la génération de vidéos de l'Université Monash, du Shanghai AI Lab, de l'Université de Nanjing et de la Nanyang Technological University.

L'abstract de l'article est :

Nous proposons un nouveau Latent Diffusion Transformer, nommé Latte, pour la génération de vidéos. Latte extrait d'abord des jetons spatio-temporels à partir des vidéos d'entrée, puis adopte une série de blocs Transformer pour modéliser la distribution des vidéos dans l'espace latent. Afin de modéliser un nombre important de jetons extraits des vidéos, quatre variantes efficaces sont introduites sous l'angle de la décomposition des dimensions spatiales et temporelles des vidéos d'entrée. Pour améliorer la qualité des vidéos générées, nous déterminons les meilleures pratiques de Latte par une analyse expérimentale rigoureuse, incluant l'incorporation de jetons de patch de clips vidéo, les variantes de modèle, l'injection d'informations de classe de pas de temps, l'incorporation de position temporelle et les stratégies d'apprentissage. Notre évaluation complète démontre que Latte atteint des performances de pointe sur quatre jeux de données standard de génération de vidéos, à savoir FaceForensics, SkyTimelapse, UCF101 et Taichi-HD. En outre, nous étendons Latte à la tâche de génération de vidéos à partir de texte (T2V), où Latte obtient des résultats comparables à ceux des modèles T2V récents. Nous sommes fermement convaincus que Latte offre des perspectives précieuses pour les recherches futures sur l'intégration des Transformers dans les modèles de diffusion pour la génération de vidéos.

Points forts : Latte est un transformeur de diffusion latente proposé comme architecture de base pour modéliser différentes modalités (entraîné ici pour la génération de vidéos à partir de texte). Il atteint des performances de pointe sur quatre benchmarks vidéo standard - FaceForensics, SkyTimelapse, UCF101 et Taichi-HD. Pour préparer et télécharger les jeux de données pour l'évaluation, veuillez consulter ce lien.

Ce pipeline a été contribué par maxin-cn. La base de code originale peut être trouvée ici. Les poids originaux sont disponibles sous hf.co/maxin-cn.

Pensez à consulter le guide des Schedulers pour apprendre à explorer le compromis entre la vitesse et la qualité du scheduler, et à consulter la section réutilisation des composants entre les pipelines pour apprendre à charger efficacement les mêmes composants dans plusieurs pipelines.

Inférence

Utilisez torch.compile pour réduire la latence d'inférence.

Tout d'abord, chargez le pipeline :

import torch
from diffusers import LattePipeline

pipeline = LattePipeline.from_pretrained(
	"maxin-cn/Latte-1", dtype=torch.float16
).to("cuda")  # or "mps", "xpu", "cpu"

Puis modifiez la disposition mémoire des composants transformer et vae des pipelines en torch.channels-last :

pipeline.transformer.to(memory_format=torch.channels_last)
pipeline.vae.to(memory_format=torch.channels_last)

Enfin, compilez les composants et exécutez l'inférence :

pipeline.transformer = torch.compile(pipeline.transformer)
pipeline.vae.decode = torch.compile(pipeline.vae.decode)

video = pipeline(prompt="A dog wearing sunglasses floating in space, surreal, nebulae in background").frames[0]

Les résultats du benchmark sur une machine A100 de 80 Go sont :

Without torch.compile(): Average inference time: 16.246 seconds.
With torch.compile(): Average inference time: 14.573 seconds.

Quantification

La quantification aide à réduire les besoins en mémoire des très grands modèles en stockant les poids du modèle dans un type de données de précision inférieure. Cependant, la quantification peut avoir un impact variable sur la qualité de la vidéo selon le modèle vidéo.

Reportez-vous à l'aperçu de la Quantization pour en savoir plus sur les backends de quantification pris en charge et sur la sélection d'un backend de quantification adapté à votre cas d'usage. L'exemple ci-dessous montre comment charger un LattePipeline quantifié pour l'inférence avec bitsandbytes.

import torch
from diffusers import BitsAndBytesConfig as DiffusersBitsAndBytesConfig, LatteTransformer3DModel, LattePipeline
from diffusers.utils import export_to_gif
from transformers import BitsAndBytesConfig as BitsAndBytesConfig, T5EncoderModel

quant_config = BitsAndBytesConfig(load_in_8bit=True)
text_encoder_8bit = T5EncoderModel.from_pretrained(
    "maxin-cn/Latte-1",
    subfolder="text_encoder",
    quantization_config=quant_config,
    dtype=torch.float16,
)

quant_config = DiffusersBitsAndBytesConfig(load_in_8bit=True)
transformer_8bit = LatteTransformer3DModel.from_pretrained(
    "maxin-cn/Latte-1",
    subfolder="transformer",
    quantization_config=quant_config,
    dtype=torch.float16,
)

pipeline = LattePipeline.from_pretrained(
    "maxin-cn/Latte-1",
    text_encoder=text_encoder_8bit,
    transformer=transformer_8bit,
    dtype=torch.float16,
    device_map="balanced",
)

prompt = "A small cactus with a happy face in the Sahara desert."
video = pipeline(prompt).frames[0]
export_to_gif(video, "latte.gif")

LattePipeline

classe diffusers.LattePipeline

< >

( tokenizer: T5Tokenizertext_encoder: T5EncoderModelvae: AutoencoderKLtransformer: LatteTransformer3DModelscheduler: KarrasDiffusionSchedulers )

Paramètres

  • vae (AutoencoderKL) — Modèle de Variational Auto-Encoder (VAE) pour encoder et décoder des vidéos vers et depuis des représentations latentes.
  • text_encoder (T5EncoderModel) — Encodeur de texte figé. Latte utilise T5, plus précisément la variante t5-v1_1-xxl.
  • tokenizer (T5Tokenizer) — Tokeniseur de la classe T5Tokenizer.
  • transformer (LatteTransformer3DModel) — Un LatteTransformer3DModel conditionné par le texte pour débruyer les latents vidéo encodés.
  • scheduler (SchedulerMixin) — Un scheduler à utiliser en combinaison avec transformer pour débruyer les latents vidéo encodés.

Pipeline pour la génération de vidéos à partir de texte utilisant Latte.

Ce modèle hérite de DiffusionPipeline. Consultez la documentation de la classe parente pour les méthodes génériques que la bibliothèque implémente pour tous les pipelines (tels que le téléchargement ou l'enregistrement, l'exécution sur un appareil particulier, etc.)

__call__

< >

( prompt: str | list[str] = Nonenegative_prompt: str = ''num_inference_steps: int = 50timesteps: list[int] | None = Noneguidance_scale: float = 7.5num_images_per_prompt: int = 1video_length: int = 16height: int = 512width: int = 512eta: float = 0.0generator: typing.Union[torch.Generator, list[torch.Generator], NoneType] = Nonelatents: typing.Optional[torch.FloatTensor] = Noneprompt_embeds: typing.Optional[torch.FloatTensor] = Nonenegative_prompt_embeds: typing.Optional[torch.FloatTensor] = Noneoutput_type: str = 'pil'return_dict: bool = Truecallback_on_step_end: typing.Union[typing.Callable[[int, int], NoneType], diffusers.callbacks.PipelineCallback, diffusers.callbacks.MultiPipelineCallbacks, NoneType] = Nonecallback_on_step_end_tensor_inputs: list[str] = ['latents']clean_caption: bool = Truemask_feature: bool = Trueenable_temporal_attentions: bool = Truedecode_chunk_size: int = 14 ) → LattePipelineOutput or tuple

Paramètres

  • prompt (str ou list[str], facultatif) — Le prompt ou les prompts pour guider la génération de la vidéo. S'il n'est pas défini, il faut passer prompt_embeds à la place.
  • negative_prompt (str ou list[str], facultatif) — Le ou les prompts à ne pas utiliser pour guider la génération de la vidéo. S'il n'est pas défini, il faut passer negative_prompt_embeds à la place. Ignoré lorsque la guidance n'est pas utilisée (c'est-à-dire ignoré si guidance_scale est inférieur à 1).
  • num_inference_steps (int, facultatif, valeur par défaut 100) — Le nombre d’étapes de débruitage. Un plus grand nombre d’étapes de débruitage conduit généralement à une vidéo de meilleure qualité, au prix d’une inférence plus lente.
  • timesteps (list[int], facultatif) — Timesteps personnalisés à utiliser pour le processus de débruitage. S'ils ne sont pas définis, des timesteps num_inference_steps équidistants sont utilisés. Ils doivent être dans l'ordre décroissant.
  • guidance_scale (float, facultatif, valeur par défaut 7.0) — Échelle de guidage telle que définie dans Classifier-Free Diffusion Guidance. guidance_scale est défini comme w de l’équation 2 de Imagen Paper. L’échelle de guidage est activée en définissant guidance_scale > 1. Une échelle de guidage plus élevée encourage la génération de vidéos étroitement liées au prompt texte, généralement au détriment de la qualité de la vidéo.
  • video_length (int, facultatif, par défaut 16) — Le nombre de frames de vidéo générées. Par défaut, 16 frames, soit 8 frames par seconde
  • num_images_per_prompt (int, facultatif, valeur par défaut : 1) — Le nombre de vidéos à générer par invite.
  • height (int, facultatif, par défaut self.unet.config.sample_size) — La hauteur en pixels de la vidéo générée.
  • width (int, facultatif, par défaut self.unet.config.sample_size) — La largeur en pixels de la vidéo générée.
  • eta (float, facultatif, valeur par défaut 0.0) — Correspond au paramètre eta (η) du papier DDIM : https://huggingface.co/papers/2010.02502. Ne s'applique qu'à schedulers.DDIMScheduler, sera ignoré pour les autres.
  • generator (torch.Generator ou list[torch.Generator], facultatif) — Un ou une liste de générateurs torch pour rendre la génération déterministe.
  • latents (torch.FloatTensor, facultatif) — Latents bruités pré-générés, échantillonnés à partir d’une distribution gaussienne, à utiliser comme entrées pour la génération de vidéo. Peut être utilisé pour ajuster la même génération avec des prompts différents. S’il n’est pas fourni, un tenseur de latents sera généré par échantillonnage à l’aide du generator aléatoire fourni.
  • prompt_embeds (torch.FloatTensor, facultatif) — Embeddings de texte pré-générés. Peut être utilisé pour ajuster facilement les entrées de texte, par ex. le pondération des prompts. S'il n'est pas fourni, les embeddings de texte seront générés à partir de l'argument d'entrée prompt.
  • negative_prompt_embeds (torch.FloatTensor, facultatif) — Embeddings de texte négatifs pré-générés. Pour Latte, ce prompt négatif doit être "". S'il n'est pas fourni, negative_prompt_embeds sera généré à partir de l'argument d'entrée negative_prompt.
  • output_type (str, facultatif, par défaut "pil") — Le format de sortie de la vidéo générée. Choisissez entre PIL : PIL.Image.Image ou np.array.
  • return_dict (bool, facultatif, par défaut True) — Indique s'il faut retourner un ~pipelines.stable_diffusion.IFPipelineOutput plutôt qu'un simple tuple.
  • callback_on_step_end (Callable[[int, int], None], PipelineCallback, MultiPipelineCallbacks, facultatif) — Fonction de rappel ou liste de fonctions de rappel à appeler à la fin de chaque étape de débruitage.
  • callback_on_step_end_tensor_inputs (list[str], facultatif) — Une liste des entrées tensorielles qui doivent être transmises à la fonction de rappel. Si non définie, toutes les entrées tensorielles seront transmises.
  • clean_caption (bool, facultatif, par défaut True) — Indique s'il faut nettoyer la légende avant de créer les embeddings. Nécessite l'installation de beautifulsoup4 et ftfy. Si les dépendances ne sont pas installées, les embeddings seront créés à partir du prompt brut.
  • mask_feature (bool par défaut True) — Si défini sur True, les embeddings de texte seront masqués.
  • enable_temporal_attentions (bool, facultatif, valeur par défaut True) — Indique s'il faut activer les attentions temporelles
  • decode_chunk_size (int, facultatif) — Le nombre d’images à décoder à la fois. Une taille de bloc plus élevée améliore la cohérence temporelle au prix d’une consommation mémoire accrue. Par défaut, le décodeur décode toutes les images d’un seul tenant pour une qualité maximale. Pour réduire la consommation mémoire, diminuez decode_chunk_size.

Retourne

LattePipelineOutput ou tuple

Si return_dict est True, LattePipelineOutput est retourné, sinon un tuple est retourné dont le premier élément est une liste contenant les images générées

Fonction appelée lors de l'appel du pipeline pour la génération.

Exemples :

>>> import torch
>>> from diffusers import LattePipeline
>>> from diffusers.utils import export_to_gif

>>> # You can replace the checkpoint id with "maxin-cn/Latte-1" too.
>>> pipe = LattePipeline.from_pretrained("maxin-cn/Latte-1", torch_dtype=torch.float16)
>>> # Enable memory optimizations.
>>> pipe.enable_model_cpu_offload()

>>> prompt = "A small cactus with a happy face in the Sahara desert."
>>> videos = pipe(prompt).frames[0]
>>> export_to_gif(videos, "latte.gif")

encode_prompt

< >

( prompt: str | list[str]do_classifier_free_guidance: bool = Truenegative_prompt: str = ''num_images_per_prompt: int = 1device: typing.Optional[torch.device] = Noneprompt_embeds: typing.Optional[torch.FloatTensor] = Nonenegative_prompt_embeds: typing.Optional[torch.FloatTensor] = Noneclean_caption: bool = Falsemask_feature: bool = Truedtype = None )

Paramètres

  • prompt (str ou list[str], facultatif) — prompt à encoder
  • negative_prompt (str ou list[str], facultatif) — Le prompt à ne pas utiliser pour guider la génération de la vidéo. S’il n’est pas défini, il faut passer negative_prompt_embeds à la place. Ignoré lorsque la guidance n’est pas utilisée (c’est-à-dire ignoré si guidance_scale est inférieur à 1). Pour Latte, cette valeur doit être "".
  • do_classifier_free_guidance (bool, facultatif, valeur par défaut True) — indique s'il faut utiliser le classifier free guidance ou non
  • num_images_per_prompt (int, facultatif, valeur par défaut 1) — nombre de vidéos à générer par invite
  • device — (torch.device, facultatif) : dispositif torch sur lequel placer les embeddings résultants
  • prompt_embeds (torch.FloatTensor, facultatif) — Embeddings de texte pré-générés. Peut être utilisé pour ajuster facilement les entrées de texte, par ex. le pondération des prompts. S'il n'est pas fourni, les embeddings de texte seront générés à partir de l'argument d'entrée prompt.
  • negative_prompt_embeds (torch.FloatTensor, facultatif) — Embeddings de texte négatif pré-générés. Pour Latte, il doit s’agir des embeddings de la chaîne "".
  • clean_caption (bool, par défaut False) — Si True, la fonction prétraite et nettoie la légende fournie avant l’encodage.
  • mask_feature — (bool, par défaut True) : Si True, la fonction masque les embeddings de texte.

Encode le prompt dans les états cachés de l'encodeur de texte.

Update on GitHub

←Kandinsky S2V 1.0 LTX-2→