# EulerAncestralDiscreteScheduler

## EulerAncestralDiscreteScheduler

A scheduler that uses ancestral sampling with Euler method steps. This is a fast scheduler which can often generate good outputs in 20-30 steps. The scheduler is based on the original [k-diffusion](https://github.com/crowsonkb/k-diffusion/blob/481677d114f6ea445aa009cf5bd7a9cdee909e47/k_diffusion/sampling.py#L72) implementation by [Katherine Crowson](https://github.com/crowsonkb/).

### EulerAncestralDiscreteScheduler

#### class diffusers.EulerAncestralDiscreteScheduler

[\<source>](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_euler_ancestral_discrete.py#L95)

( num\_train\_timesteps: int = 1000beta\_start: float = 0.0001beta\_end: float = 0.02beta\_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.0001) — The starting `beta` value of inference.
* **beta\_end** (`float`, defaults to 0.02) — 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.

Ancestral sampling with Euler method steps.

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**

[\<source>](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_euler_ancestral_discrete.py#L187)

( 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. Scales the denoising model input by `(sigma**2 + 1) ** 0.5` to match the Euler algorithm.

**set\_timesteps**

[\<source>](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_euler_ancestral_discrete.py#L213)

( num\_inference\_steps: intdevice: typing.Union\[str, torch.device] = 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**

[\<source>](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_euler_ancestral_discrete.py#L273)

( model\_output: FloatTensortimestep: typing.Union\[float, torch.FloatTensor]sample: FloatTensorgenerator: typing.Optional\[torch.\_C.Generator] = Nonereturn\_dict: bool = True ) → [EulerAncestralDiscreteSchedulerOutput](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/euler_ancestral#diffusers.schedulers.scheduling_euler_ancestral_discrete.EulerAncestralDiscreteSchedulerOutput) 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 [EulerAncestralDiscreteSchedulerOutput](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/euler_ancestral#diffusers.schedulers.scheduling_euler_ancestral_discrete.EulerAncestralDiscreteSchedulerOutput) or tuple.

Returns

[EulerAncestralDiscreteSchedulerOutput](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/euler_ancestral#diffusers.schedulers.scheduling_euler_ancestral_discrete.EulerAncestralDiscreteSchedulerOutput) or `tuple`

If return\_dict is `True`, [EulerAncestralDiscreteSchedulerOutput](https://huggingface.co/docs/diffusers/v0.21.0/en/api/schedulers/euler_ancestral#diffusers.schedulers.scheduling_euler_ancestral_discrete.EulerAncestralDiscreteSchedulerOutput) 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).

### EulerAncestralDiscreteSchedulerOutput

#### class diffusers.schedulers.scheduling\_euler\_ancestral\_discrete.EulerAncestralDiscreteSchedulerOutput

[\<source>](https://github.com/huggingface/diffusers/blob/v0.21.0/src/diffusers/schedulers/scheduling_euler_ancestral_discrete.py#L33)

( prev\_sample: FloatTensorpred\_original\_sample: typing.Optional\[torch.FloatTensor] = None )

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.
* **pred\_original\_sample** (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)` for images) — The predicted denoised sample `(x_{0})` based on the model output from the current timestep. `pred_original_sample` can be used to preview progress or for guidance.

Output class for the scheduler’s `step` function output.
