# KDPM2AncestralDiscreteScheduler ## KDPM2AncestralDiscreteScheduler The `KDPM2DiscreteScheduler` with ancestral sampling is inspired by the [Elucidating the Design Space of Diffusion-Based Generative Models](https://huggingface.co/papers/2206.00364) paper, and the scheduler is ported from and created by [Katherine Crowson](https://github.com/crowsonkb/). The original codebase can be found at [crowsonkb/k-diffusion](https://github.com/crowsonkb/k-diffusion). ### KDPM2AncestralDiscreteScheduler #### class diffusers.KDPM2AncestralDiscreteScheduler [\](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_k_dpm_2_ancestral_discrete.py#L72) ( num\_train\_timesteps: int = 1000beta\_start: float = 0.00085beta\_end: float = 0.012beta\_schedule: str = 'linear'trained\_betas: typing.Union\[numpy.ndarray, typing.List\[float], NoneType] = Noneprediction\_type: str = 'epsilon'timestep\_spacing: str = 'linspace'steps\_offset: int = 0 ) Parameters * **num\_train\_timesteps** (`int`, defaults to 1000) — The number of diffusion steps to train the model. * **beta\_start** (`float`, defaults to 0.00085) — The starting `beta` value of inference. * **beta\_end** (`float`, defaults to 0.012) — The final `beta` value. * **beta\_schedule** (`str`, defaults to `"linear"`) — The beta schedule, a mapping from a beta range to a sequence of betas for stepping the model. Choose from `linear` or `scaled_linear`. * **trained\_betas** (`np.ndarray`, *optional*) — Pass an array of betas directly to the constructor to bypass `beta_start` and `beta_end`. * **prediction\_type** (`str`, defaults to `epsilon`, *optional*) — Prediction type of the scheduler function; can be `epsilon` (predicts the noise of the diffusion process), `sample` (directly predicts the noisy sample`) or` v\_prediction\` (see section 2.4 of [Imagen Video](https://imagen.research.google/video/paper.pdf) paper). * **timestep\_spacing** (`str`, defaults to `"linspace"`) — The way the timesteps should be scaled. Refer to Table 2 of the [Common Diffusion Noise Schedules and Sample Steps are Flawed](https://huggingface.co/papers/2305.08891) for more information. * **steps\_offset** (`int`, defaults to 0) — An offset added to the inference steps. You can use a combination of `offset=1` and `set_alpha_to_one=False` to make the last step use step 0 for the previous alpha product like in Stable Diffusion. KDPM2DiscreteScheduler with ancestral sampling is inspired by the DPMSolver2 and Algorithm 2 from the [Elucidating the Design Space of Diffusion-Based Generative Models](https://huggingface.co/papers/2206.00364) paper. This model inherits from [SchedulerMixin](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/overview#diffusers.SchedulerMixin) and [ConfigMixin](https://huggingface.co/docs/diffusers/v0.21.0/en/api/configuration#diffusers.ConfigMixin). Check the superclass documentation for the generic methods the library implements for all schedulers such as loading and saving. **scale\_model\_input** [\](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_k_dpm_2_ancestral_discrete.py#L176) ( sample: FloatTensortimestep: typing.Union\[float, torch.FloatTensor] ) → `torch.FloatTensor` Parameters * **sample** (`torch.FloatTensor`) — The input sample. * **timestep** (`int`, *optional*) — The current timestep in the diffusion chain. Returns `torch.FloatTensor` A scaled input sample. Ensures interchangeability with schedulers that need to scale the denoising model input depending on the current timestep. **set\_timesteps** [\](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_k_dpm_2_ancestral_discrete.py#L206) ( num\_inference\_steps: intdevice: typing.Union\[str, torch.device] = Nonenum\_train\_timesteps: typing.Optional\[int] = None ) Parameters * **num\_inference\_steps** (`int`) — The number of diffusion steps used when generating samples with a pre-trained model. * **device** (`str` or `torch.device`, *optional*) — The device to which the timesteps should be moved to. If `None`, the timesteps are not moved. Sets the discrete timesteps used for the diffusion chain (to be run before inference). **step** [\](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_k_dpm_2_ancestral_discrete.py#L330) ( model\_output: typing.Union\[torch.FloatTensor, numpy.ndarray]timestep: typing.Union\[float, torch.FloatTensor]sample: typing.Union\[torch.FloatTensor, numpy.ndarray]generator: typing.Optional\[torch.\_C.Generator] = Nonereturn\_dict: bool = True ) → [SchedulerOutput](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/singlestep_dpm_solver#diffusers.schedulers.scheduling_utils.SchedulerOutput) or `tuple` Parameters * **model\_output** (`torch.FloatTensor`) — The direct output from learned diffusion model. * **timestep** (`float`) — The current discrete timestep in the diffusion chain. * **sample** (`torch.FloatTensor`) — A current instance of a sample created by the diffusion process. * **generator** (`torch.Generator`, *optional*) — A random number generator. * **return\_dict** (`bool`) — Whether or not to return a [SchedulerOutput](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/singlestep_dpm_solver#diffusers.schedulers.scheduling_utils.SchedulerOutput) or tuple. Returns [SchedulerOutput](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/singlestep_dpm_solver#diffusers.schedulers.scheduling_utils.SchedulerOutput) or `tuple` If return\_dict is `True`, `~schedulers.scheduling_ddim.SchedulerOutput` is returned, otherwise a tuple is returned where the first element is the sample tensor. Predict the sample from the previous timestep by reversing the SDE. This function propagates the diffusion process from the learned model outputs (most often the predicted noise). ### SchedulerOutput #### class diffusers.schedulers.scheduling\_utils.SchedulerOutput [\](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_utils.py#L50) ( prev\_sample: FloatTensor ) Parameters * **prev\_sample** (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)` for images) — Computed sample `(x_{t-1})` of previous timestep. `prev_sample` should be used as next model input in the denoising loop. Base class for the output of a scheduler’s `step` function. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://boinc-ai.gitbook.io/diffusers/api/schedulers/kdpm2ancestraldiscretescheduler.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.