# HeliosScheduler

`HeliosScheduler` se basa en el muestreo de flujo piramidal introducido en [Helios](https://huggingface.co/papers).

## HeliosScheduler[[diffusers.HeliosScheduler]]

#### diffusers.HeliosScheduler[[diffusers.HeliosScheduler]]

```python
diffusers.HeliosScheduler(num_train_timesteps: int = 1000, shift: float = 1.0, stages: int = 3, stage_range: list = [0, 0.3333333333333333, 0.6666666666666666, 1], gamma: float = 0.3333333333333333, thresholding: bool = False, prediction_type: str = 'flow_prediction', solver_order: int = 2, predict_x0: bool = True, solver_type: str = 'bh2', lower_order_final: bool = True, disable_corrector: list[int] = [], solver_p: SchedulerMixin = None, use_flow_sigmas: bool = True, scheduler_type: str = 'unipc', use_dynamic_shifting: bool = False, time_shift_type: typing.Literal['exponential', 'linear'] = 'exponential')
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L35)

#### convert_model_output[[diffusers.HeliosScheduler.convert_model_output]]

```python
convert_model_output(model_output: Tensor, *args, sample: Tensor = None, sigma: Tensor = None, **kwargs)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L371)

**Parámetros:**

model_output (`torch.Tensor`) : La salida directa del modelo de difusión aprendido.

timestep (`int`) : El paso de tiempo discreto actual en la cadena de difusión.

sample (`torch.Tensor`) : Una instancia actual de una muestra creada por el proceso de difusión.

sigma (`torch.Tensor`, *opcional*) : La sigma del paso actual en el plan de ruido.

**Devuelve:** `torch.Tensor`

La salida del modelo convertido.

Convierta la salida del modelo al tipo correspondiente que necesita el algoritmo UniPC.

#### init_sigmas[[diffusers.HeliosScheduler.init_sigmas]]

```python
init_sigmas()
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L90)

inicializar los pasos de tiempo y sigmas globales

#### init_sigmas_for_each_stage[[diffusers.HeliosScheduler.init_sigmas_for_each_stage]]

```python
init_sigmas_for_each_stage()
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L108)

Inicializa los pasos de tiempo para cada etapa

#### multistep_uni_c_bh_update[[diffusers.HeliosScheduler.multistep_uni_c_bh_update]]

```python
multistep_uni_c_bh_update(this_model_output: Tensor, *args, last_sample: Tensor = None, this_sample: Tensor = None, order: int = None, sigma_before: Tensor = None, sigma: Tensor = None, **kwargs)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L591)

**Parámetros:**

this_model_output (`torch.Tensor`) : Las salidas del modelo en `x_t`.

this_timestep (`int`) : El paso temporal actual `t`.

last_sample (`torch.Tensor`) : La muestra generada antes del último predictor `x_{t-1}`.

this_sample (`torch.Tensor`) : La muestra generada después del último predictor `x_{t}`.

order (`int`) : El `p` de UniC-p en este paso. El orden efectivo de precisión debe ser `order + 1`.

sigma_before (`torch.Tensor`, *opcional*) : La sigma del paso anterior en el plan de ruido.

sigma (`torch.Tensor`, *opcional*) : La sigma del paso actual en el plan de ruido.

**Devuelve:** `torch.Tensor`

El tensor de muestra corregido en el paso de tiempo actual.

Un paso para la versión UniC (B(h)).

#### multistep_uni_p_bh_update[[diffusers.HeliosScheduler.multistep_uni_p_bh_update]]

```python
multistep_uni_p_bh_update(model_output: Tensor, *args, sample: Tensor = None, order: int = None, sigma: Tensor = None, sigma_next: Tensor = None, **kwargs)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L453)

**Parámetros:**

model_output (`torch.Tensor`) : La salida directa del modelo de difusión aprendido en el paso de tiempo actual.

prev_timestep (`int`) : El paso de tiempo discreto anterior en la cadena de difusión.

sample (`torch.Tensor`) : Una instancia actual de una muestra creada por el proceso de difusión.

order (`int`) : El orden de UniP en este paso de tiempo (corresponde a la *p* en UniPC-p).

sigma (`torch.Tensor`, *opcional*) : La sigma del paso actual en el plan de ruido.

sigma_next (`torch.Tensor`, *opcional*) : La sigma del siguiente paso en el plan de ruido.

**Devuelve:** `torch.Tensor`

El tensor de muestra en el paso de tiempo anterior.

Un paso para UniP (versión B(h)). Alternativamente, se utiliza `self.solver_p` si se especifica.

#### set_begin_index[[diffusers.HeliosScheduler.set_begin_index]]

```python
set_begin_index(begin_index: int = 0)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L182)

**Parámetros:**

begin_index (`int`) : El índice inicial del programador.

Establece el índice inicial para el programador. Esta función debe ejecutarse desde la tubería antes de la inferencia.

#### set_timesteps[[diffusers.HeliosScheduler.set_timesteps]]

```python
set_timesteps(num_inference_steps: int, stage_index: int | None = None, device: typing.Union[str, torch.device] = None, sigmas: bool | None = None, mu: bool | None = None, is_amplify_first_chunk: bool = False)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L195)

Establecer los pasos de tiempo y las sigmas para cada etapa

#### time_shift[[diffusers.HeliosScheduler.time_shift]]

```python
time_shift(mu: float, sigma: float, t: Tensor)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L259)

**Parámetros:**

mu (`float`) : El parámetro mu para el desplazamiento en el tiempo.

sigma (`float`) : El parámetro sigma para el desplazamiento temporal.

t (`torch.Tensor`) : Los pasos de tiempo de entrada.

**Devuelve:** `torch.Tensor`

Los pasos de tiempo desplazados.

Aplicar el desplazamiento temporal a los sigmas.

scheduling_helios