sdxl_decoder_pipe.py

# Modify from https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/stable_diffusion_xl/pipeline_stable_diffusion_xl.py
import inspect
from dataclasses import dataclass
from typing import Any, Callable, Dict, List, Optional, Tuple, Union

import numpy as np
import torch
import torch.nn as nn
import torch.nn.functional as F

from einops import repeat, rearrange

from diffusers.callbacks import MultiPipelineCallbacks, PipelineCallback
from diffusers.image_processor import PipelineImageInput, VaeImageProcessor

from diffusers.models import AutoencoderKL, ImageProjection, UNet2DConditionModel
from diffusers.schedulers import KarrasDiffusionSchedulers

from diffusers.utils.torch_utils import randn_tensor
import PIL.Image

from diffusers.models.attention_processor import (
    AttnProcessor2_0,
    FusedAttnProcessor2_0,
    XFormersAttnProcessor,
)

from diffusers.utils import (
    USE_PEFT_BACKEND,
    deprecate,
    is_invisible_watermark_available,
    is_torch_xla_available,
    logging,
    replace_example_docstring,
    scale_lora_layers,
    unscale_lora_layers,
)

from diffusers.pipelines.pipeline_utils import DiffusionPipeline, StableDiffusionMixin
from diffusers.loaders import (
    FromSingleFileMixin,
    IPAdapterMixin,
    StableDiffusionXLLoraLoaderMixin,
    TextualInversionLoaderMixin,
)

if is_invisible_watermark_available():
    from diffusers.pipelines.stable_diffusion_xl.watermark import StableDiffusionXLWatermarker

from diffusers.pipelines.stable_diffusion_xl.pipeline_output import StableDiffusionXLPipelineOutput
from diffusers.pipelines.stable_diffusion_xl.pipeline_stable_diffusion_xl import StableDiffusionXLPipeline, \
    retrieve_timesteps, rescale_noise_cfg

from torchvision.transforms import Compose, Resize, CenterCrop, Normalize, InterpolationMode

if is_torch_xla_available():
    import torch_xla.core.xla_model as xm

    XLA_AVAILABLE = True
else:
    XLA_AVAILABLE = False

logger = logging.get_logger(__name__)  # pylint: disable=invalid-name


@dataclass
class StableDiffusionXLDecoderPipelineOutput(StableDiffusionXLPipelineOutput):
    images: Union[List[PIL.Image.Image], np.ndarray]
    indices_semantic: Optional[torch.Tensor] = None
    indices_pixel: Optional[torch.Tensor] = None


def expand_dims_like(x, y):
    while x.dim() != y.dim():
        x = x.unsqueeze(-1)
    return x


class AbstractEmbModel(nn.Module):
    def __init__(self):
        super().__init__()
        self._is_trainable = None
        self._ucg_rate = None
        self._input_key = None

    @property
    def is_trainable(self) -> bool:
        return self._is_trainable

    @property
    def ucg_rate(self) -> Union[float, torch.Tensor]:
        return self._ucg_rate

    @property
    def input_key(self) -> str:
        return self._input_key

    @is_trainable.setter
    def is_trainable(self, value: bool):
        self._is_trainable = value

    @ucg_rate.setter
    def ucg_rate(self, value: Union[float, torch.Tensor]):
        self._ucg_rate = value

    @input_key.setter
    def input_key(self, value: str):
        self._input_key = value

    @is_trainable.deleter
    def is_trainable(self):
        del self._is_trainable

    @ucg_rate.deleter
    def ucg_rate(self):
        del self._ucg_rate

    @input_key.deleter
    def input_key(self):
        del self._input_key


