Diffusers documentation

Sorties

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

and get access to the augmented documentation experience

to get started

Sorties

Toutes les sorties des modèles sont des sous-classes de BaseOutput, des structures de données contenant toutes les informations renvoyées par le modèle. Les sorties peuvent également être utilisées comme des tuples ou des dictionnaires.

Par exemple :

from diffusers import DDIMPipeline

pipeline = DDIMPipeline.from_pretrained("google/ddpm-cifar10-32")
outputs = pipeline()

L'objet outputs est un ImagePipelineOutput, ce qui signifie qu'il possède un attribut image.

Vous pouvez accéder à chaque attribut de manière habituelle ou par recherche de mot-clé, et si cet attribut n'est pas renvoyé par le modèle, vous obtiendrez None :

outputs.images
outputs["images"]

Lorsque l’objet outputs est considéré comme un tuple, seuls les attributs dont la valeur n’est pas None sont pris en compte. Par exemple, récupérer une image par indexation renvoie le tuple (outputs.images) :

outputs[:1]

Pour vérifier la sortie d'un pipeline ou d'un modèle spécifique, reportez-vous à la documentation API correspondante.

BaseOutput

classe diffusers.utils.BaseOutput

< >

( )

Classe de base pour toutes les sorties de modèle, sous forme de dataclass. Elle possède un __getitem__ qui permet l’indexation par entier ou tranche (comme un tuple) ou par chaînes de caractères (comme un dictionnaire), en ignorant les attributs None. Sinon, elle se comporte comme un dictionnaire Python standard.

> Vous ne pouvez pas dépaqueter directement un BaseOutput. Utilisez d'abord la méthode to_tuple() pour le convertir en tuple.

to_tuple

< >

( )

Convertit self en un tuple contenant tous les attributs/clés qui ne sont pas None.

ImagePipelineOutput

classe diffusers.ImagePipelineOutput

< >

( images: list[PIL.Image.Image] | numpy.ndarray )

Paramètres

  • images (List[PIL.Image.Image] ou np.ndarray) — Liste d'images PIL débruitées de longueur batch_size ou tableau NumPy de forme (batch_size, height, width, num_channels).

Classe de sortie pour les pipelines d’images.

AudioPipelineOutput

classe diffusers.AudioPipelineOutput

< >

( audios: ndarray )

Paramètres

  • audios (np.ndarray) — Liste d'échantillons audio débruités sous forme de tableau NumPy de forme (batch_size, num_channels, sample_rate).

Classe de sortie pour les pipelines audio.

ImageTextPipelineOutput

classe diffusers.ImageTextPipelineOutput

< >

( images: list[PIL.Image.Image] | numpy.ndarray | Nonetext: list[str] | list[list[str]] | None )

Paramètres

  • images (list[PIL.Image.Image] ou np.ndarray) — liste d'images PIL débruitées de longueur batch_size ou tableau NumPy de forme (batch_size, height, width, num_channels).
  • text (list[str] ou list[list[str]]) — liste de chaînes de texte générées de longueur batch_size ou liste de listes de chaînes dont la liste externe a une longueur batch_size.

Classe de sortie pour les pipelines image-texte conjoints.

Update on GitHub