# Гиды

[Classifier-free guidance](https://huggingface.co/papers/2207.12598) направляет генерацию модели так, чтобы она лучше соответствовала промпту, и часто используется для повышения качества генерации, управляемости и следования промпту. Существует несколько типов методов guidance, и в Diffusers они называются *guiders*. Как и в случае с блоками, легко переключаться между различными guiders и использовать их для разных задач, не переписывая пайплайн.

В этом руководстве показано, как переключать guider'ы, настраивать параметры guider'ов, а также загружать их в Hub и делиться ими.

## Переключение направляющих

[ClassifierFreeGuidance](/docs/diffusers/main/ru/api/modular_diffusers/guiders#diffusers.ClassifierFreeGuidance) — это guider по умолчанию, создаваемый при инициализации пайплайна с помощью [init_pipeline()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks.init_pipeline). Он создаётся методом `from_config`, что означает, что для него не требуется загрузка спецификаций из модульного репозитория. Guider не будет указан в `modular_model_index.json`.

Используйте [get_component_spec()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline#diffusers.ModularPipeline.get_component_spec) для проверки guider.

```py
t2i_pipeline.get_component_spec("guider")
ComponentSpec(name='guider', type_hint=<class 'diffusers.guiders.classifier_free_guidance.ClassifierFreeGuidance'>, description=None, config=FrozenDict([('guidance_scale', 7.5), ('guidance_rescale', 0.0), ('use_original_formulation', False), ('start', 0.0), ('stop', 1.0), ('_use_default_values', ['start', 'guidance_rescale', 'stop', 'use_original_formulation'])]), repo=None, subfolder=None, variant=None, revision=None, default_creation_method='from_config')
```

Переключитесь на другой guider, передав новый guider в [update_components()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline#diffusers.ModularPipeline.update_components).

> [!TIP]
> Смена guider'а вернёт текст, уведомляющий вас об изменении типа guider'а.
> ```bash
> ModularPipeline.update_components: adding guider with new type: PerturbedAttentionGuidance, previous type: ClassifierFreeGuidance
> ```

```py
from diffusers import LayerSkipConfig, PerturbedAttentionGuidance

config = LayerSkipConfig(indices=[2, 9], fqn="mid_block.attentions.0.transformer_blocks", skip_attention=False, skip_attention_scores=True, skip_ff=False)
guider = PerturbedAttentionGuidance(
    guidance_scale=5.0, perturbed_guidance_scale=2.5, perturbed_guidance_config=config
)
t2i_pipeline.update_components(guider=guider)
```

Снова используйте [get_component_spec()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline#diffusers.ModularPipeline.get_component_spec), чтобы убедиться, что тип guider отличается.

```py
t2i_pipeline.get_component_spec("guider")
ComponentSpec(name='guider', type_hint=<class 'diffusers.guiders.perturbed_attention_guidance.PerturbedAttentionGuidance'>, description=None, config=FrozenDict([('guidance_scale', 5.0), ('perturbed_guidance_scale', 2.5), ('perturbed_guidance_start', 0.01), ('perturbed_guidance_stop', 0.2), ('perturbed_guidance_layers', None), ('perturbed_guidance_config', LayerSkipConfig(indices=[2, 9], fqn='mid_block.attentions.0.transformer_blocks', skip_attention=False, skip_attention_scores=True, skip_ff=False, dropout=1.0)), ('guidance_rescale', 0.0), ('use_original_formulation', False), ('start', 0.0), ('stop', 1.0), ('_use_default_values', ['perturbed_guidance_start', 'use_original_formulation', 'perturbed_guidance_layers', 'stop', 'start', 'guidance_rescale', 'perturbed_guidance_stop']), ('_class_name', 'PerturbedAttentionGuidance'), ('_diffusers_version', '0.35.0.dev0')]), repo=None, subfolder=None, variant=None, revision=None, default_creation_method='from_config')
```

## Загрузка пользовательских направляющих

Гайдеры, уже сохранённые на Hub с файлом `modular_model_index.json`, теперь считаются компонентом `from_pretrained`, а не компонентом `from_config`.

```json
{
  "guider": [
    null,
    null,
    {
      "repo": "YiYiXu/modular-loader-t2i-guider",
      "revision": null,
      "subfolder": "pag_guider",
      "type_hint": [
        "diffusers",
        "PerturbedAttentionGuidance"
      ],
      "variant": null
    }
  ]
}
```

Guider создаётся только после вызова [load_components()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline#diffusers.ModularPipeline.load_components) на основе спецификации загрузки в `modular_model_index.json`.

```py
t2i_pipeline = t2i_blocks.init_pipeline("YiYiXu/modular-doc-guider")
# not created during init
assert t2i_pipeline.guider is None
t2i_pipeline.load_components()
# loaded as PAG guider
t2i_pipeline.guider
```

## Изменение параметров guider

Параметры guider можно настроить с помощью методов [create()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline_components#diffusers.ComponentSpec.create) и [update_components()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline#diffusers.ModularPipeline.update_components). В примере ниже изменяется значение `guidance_scale`.

```py
guider_spec = t2i_pipeline.get_component_spec("guider")
guider = guider_spec.create(guidance_scale=10)
t2i_pipeline.update_components(guider=guider)
```

## Загрузка пользовательских направляющих

Вызовите метод [push_to_hub()](/docs/diffusers/main/ru/api/schedulers/overview#diffusers.utils.PushToHubMixin.push_to_hub) для пользовательского guider, чтобы поделиться им в Hub.

```py
guider.push_to_hub("YiYiXu/modular-loader-t2i-guider", subfolder="pag_guider")
```

Чтобы сделать этот guider доступным для pipeline, измените файл `modular_model_index.json` или используйте метод [update_components()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline#diffusers.ModularPipeline.update_components).

Отредактируйте файл `modular_model_index.json` и добавьте спецификацию загрузки для guider, указав на папку, содержащую конфигурацию guider.

```json
{
  "guider": [
    "diffusers",
    "PerturbedAttentionGuidance",
    {
      "repo": "YiYiXu/modular-loader-t2i-guider",
      "revision": null,
      "subfolder": "pag_guider",
      "type_hint": [
        "diffusers",
        "PerturbedAttentionGuidance"
      ],
      "variant": null
    }
  ],
```

Измените `default_creation_method()` на `from_pretrained` и используйте [update_components()](/docs/diffusers/main/ru/api/modular_diffusers/pipeline#diffusers.ModularPipeline.update_components), чтобы обновить спецификации guider и компонентов, а также конфигурацию конвейера.

> [!TIP]
> Изменение метода создания вернёт текст, уведомляющий о том, что тип создания меняется на `from_pretrained`.
> ```bash
> ModularPipeline.update_components: changing the default_creation_method of guider from from_config to from_pretrained.
> ```

```py
guider_spec = t2i_pipeline.get_component_spec("guider")
guider_spec.default_creation_method="from_pretrained"
guider_spec.pretrained_model_name_or_path="YiYiXu/modular-loader-t2i-guider"
guider_spec.subfolder="pag_guider"
pag_guider = guider_spec.load()
t2i_pipeline.update_components(guider=pag_guider)
```

Чтобы сделать его guider по умолчанию для pipeline, вызовите [push_to_hub()](/docs/diffusers/main/ru/api/schedulers/overview#diffusers.utils.PushToHubMixin.push_to_hub). Это необязательный шаг, и он не требуется, если вы экспериментируете только локально.

```py
t2i_pipeline.push_to_hub("YiYiXu/modular-doc-guider")
```