class DualViTok2ImageEmbedder(AbstractEmbModel):
    def __init__(

            self,

            image_processor=None,

            vq_model=None,

            device="cuda",

            dtype=torch.float32,

            freeze=True,

            image_size=0,

            resize_factor=1,

            not_bicubic=True,

            return_sequence=False,

            grid_feature_scale=1,

            texture_drop_prob=0,

            semantic_drop_prob=0,

            pixel_channel=32,

            semantic_channel=32,

    ):
        super().__init__()
        vq_model.to(device=device, dtype=dtype)
        vq_model.eval()

        self.processor = image_processor

        self.model = vq_model
        self.device = device
        if freeze:
            self.freeze()

        if image_size > 0:
            preprocessor = [
                Resize(image_size) if not_bicubic else Resize(image_size, interpolation=InterpolationMode.BICUBIC)]
            preprocessor += [
                CenterCrop(image_size),
            ]
            self.preprocessor = Compose(preprocessor)
        self.image_size = image_size
        self.resize_factor = resize_factor
        self.not_bicubic = not_bicubic
        self.return_sequence = return_sequence
        self.grid_feature_scale = grid_feature_scale
        self.texture_drop_prob = texture_drop_prob
        self.semantic_drop_prob = semantic_drop_prob
        self.pixel_channel = pixel_channel
        self.semantic_channel = semantic_channel

    def freeze(self):
        self.model = self.model.eval()
        for param in self.parameters():
            param.requires_grad = False

    def vq_encode(self, image):
        if image.ndim == 5:
            assert image.size(1) == 1
            image = image.squeeze(1)
        bs, _, h, w = image.shape

        if self.image_size > 0:
            image = self.preprocessor(image)
        else:
            assert self.resize_factor > 0
            preprocessor = Resize((int(h * self.resize_factor), int(w * self.resize_factor))) if self.not_bicubic else \
                Resize((int(h * self.resize_factor), int(w * self.resize_factor)),
                       interpolation=InterpolationMode.BICUBIC)
            image = preprocessor(image)

        inputs = dict(image=image)
        inputs = self.model.get_input(inputs)

        (quant_semantic, diff_semantic, indices_semantic, target_semantic), \
        (quant_pixel, diff_pixel, indices_pixel) = self.model.encode(**inputs)
        return indices_semantic, indices_pixel

    def vq_encode_code(self, image):
        (quant_semantic, diff_semantic, indices_semantic, target_semantic), \
        (quant_pixel, diff_pixel, indices_pixel) = self.vq_encode(image)
        return indices_semantic, indices_pixel

    def vq_decode_code(self, indices_semantic, indices_pixel):
        return self.model.decode_code(indices_semantic, indices_pixel)

    def forward(self, image, return_indices=False):
        if image.ndim == 5:
            assert image.size(1) == 1
            image = image.squeeze(1)
        bs, _, h, w = image.shape

        if self.image_size > 0:
            image = self.preprocessor(image)
        else:
            assert self.resize_factor > 0
            preprocessor = Resize((int(h * self.resize_factor), int(w * self.resize_factor))) if self.not_bicubic else \
                Resize((int(h * self.resize_factor), int(w * self.resize_factor)),
                       interpolation=InterpolationMode.BICUBIC)
            image = preprocessor(image)

        inputs = dict(image=image)
        inputs = self.model.get_input(inputs)

        (quant_semantic, diff_semantic, indices_semantic, target_semantic), \
        (quant_pixel, diff_pixel, indices_pixel) = self.model.encode(**inputs)

        feature = self.model.merge_quants(quant_semantic, quant_pixel)

        if self.return_sequence:
            feature = rearrange(feature, 'b c h w -> b h w c')
            _, this_h, this_w, _ = feature.shape
            feature = feature.view(bs, this_w * this_w, -1)
        else:
            feature = feature * self.grid_feature_scale

        if return_indices:
            return feature, indices_semantic, indices_pixel

        return feature

    def encode(self, img):
        return self(img)

    def indices_to_codes(self, semantic_indices, texture_indices):
        quant_semantic, quant_texture = self.model.indices_to_codes(semantic_indices, texture_indices)
        return self.model.merge_quants(quant_semantic, quant_texture)


