# HeliosScheduler

`HeliosScheduler` основан на пирамидальном flow-matching-сэмплировании, представленном в [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')
```

[Источник](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)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L371)

**Параметры:**

model_output (`torch.Tensor`) : Прямой вывод из обученной диффузионной модели.

timestep (`int`) : Текущий дискретный шаг времени в цепочке диффузии.

sample (`torch.Tensor`) : Текущая инстанция сэмпла, созданная процессом диффузии.

sigma (`torch.Tensor`, *необязательный*) : Сигма текущего шага в расписании шума.

**Возвращает:** `torch.Tensor`

Вывод сконвертированной модели.

Преобразуйте выход модели в соответствующий тип, необходимый для алгоритма UniPC.

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

```python
init_sigmas()
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L90)

инициализировать глобальные шаги и сигмы

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

```python
init_sigmas_for_each_stage()
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L108)

Инициализация шагов времени для каждого этапа

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L591)

**Параметры:**

this_model_output (`torch.Tensor`) : Выходы модели в точке `x_t`.

this_timestep (`int`) : Текущий шаг `t`.

last_sample (`torch.Tensor`) : сгенерированная выборка до последнего предсказателя `x_{t-1}`.

this_sample (`torch.Tensor`) : сгенерированная выборка после последнего предиктора `x_{t}`.

order (`int`) : значение `p` для UniC-p на данном шаге. Эффективный порядок точности должен быть равен `order + 1`.

sigma_before (`torch.Tensor`, *необязательный*) : Сигма предыдущего шага в расписании шума.

sigma (`torch.Tensor`, *необязательный*) : Сигма текущего шага в расписании шума.

**Возвращает:** `torch.Tensor`

Скорректированный тензор образца на текущем шаге времени.

Один шаг для 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)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L453)

**Параметры:**

model_output (`torch.Tensor`) : Прямой вывод из обученной диффузионной модели на текущем шаге времени.

prev_timestep (`int`) : Предыдущий дискретный шаг времени в цепочке диффузии.

sample (`torch.Tensor`) : Текущая инстанция сэмпла, созданная процессом диффузии.

order (`int`) : Порядок UniP на этом шаге времени (соответствует *p* в UniPC-p).

sigma (`torch.Tensor`, *необязательный*) : Сигма текущего шага в расписании шума.

sigma_next (`torch.Tensor`, *необязательный*) : Сигма следующего шага в расписании шума.

**Возвращает:** `torch.Tensor`

Тензор выборки на предыдущем шаге.

Один шаг для UniP (версия B(h)). В качестве альтернативы, если указано, используется `self.solver_p`.

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

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L182)

**Параметры:**

begin_index (`int`) : Начальный индекс для планировщика.

Устанавливает начальный индекс для планировщика. Эта функция должна выполняться из конвейера перед инференсом.

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L195)

Настройка шагов и сигм для каждого этапа

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

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_helios.py#L259)

**Параметры:**

mu (`float`) : Параметр mu для сдвига времени.

sigma (`float`) : Параметр sigma для сдвига времени.

t (`torch.Tensor`) : Входные временные шаги.

**Возвращает:** `torch.Tensor`

Сдвинутые по времени шаги.

Примените сдвиг по времени к сигмам.

scheduling_helios