# HeliosScheduler

`HeliosScheduler` est basé sur l'échantillonnage par correspondance de flux pyramidale introduit dans [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 = [], 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')
```

[Source](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)
```

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

**Paramètres :**

model_output (`torch.Tensor`) : La sortie directe du modèle de diffusion appris.

timestep (`int`) : L'étape discrète actuelle dans la chaîne de diffusion.

sample (`torch.Tensor`) : Une instance actuelle d'un échantillon créé par le processus de diffusion.

sigma (`torch.Tensor`, *facultatif*) : La valeur sigma de l'étape actuelle dans le calendrier de bruit.

**Retourne :** `torch.Tensor`

La sortie du modèle converti.

Convertir la sortie du modèle vers le type correspondant dont l'algorithme UniPC a besoin.

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

```python
init_sigmas()
```

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

initialiser les timesteps et les sigmas globaux

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

```python
init_sigmas_for_each_stage()
```

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

Initialiser les timesteps pour chaque étape

#### 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)
```

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

**Paramètres :**

this_model_output (`torch.Tensor`) : Les sorties du modèle à `x_t`.

this_timestep (`int`) : L'étape temporelle actuelle `t`.

last_sample (`torch.Tensor`) : l'échantillon généré avant le dernier prédicteur `x_{t-1}`.

this_sample (`torch.Tensor`) : l'échantillon généré après le dernier prédicteur `x_{t}`.

order (`int`) : La valeur de `p` de UniC-p à cette étape. L'ordre d'efficacité effectif doit être `order + 1`.

sigma_before (`torch.Tensor`, *facultatif*) : La valeur sigma de l'étape précédente dans le calendrier de bruit.

sigma (`torch.Tensor`, *facultatif*) : La valeur sigma de l'étape actuelle dans le calendrier de bruit.

**Retourne :** `torch.Tensor`

Le tenseur d'échantillon corrigé à l'étape temporelle actuelle.

Une étape pour la version 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)
```

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

**Paramètres :**

model_output (`torch.Tensor`) : La sortie directe du modèle de diffusion appris à l'étape temporelle actuelle.

prev_timestep (`int`) : L'étape discrète précédente dans la chaîne de diffusion.

sample (`torch.Tensor`) : Une instance actuelle d'un échantillon créé par le processus de diffusion.

order (`int`) : L'ordre de UniP à cette étape de temps (correspond au *p* de UniPC-p).

sigma (`torch.Tensor`, *facultatif*) : La valeur sigma de l'étape actuelle dans le calendrier de bruit.

sigma_next (`torch.Tensor`, *facultatif*) : La valeur sigma de l'étape suivante dans le calendrier de bruit.

**Retourne :** `torch.Tensor`

Le tenseur d'échantillon à l'étape temporelle précédente.

Une étape pour UniP (version B(h)). Sinon, `self.solver_p` est utilisé si spécifié.

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

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

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

**Paramètres :**

begin_index (`int`) : L'index de début pour le planificateur.

Définit l'index de début pour le planificateur. Cette fonction doit être exécutée depuis le pipeline avant l'inférence.

#### 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)
```

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

Définir les timesteps et les sigmas pour chaque étape

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

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

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

**Paramètres :**

mu (`float`) : Le paramètre mu pour le décalage temporel.

sigma (`float`) : Le paramètre sigma pour le décalage temporel.

t (`torch.Tensor`) : Les pas de temps d'entrée.

**Retourne :** `torch.Tensor`

Les pas de temps décalés dans le temps.

Appliquer un décalage temporel aux sigmas.

scheduling_helios