class StableDiffusionXLDecoderPipeline(
    DiffusionPipeline,
    StableDiffusionMixin,
    FromSingleFileMixin,
    StableDiffusionXLLoraLoaderMixin,
    TextualInversionLoaderMixin,
):
    model_cpu_offload_seq = "vq_model_embedder->unet->vae"
    _optional_components = [
        "vq_model_embedder",
    ]
    _callback_tensor_inputs = [
        "latents",
        "prompt_embeds",
        "negative_prompt_embeds",
        "add_text_embeds",
        "add_time_ids",
        "negative_pooled_prompt_embeds",
        "negative_add_time_ids",
    ]

    def __init__(

            self,

            vae: AutoencoderKL,

            unet: UNet2DConditionModel,

            scheduler: KarrasDiffusionSchedulers,

            force_zeros_for_empty_prompt: bool = True,

            add_watermarker: Optional[bool] = None,

            vq_image_processor=None,

            vq_model=None,

    ):
        super().__init__()

        self.register_modules(
            vae=vae,
            unet=unet,
            scheduler=scheduler,
        )
        self.register_to_config(force_zeros_for_empty_prompt=force_zeros_for_empty_prompt)
        self.vae_scale_factor = 2 ** (len(self.vae.config.block_out_channels) - 1)
        self.image_processor = VaeImageProcessor(vae_scale_factor=self.vae_scale_factor)

        self.default_sample_size = self.unet.config.sample_size

        add_watermarker = add_watermarker if add_watermarker is not None else is_invisible_watermark_available()

        if add_watermarker:
            self.watermark = StableDiffusionXLWatermarker()
        else:
            self.watermark = None

        self.empty_prompt_embeds = torch.zeros([1, 77, 2048]).to(device=unet.device, dtype=unet.dtype)
        self.empty_pooled_prompt_embeds = torch.zeros([1, 1280]).to(device=unet.device, dtype=unet.dtype)
        self.dualvitok_channels = vq_model.pixel_channel + vq_model.semantic_channel

        self.resolution_group = ['(1024, 1024)', '(768, 1024)', '(1024, 768)', '(512, 2048)', '(2048, 512)',
                                 '(640, 1920)', '(1920, 640)', '(768, 1536)', '(1536, 768)', '(768, 1152)',
                                 '(1152, 768)', '(512, 512)']

        embedder_kwargs = dict(image_size=0,
                               resize_factor=1,
                               return_sequence=False,
                               grid_feature_scale=1)
        if isinstance(vq_model, DualViTok2ImageEmbedder):
            self.vq_model_embedder = vq_model
        else:
            self.vq_model_embedder = DualViTok2ImageEmbedder(vq_image_processor, vq_model, **embedder_kwargs)

    def vq_encode(self, image):
        return self.vq_model_embedder.encode(image)

    def vq_encode_code(self, image):
        return self.vq_model_embedder.vq_encode_code(image)

    def vq_decode_code(self, *args, **kwargs):
        return self.vq_model_embedder.vq_decode_code(*args, **kwargs)

    def indices_to_codes(self, *args, **kwargs):
        return self.vq_model_embedder.indices_to_codes(*args, **kwargs)

    def _get_add_time_ids(

            self, original_size, crops_coords_top_left, target_size, dtype, text_encoder_projection_dim=None,

            resolution_index=None,

    ):
        add_time_ids = [resolution_index] * 6

        passed_add_embed_dim = (
                self.unet.config.addition_time_embed_dim * len(add_time_ids) + text_encoder_projection_dim
        )
        expected_add_embed_dim = self.unet.add_embedding.linear_1.in_features

        if expected_add_embed_dim != passed_add_embed_dim:
            raise ValueError(
                f"Model expects an added time embedding vector of length {expected_add_embed_dim}, but a vector of {passed_add_embed_dim} was created. The model has an incorrect config. Please check `unet.config.time_embedding_type` and `text_encoder_2.config.projection_dim`."
            )

        add_time_ids = torch.tensor([add_time_ids], dtype=dtype)
        return add_time_ids

    def check_inputs(

            self,

            height,

            width,

            callback_steps,

            callback_on_step_end_tensor_inputs=None,

    ):
        if height % 8 != 0 or width % 8 != 0:
            raise ValueError(f"`height` and `width` have to be divisible by 8 but are {height} and {width}.")

        if callback_steps is not None and (not isinstance(callback_steps, int) or callback_steps <= 0):
            raise ValueError(
                f"`callback_steps` has to be a positive integer but is {callback_steps} of type"
                f" {type(callback_steps)}."
            )

        if callback_on_step_end_tensor_inputs is not None and not all(
                k in self._callback_tensor_inputs for k in callback_on_step_end_tensor_inputs
        ):
            raise ValueError(
                f"`callback_on_step_end_tensor_inputs` has to be in {self._callback_tensor_inputs}, but found {[k for k in callback_on_step_end_tensor_inputs if k not in self._callback_tensor_inputs]}"
            )

    # Copied from diffusers.pipelines.stable_diffusion.pipeline_stable_diffusion.StableDiffusionPipeline.prepare_latents
    def prepare_latents(self, batch_size, num_channels_latents, height, width, dtype, device, generator, latents=None):
        shape = (
            batch_size,
            num_channels_latents,
            int(height) // self.vae_scale_factor,
            int(width) // self.vae_scale_factor,
        )
        if isinstance(generator, list) and len(generator) != batch_size:
            raise ValueError(
                f"You have passed a list of generators of length {len(generator)}, but requested an effective batch"
                f" size of {batch_size}. Make sure the batch size matches the length of the generators."
            )

        if latents is None:
            latents = randn_tensor(shape, generator=generator, device=device, dtype=dtype)
        else:
            latents = latents.to(device)

        # scale the initial noise by the standard deviation required by the scheduler
        latents = latents * self.scheduler.init_noise_sigma
        return latents

    def upcast_vae(self):
        dtype = self.vae.dtype
        self.vae.to(dtype=torch.float32)
        use_torch_2_0_or_xformers = isinstance(
            self.vae.decoder.mid_block.attentions[0].processor,
            (
                AttnProcessor2_0,
                XFormersAttnProcessor,
                FusedAttnProcessor2_0,
            ),
        )
        # if xformers or torch_2_0 is used attention block does not need
        # to be in float32 which can save lots of memory
        if use_torch_2_0_or_xformers:
            self.vae.post_quant_conv.to(dtype)
            self.vae.decoder.conv_in.to(dtype)
            self.vae.decoder.mid_block.to(dtype)

    # Copied from diffusers.pipelines.latent_consistency_models.pipeline_latent_consistency_text2img.LatentConsistencyModelPipeline.get_guidance_scale_embedding
    def get_guidance_scale_embedding(

            self, w: torch.Tensor, embedding_dim: int = 512, dtype: torch.dtype = torch.float32

    ) -> torch.Tensor:
        """

        See https://github.com/google-research/vdm/blob/dc27b98a554f65cdc654b800da5aa1846545d41b/model_vdm.py#L298



        Args:

            w (`torch.Tensor`):

                Generate embedding vectors with a specified guidance scale to subsequently enrich timestep embeddings.

            embedding_dim (`int`, *optional*, defaults to 512):

                Dimension of the embeddings to generate.

            dtype (`torch.dtype`, *optional*, defaults to `torch.float32`):

                Data type of the generated embeddings.



        Returns:

            `torch.Tensor`: Embedding vectors with shape `(len(w), embedding_dim)`.

        """
        assert len(w.shape) == 1
        w = w * 1000.0

        half_dim = embedding_dim // 2
        emb = torch.log(torch.tensor(10000.0)) / (half_dim - 1)
        emb = torch.exp(torch.arange(half_dim, dtype=dtype) * -emb)
        emb = w.to(dtype)[:, None] * emb[None, :]
        emb = torch.cat([torch.sin(emb), torch.cos(emb)], dim=1)
        if embedding_dim % 2 == 1:  # zero pad
            emb = torch.nn.functional.pad(emb, (0, 1))
        assert emb.shape == (w.shape[0], embedding_dim)
        return emb

    @property
    def guidance_scale(self):
        return self._guidance_scale

    @property
    def guidance_rescale(self):
        return self._guidance_rescale

    @property
    def clip_skip(self):
        return self._clip_skip

    # here `guidance_scale` is defined analog to the guidance weight `w` of equation (2)
    # of the Imagen paper: https://arxiv.org/pdf/2205.11487.pdf . `guidance_scale = 1`
    # corresponds to doing no classifier free guidance.
    @property
    def do_classifier_free_guidance(self):
        return self._guidance_scale > 1 and self.unet.config.time_cond_proj_dim is None

    @property
    def cross_attention_kwargs(self):
        return self._cross_attention_kwargs

    @property
    def denoising_end(self):
        return self._denoising_end

    @property
    def num_timesteps(self):
        return self._num_timesteps

    @property
    def interrupt(self):
        return self._interrupt

    def prepare_extra_step_kwargs(self, generator, eta):
        # prepare extra kwargs for the scheduler step, since not all schedulers have the same signature
        # eta (η) is only used with the DDIMScheduler, it will be ignored for other schedulers.
        # eta corresponds to η in DDIM paper: https://arxiv.org/abs/2010.02502
        # and should be between [0, 1]

        accepts_eta = "eta" in set(inspect.signature(self.scheduler.step).parameters.keys())
        extra_step_kwargs = {}
        if accepts_eta:
            extra_step_kwargs["eta"] = eta

        # check if the scheduler accepts generator
        accepts_generator = "generator" in set(inspect.signature(self.scheduler.step).parameters.keys())
        if accepts_generator:
            extra_step_kwargs["generator"] = generator
        return extra_step_kwargs

    @torch.no_grad()
    def __call__(

            self,

            vq_indices: Optional[List] = None,

            vq_embeds: Optional[torch.Tensor] = None,

            images: Optional[PipelineImageInput] = None,

            height: Optional[int] = None,

            width: Optional[int] = None,

            num_inference_steps: int = 50,

            timesteps: List[int] = None,

            sigmas: List[float] = None,

            denoising_end: Optional[float] = None,

            guidance_scale: float = 2.0,

            eta: float = 0.0,

            generator: Optional[Union[torch.Generator, List[torch.Generator]]] = None,

            latents: Optional[torch.Tensor] = None,

            output_type: Optional[str] = "pil",

            return_dict: bool = True,

            cross_attention_kwargs: Optional[Dict[str, Any]] = None,

            guidance_rescale: float = 0.0,

            original_size: Optional[Tuple[int, int]] = None,

            crops_coords_top_left: Tuple[int, int] = (0, 0),

            target_size: Optional[Tuple[int, int]] = None,

            negative_original_size: Optional[Tuple[int, int]] = None,

            negative_crops_coords_top_left: Tuple[int, int] = (0, 0),

            negative_target_size: Optional[Tuple[int, int]] = None,

            clip_skip: Optional[int] = None,

            callback_on_step_end: Optional[

                Union[Callable[[int, int, Dict], None], PipelineCallback, MultiPipelineCallbacks]

            ] = None,

            callback_on_step_end_tensor_inputs: List[str] = ["latents"],

            **kwargs,

    ):
        r"""

        Function invoked when calling the pipeline for generation.



        Args:

            vq_indices (`Optional[PipelineImageInput]`, *optional*):

                The VQ indices for semantic and pixel tokens. Should be a tuple of (semantic_indices, pixel_indices).

            images (`Optional[PipelineImageInput]`, *optional*):

                Input images in range [-1, 1] as torch.Tensor with shape (batch_size, channels, height, width).

            height (`int`, *optional*, defaults to self.unet.config.sample_size * self.vae_scale_factor):

                The height in pixels of the generated image. This is set to 1024 by default for the best results.

                Anything below 512 pixels won't work well for

                [stabilityai/stable-diffusion-xl-base-1.0](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0)

                and checkpoints that are not specifically fine-tuned on low resolutions.

            width (`int`, *optional*, defaults to self.unet.config.sample_size * self.vae_scale_factor):

                The width in pixels of the generated image. This is set to 1024 by default for the best results.

                Anything below 512 pixels won't work well for

                [stabilityai/stable-diffusion-xl-base-1.0](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0)

                and checkpoints that are not specifically fine-tuned on low resolutions.

            num_inference_steps (`int`, *optional*, defaults to 50):

                The number of denoising steps. More denoising steps usually lead to a higher quality image at the

                expense of slower inference.

            timesteps (`List[int]`, *optional*):

                Custom timesteps to use for the denoising process with schedulers which support a `timesteps` argument

                in their `set_timesteps` method. If not defined, the default behavior when `num_inference_steps` is

                passed will be used. Must be in descending order.

            sigmas (`List[float]`, *optional*):

                Custom sigmas to use for the denoising process with schedulers which support a `sigmas` argument in

                their `set_timesteps` method. If not defined, the default behavior when `num_inference_steps` is passed

                will be used.

            denoising_end (`float`, *optional*):

                When specified, determines the fraction (between 0.0 and 1.0) of the total denoising process to be

                completed before it is intentionally prematurely terminated. As a result, the returned sample will

                still retain a substantial amount of noise as determined by the discrete timesteps selected by the

                scheduler. The denoising_end parameter should ideally be utilized when this pipeline forms a part of a

                "Mixture of Denoisers" multi-pipeline setup, as elaborated in [**Refining the Image

                Output**](https://huggingface.co/docs/diffusers/api/pipelines/stable_diffusion/stable_diffusion_xl#refining-the-image-output)

            guidance_scale (`float`, *optional*, defaults to 5.0):

                Guidance scale as defined in [Classifier-Free Diffusion Guidance](https://arxiv.org/abs/2207.12598).

                `guidance_scale` is defined as `w` of equation 2. of [Imagen

                Paper](https://arxiv.org/pdf/2205.11487.pdf). Guidance scale is enabled by setting `guidance_scale >

                1`. Higher guidance scale encourages to generate images that are closely linked to the text `prompt`,

                usually at the expense of lower image quality.

            eta (`float`, *optional*, defaults to 0.0):

                Corresponds to parameter eta (η) in the DDIM paper: https://arxiv.org/abs/2010.02502. Only applies to

                [`schedulers.DDIMScheduler`], will be ignored for others.

            generator (`torch.Generator` or `List[torch.Generator]`, *optional*):

                One or a list of [torch generator(s)](https://pytorch.org/docs/stable/generated/torch.Generator.html)

                to make generation deterministic.

            latents (`torch.Tensor`, *optional*):

                Pre-generated noisy latents, sampled from a Gaussian distribution, to be used as inputs for image

                generation. Can be used to tweak the same generation with different prompts. If not provided, a latents

                tensor will ge generated by sampling using the supplied random `generator`.

            output_type (`str`, *optional*, defaults to `"pil"`):

                The output format of the generate image. Choose between

                [PIL](https://pillow.readthedocs.io/en/stable/): `PIL.Image.Image` or `np.array`.

            return_dict (`bool`, *optional*, defaults to `True`):

                Whether or not to return a [`~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput`] instead

                of a plain tuple.

            cross_attention_kwargs (`dict`, *optional*):

                A kwargs dictionary that if specified is passed along to the `AttentionProcessor` as defined under

                `self.processor` in

                [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

            guidance_rescale (`float`, *optional*, defaults to 0.0):

                Guidance rescale factor proposed by [Common Diffusion Noise Schedules and Sample Steps are

                Flawed](https://arxiv.org/pdf/2305.08891.pdf) `guidance_scale` is defined as `φ` in equation 16. of

                [Common Diffusion Noise Schedules and Sample Steps are Flawed](https://arxiv.org/pdf/2305.08891.pdf).

                Guidance rescale factor should fix overexposure when using zero terminal SNR.

            original_size (`Tuple[int]`, *optional*, defaults to (1024, 1024)):

                If `original_size` is not the same as `target_size` the image will appear to be down- or upsampled.

                `original_size` defaults to `(height, width)` if not specified. Part of SDXL's micro-conditioning as

                explained in section 2.2 of

                [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).

            crops_coords_top_left (`Tuple[int]`, *optional*, defaults to (0, 0)):

                `crops_coords_top_left` can be used to generate an image that appears to be "cropped" from the position

                `crops_coords_top_left` downwards. Favorable, well-centered images are usually achieved by setting

                `crops_coords_top_left` to (0, 0). Part of SDXL's micro-conditioning as explained in section 2.2 of

                [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).

            target_size (`Tuple[int]`, *optional*, defaults to (1024, 1024)):

                For most cases, `target_size` should be set to the desired height and width of the generated image. If

                not specified it will default to `(height, width)`. Part of SDXL's micro-conditioning as explained in

                section 2.2 of [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).

            callback_on_step_end (`Callable`, `PipelineCallback`, `MultiPipelineCallbacks`, *optional*):

                A function or a subclass of `PipelineCallback` or `MultiPipelineCallbacks` that is called at the end of

                each denoising step during the inference. with the following arguments: `callback_on_step_end(self:

                DiffusionPipeline, step: int, timestep: int, callback_kwargs: Dict)`. `callback_kwargs` will include a

                list of all tensors as specified by `callback_on_step_end_tensor_inputs`.

            callback_on_step_end_tensor_inputs (`List`, *optional*):

                The list of tensor inputs for the `callback_on_step_end` function. The tensors specified in the list

                will be passed as `callback_kwargs` argument. You will only be able to include variables listed in the

                `._callback_tensor_inputs` attribute of your pipeline class.



        Examples:



        Returns:

            [`~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput`] or `tuple`:

            [`~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput`] if `return_dict` is True, otherwise a

            `tuple`. When returning a tuple, the first element is a list with the generated images.

        """

        callback = kwargs.pop("callback", None)
        callback_steps = kwargs.pop("callback_steps", None)

        if callback is not None:
            deprecate(
                "callback",
                "1.0.0",
                "Passing `callback` as an input argument to `__call__` is deprecated, consider use `callback_on_step_end`",
            )
        if callback_steps is not None:
            deprecate(
                "callback_steps",
                "1.0.0",
                "Passing `callback_steps` as an input argument to `__call__` is deprecated, consider use `callback_on_step_end`",
            )

        if isinstance(callback_on_step_end, (PipelineCallback, MultiPipelineCallbacks)):
            callback_on_step_end_tensor_inputs = callback_on_step_end.tensor_inputs

        # 0. Default height and width to unet
        height = height or self.default_sample_size * self.vae_scale_factor
        width = width or self.default_sample_size * self.vae_scale_factor

        original_size = original_size or (height, width)
        target_size = target_size or (height, width)

        # 1. Check inputs. Raise error if not correct
        self.check_inputs(
            height,
            width,
            callback_steps,
            callback_on_step_end_tensor_inputs,
        )

        self._guidance_scale = guidance_scale
        self._guidance_rescale = guidance_rescale
        self._clip_skip = clip_skip
        self._cross_attention_kwargs = cross_attention_kwargs
        self._denoising_end = denoising_end
        self._interrupt = False

        # 2. encode vq_embeds
        assert images is not None or vq_indices is not None or vq_embeds is not None
        batch_size = len(images) if images is not None else len(vq_indices[0])

        if images:
            vq_embeds, indices_semantic, indices_pixel = self.vq_model_embedder(images, return_indices=True)
        elif vq_indices:
            indices_semantic, indices_pixel = vq_indices[0], vq_indices[1]
            vq_embeds = self.vq_model_embedder.indices_to_codes(vq_indices[0], vq_indices[1])
        elif vq_embeds:
            if isinstance(vq_embeds, list):
                vq_embeds = self.vq_model_embedder.merge_quants(vq_embeds)
            indices_semantic, indices_pixel = None, None
        else:
            raise ValueError("No valid input provided")

        device = self._execution_device

        # 3. Encode input prompt
        lora_scale = (
            self.cross_attention_kwargs.get("scale", None) if self.cross_attention_kwargs is not None else None
        )

        prompt_embeds = repeat(self.empty_prompt_embeds, '1 l c -> b l c', b=batch_size)
        pooled_prompt_embeds = repeat(self.empty_pooled_prompt_embeds, '1 c -> b c', b=batch_size)

        negative_prompt_embeds = prompt_embeds
        negative_pooled_prompt_embeds = pooled_prompt_embeds

        # 4. Prepare timesteps
        timesteps, num_inference_steps = retrieve_timesteps(
            self.scheduler, num_inference_steps, device, timesteps, sigmas
        )

        # 5. Prepare latent variables
        # num_channels_latents = self.unet.config.in_channels
        num_channels_latents = 4
        latents = self.prepare_latents(
            batch_size,
            num_channels_latents,
            height,
            width,
            prompt_embeds.dtype,
            device,
            generator,
            latents,
        )

        # 6. Prepare extra step kwargs. TODO: Logic should ideally just be moved out of the pipeline
        extra_step_kwargs = self.prepare_extra_step_kwargs(generator, eta)

        # 7. Prepare added time ids & embeddings
        add_text_embeds = pooled_prompt_embeds
        text_encoder_projection_dim = 1280

        resolution = f'({width}, {height})'
        assert resolution in self.resolution_group, f"resolution are not in resolution group. Got {resolution}. Candidates:{self.resolution_group}"
        resolution_index = self.resolution_group.index(resolution)
        # resolution_index = None

        add_time_ids = self._get_add_time_ids(
            original_size,
            crops_coords_top_left,
            target_size,
            dtype=prompt_embeds.dtype,
            text_encoder_projection_dim=text_encoder_projection_dim,
            resolution_index=resolution_index,
        )
        if negative_original_size is not None and negative_target_size is not None:
            negative_add_time_ids = self._get_add_time_ids(
                negative_original_size,
                negative_crops_coords_top_left,
                negative_target_size,
                dtype=prompt_embeds.dtype,
                text_encoder_projection_dim=text_encoder_projection_dim,
            )
        else:
            negative_add_time_ids = add_time_ids

        if self.do_classifier_free_guidance:
            prompt_embeds = torch.cat([negative_prompt_embeds, prompt_embeds], dim=0)
            add_text_embeds = torch.cat([negative_pooled_prompt_embeds, add_text_embeds], dim=0)
            add_time_ids = torch.cat([negative_add_time_ids, add_time_ids], dim=0)

        prompt_embeds = prompt_embeds.to(device)
        add_text_embeds = add_text_embeds.to(device)
        add_time_ids = add_time_ids.to(device).repeat(batch_size, 1)

        # 8. Denoising loop
        num_warmup_steps = max(len(timesteps) - num_inference_steps * self.scheduler.order, 0)

        # 8.1 Apply denoising_end
        if (
                self.denoising_end is not None
                and isinstance(self.denoising_end, float)
                and self.denoising_end > 0
                and self.denoising_end < 1
        ):
            discrete_timestep_cutoff = int(
                round(
                    self.scheduler.config.num_train_timesteps
                    - (self.denoising_end * self.scheduler.config.num_train_timesteps)
                )
            )
            num_inference_steps = len(list(filter(lambda ts: ts >= discrete_timestep_cutoff, timesteps)))
            timesteps = timesteps[:num_inference_steps]

        # 9. Optionally get Guidance Scale Embedding
        timestep_cond = None
        if self.unet.config.time_cond_proj_dim is not None:
            guidance_scale_tensor = torch.tensor(self.guidance_scale - 1).repeat(batch_size)
            timestep_cond = self.get_guidance_scale_embedding(
                guidance_scale_tensor, embedding_dim=self.unet.config.time_cond_proj_dim
            ).to(device=device, dtype=latents.dtype)

        self._num_timesteps = len(timesteps)
        # with self.progress_bar(total=num_inference_steps) as progress_bar:
        for i, t in enumerate(timesteps):
            if self.interrupt:
                continue

            # expand the latents if we are doing classifier free guidance
            latent_model_input = torch.cat([latents] * 2) if self.do_classifier_free_guidance else latents
            latent_model_input = self.scheduler.scale_model_input(latent_model_input, t)

            vq_embeds = vq_embeds.to(latent_model_input) if vq_embeds.size(
                -1) == latent_model_input.size(
                -1) else \
                torch.nn.functional.interpolate(vq_embeds.to(latent_model_input),
                                                size=latent_model_input.shape[-2:])
            vq_embeds_input = torch.cat([torch.zeros_like(vq_embeds),
                                         vq_embeds]) if self.do_classifier_free_guidance else vq_embeds

            # predict the noise residual
            added_cond_kwargs = {"text_embeds": add_text_embeds, "time_ids": add_time_ids}

            latent_model_input = torch.cat([latent_model_input, vq_embeds_input], dim=1)
            noise_pred = self.unet(
                latent_model_input,
                t,
                encoder_hidden_states=prompt_embeds,
                timestep_cond=timestep_cond,
                cross_attention_kwargs=self.cross_attention_kwargs,
                added_cond_kwargs=added_cond_kwargs,
                return_dict=False,
            )[0]

            # perform guidance
            if self.do_classifier_free_guidance:
                noise_pred_uncond, noise_pred_cond = noise_pred.chunk(2)
                noise_pred = noise_pred_uncond + self.guidance_scale * (noise_pred_cond - noise_pred_uncond)

            if self.do_classifier_free_guidance and self.guidance_rescale > 0.0:
                # Based on 3.4. in https://arxiv.org/pdf/2305.08891.pdf
                noise_pred = rescale_noise_cfg(noise_pred, noise_pred_cond, guidance_rescale=self.guidance_rescale)

            # compute the previous noisy sample x_t -> x_t-1
            latents_dtype = latents.dtype
            latents = self.scheduler.step(noise_pred, t, latents, **extra_step_kwargs, return_dict=False)[0]
            if latents.dtype != latents_dtype:
                if torch.backends.mps.is_available():
                    # some platforms (eg. apple mps) misbehave due to a pytorch bug: https://github.com/pytorch/pytorch/pull/99272
                    latents = latents.to(latents_dtype)

            if callback_on_step_end is not None:
                callback_kwargs = {}
                for k in callback_on_step_end_tensor_inputs:
                    callback_kwargs[k] = locals()[k]
                callback_outputs = callback_on_step_end(self, i, t, callback_kwargs)

                latents = callback_outputs.pop("latents", latents)
                prompt_embeds = callback_outputs.pop("prompt_embeds", prompt_embeds)
                add_text_embeds = callback_outputs.pop("add_text_embeds", add_text_embeds)
                add_time_ids = callback_outputs.pop("add_time_ids", add_time_ids)

            # call the callback, if provided
            if i == len(timesteps) - 1 or ((i + 1) > num_warmup_steps and (i + 1) % self.scheduler.order == 0):
                # progress_bar.update()
                if callback is not None and i % callback_steps == 0:
                    step_idx = i // getattr(self.scheduler, "order", 1)
                    callback(step_idx, t, latents)

            if XLA_AVAILABLE:
                xm.mark_step()

        if not output_type == "latent":
            # make sure the VAE is in float32 mode, as it overflows in float16
            needs_upcasting = self.vae.dtype == torch.float16 and self.vae.config.force_upcast

            if needs_upcasting:
                self.upcast_vae()
                latents = latents.to(next(iter(self.vae.post_quant_conv.parameters())).dtype)
            elif latents.dtype != self.vae.dtype:
                if torch.backends.mps.is_available():
                    # some platforms (eg. apple mps) misbehave due to a pytorch bug: https://github.com/pytorch/pytorch/pull/99272
                    self.vae = self.vae.to(latents.dtype)

            # unscale/denormalize the latents
            # denormalize with the mean and std if available and not None
            has_latents_mean = hasattr(self.vae.config, "latents_mean") and self.vae.config.latents_mean is not None
            has_latents_std = hasattr(self.vae.config, "latents_std") and self.vae.config.latents_std is not None
            if has_latents_mean and has_latents_std:
                latents_mean = (
                    torch.tensor(self.vae.config.latents_mean).view(1, 4, 1, 1).to(latents.device, latents.dtype)
                )
                latents_std = (
                    torch.tensor(self.vae.config.latents_std).view(1, 4, 1, 1).to(latents.device, latents.dtype)
                )
                latents = latents * latents_std / self.vae.config.scaling_factor + latents_mean
            else:
                latents = latents / self.vae.config.scaling_factor

            image = self.vae.decode(latents, return_dict=False)[0]

            # cast back to fp16 if needed
            if needs_upcasting:
                self.vae.to(dtype=torch.float16)
        else:
            image = latents

        if not output_type == "latent":
            # apply watermark if available
            if self.watermark is not None:
                image = self.watermark.apply_watermark(image)

            image = self.image_processor.postprocess(image, output_type=output_type)

        # Offload all models
        self.maybe_free_model_hooks()

        if not return_dict:
            return (image,)

        return StableDiffusionXLDecoderPipelineOutput(images=image,
                                                      indices_semantic=indices_semantic,
                                                      indices_pixel=indices_pixel)