All models outputs are subclasses of BaseOutput, data structures containing all the information returned by the model. The outputs can also be used as tuples or dictionaries.
For example:
from diffusers import DDIMPipeline
pipeline = DDIMPipeline.from_pretrained("google/ddpm-cifar10-32")
outputs = pipeline()
The outputs
object is a ImagePipelineOutput which means it has an image attribute.
You can access each attribute as you normally would or with a keyword lookup, and if that attribute is not returned by the model, you will get None
:
outputs.images
outputs["images"]
When considering the outputs
object as a tuple, it only considers the attributes that don’t have None
values.
For instance, retrieving an image by indexing into it returns the tuple (outputs.images)
:
outputs[:1]
To check a specific pipeline or model output, refer to its corresponding API documentation.
Base class for all model outputs as dataclass. Has a __getitem__
that allows indexing by integer or slice (like a
tuple) or strings (like a dictionary) that will ignore the None
attributes. Otherwise behaves like a regular
Python dictionary.
You can’t unpack a BaseOutput
directly. Use the to_tuple() method to convert it to a tuple
first.
Convert self to a tuple containing all the attributes/keys that are not None
.
( images: typing.Union[typing.List[PIL.Image.Image], numpy.ndarray] )
Output class for image pipelines.
( images: typing.Union[typing.List[PIL.Image.Image], numpy.ndarray] )
Output class for image pipelines.
“Returns a new object replacing the specified fields with new values.
( audios: ndarray )
Output class for audio pipelines.
( images: typing.Union[typing.List[PIL.Image.Image], numpy.ndarray, NoneType] text: typing.Union[typing.List[str], typing.List[typing.List[str]], NoneType] )
Parameters
List[PIL.Image.Image]
or np.ndarray
) —
List of denoised PIL images of length batch_size
or NumPy array of shape (batch_size, height, width, num_channels)
. List[str]
or List[List[str]]
) —
List of generated text strings of length batch_size
or a list of list of strings whose outer list has
length batch_size
. Output class for joint image-text pipelines.