Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /ru /api /pipelines /bria_fibo.md

mishig

1 day ago

preview code

download

raw

13.6 kB

# Bria Fibo

Модели text-to-image освоили воображение, но не контроль. FIBO меняет это.

FIBO обучается на структурированных JSON-описаниях объёмом более 1000 слов и предназначен для понимания и управления различными визуальными параметрами, такими как освещение, композиция, цвет и настройки камеры, что позволяет получать точные и воспроизводимые результаты.

Всего с 8 миллиардами параметров FIBO обеспечивает новый уровень качества изображений, соответствия промпту и профессионального контроля.

FIBO is trained exclusively on a structured prompt and will not work with freeform text prompts. you can use the [FIBO-VLM-prompt-to-JSON](https://huggingface.co/briaai/FIBO-VLM-prompt-to-JSON) model or the [FIBO-gemini-prompt-to-JSON](https://huggingface.co/briaai/FIBO-gemini-prompt-to-JSON)  to convert your freeform text prompt to a structured JSON prompt.

> [!NOTE]
> Избегайте использования свободных текстовых промптов непосредственно с FIBO, так как это не даёт наилучших результатов.

См. страницу [Bria Fibo](https://huggingface.co/briaai/FIBO) на Hugging Face, чтобы узнать больше.

## Использование

_Поскольку модель доступна по запросу, перед её использованием с diffusers вам необходимо перейти на [страницу Bria Fibo на Hugging Face](https://huggingface.co/briaai/FIBO), заполнить форму и принять условия доступа. После этого вам нужно выполнить вход, чтобы система знала, что вы приняли условия._

Используйте команду ниже для входа:

```bash
hf auth login
```

## BriaFiboPipeline[[diffusers.BriaFiboPipeline]]

#### diffusers.BriaFiboPipeline[[diffusers.BriaFiboPipeline]]

```python
diffusers.BriaFiboPipeline(transformer: BriaFiboTransformer2DModel, scheduler: diffusers.schedulers.scheduling_flow_match_euler_discrete.FlowMatchEulerDiscreteScheduler | diffusers.schedulers.scheduling_utils.KarrasDiffusionSchedulers, vae: AutoencoderKLWan, text_encoder: SmolLM3ForCausalLM, tokenizer: AutoTokenizer)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo.py#L76)

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

transformer (`BriaFiboTransformer2DModel`) : трансформерная модель для 2D-диффузионного моделирования.

scheduler (`FlowMatchEulerDiscreteScheduler` или `KarrasDiffusionSchedulers`) : планировщик, используемый вместе с `transformer` для удаления шума из закодированных латентов.

vae (`AutoencoderKLWan`) : вариационный автоэнкодер для кодирования изображений в латентные представления и декодирования из них.

text_encoder (`SmolLM3ForCausalLM`) : Текстовый энкодер для обработки входных промптов.
tokenizer (`AutoTokenizer`) : Токенизатор, используемый для обработки входных текстовых промптов для text_encoder.

#### __call__[[diffusers.BriaFiboPipeline.__call__]]

```python
__call__(prompt: str | list[str] = None, height: int | None = None, width: int | None = None, num_inference_steps: int = 30, timesteps: list[int] = None, guidance_scale: float = 5, negative_prompt: str | list[str] | None = None, num_images_per_prompt: int | None = 1, generator: typing.Union[torch.Generator, list[torch.Generator], NoneType] = None, latents: typing.Optional[torch.FloatTensor] = None, output_type: str | None = 'pil', return_dict: bool = True, joint_attention_kwargs: dict[str, typing.Any] | None = None, callback_on_step_end: typing.Optional[typing.Callable[[int, int], NoneType]] = None, callback_on_step_end_tensor_inputs: list[str] = ['latents'], max_sequence_length: int = 3000, do_patching = False)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo.py#L435)

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

prompt (`str` или `list[str]`) : Промпт или промпты для управления генерацией изображения.

height (`int`, *optional*, по умолчанию self.unet.config.sample_size * self.vae_scale_factor) : Высота генерируемого изображения в пикселях. По умолчанию установлено значение 1024 для достижения наилучших результатов.
width (`int`, *optional*, по умолчанию self.unet.config.sample_size * self.vae_scale_factor) : Ширина генерируемого изображения в пикселях. По умолчанию установлено значение 1024 для достижения наилучших результатов.

num_inference_steps (`int`, *optional*, по умолчанию 50) : Количество шагов денойзинга. Как правило, большее число шагов денойзинга приводит к изображению более высокого качества, но за счёт более медленного вывода.

timesteps (`list[int]`, *optional*) : Пользовательские шаги для процесса денойзинга с планировщиками, поддерживающими аргумент `timesteps` в их методе `set_timesteps`. Если не определено, будет использоваться поведение по умолчанию при передаче `num_inference_steps`. Должны быть в порядке убывания.

guidance_scale (`float`, *optional*, по умолчанию 5.0) : Масштаб руководства, определённый в [Classifier-Free Diffusion Guidance](https://huggingface.co/papers/2207.12598). `guidance_scale` определяется как `w` из уравнения 2 в [Imagen Paper](https://huggingface.co/papers/2205.11487). Масштаб руководства активируется при установке `guidance_scale > 1`. Более высокий масштаб руководства способствует генерации изображений, тесно связанных с текстовым `prompt`, обычно за счёт снижения качества изображения.
negative_prompt (`str` или `list[str]`, *необязательный*) : Промпт или промпты, которые не должны направлять генерацию изображения. Игнорируется, если не используется направляющая (то есть игнорируется, если `guidance_scale` меньше `1`).

num_images_per_prompt (`int`, *необязательный*, по умолчанию 1) : Количество изображений, генерируемых на один запрос.
generator (`torch.Generator` или `list[torch.Generator]`, *необязательный*) : Один или список [генераторов torch](https://pytorch.org/docs/stable/generated/torch.Generator.html) для обеспечения детерминированности генерации.
latents (`torch.FloatTensor`, *optional*) : Предварительно сгенерированные зашумлённые латенты, выбранные из гауссова распределения, которые используются в качестве входных данных для генерации изображений. Позволяет корректировать одну и ту же генерацию с помощью разных промптов. Если не указаны, тензор латентов будет сгенерирован путём выборки с использованием переданного случайного `generator`.
output_type (`str`, *необязательный*, по умолчанию `"pil"`) : Формат вывода для генерируемого изображения. Выберите между [PIL](https://pillow.readthedocs.io/en/stable/): `PIL.Image.Image` или `np.array`.

return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли `~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput` вместо обычного кортежа.
joint_attention_kwargs (`dict`, *необязательный*) : Словарь kwargs, который при указании передается в `AttentionProcessor`, определенный в `self.processor` в [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).
callback_on_step_end (`Callable`, *необязательный*) : функция, вызываемая в конце каждого шага денойзинга во время инференса. Функция вызывается со следующими аргументами: `callback_on_step_end(self: DiffusionPipeline, step: int, timestep: int, callback_kwargs: Dict)`. `callback_kwargs` будет содержать список всех тензоров, как указано в `callback_on_step_end_tensor_inputs`.

callback_on_step_end_tensor_inputs (`List`, *необязательный*) : Список тензорных входных данных для функции `callback_on_step_end`. Тензоры, указанные в списке, будут переданы в качестве аргумента `callback_kwargs`. Вы сможете включать только переменные, перечисленные в атрибуте `._callback_tensor_inputs` вашего класса конвейера.

max_sequence_length (`int` по умолчанию 3000) : Максимальная длина последовательности, используемая с `prompt`.

do_patching (`bool`, *необязательный*, по умолчанию `False`) : Использовать ли патчинг.
**Возвращает:** `~pipelines.flux.BriaFiboPipelineOutput` или `tuple`
`~pipelines.flux.BriaFiboPipelineOutput`, если `return_dict` равно True, иначе `tuple`. При возврате кортежа первым элементом является список с сгенерированными изображениями.

Функция, вызываемая при обращении к конвейеру для генерации.

Пример:
```python
import torch
from diffusers import BriaFiboPipeline
from diffusers.modular_pipelines import ModularPipeline
torch.set_grad_enabled(False)
vlm_pipe = ModularPipeline.from_pretrained("briaai/FIBO-VLM-prompt-to-JSON", trust_remote_code=True)
pipe = BriaFiboPipeline.from_pretrained(
    "briaai/FIBO",
    trust_remote_code=True,
    torch_dtype=torch.bfloat16,
)
pipe.enable_model_cpu_offload()
with torch.inference_mode():
    # 1. Create a prompt to generate an initial image
    output = vlm_pipe(prompt="a beautiful dog")
    json_prompt_generate = output.values["json_prompt"]
    # Generate the image from the structured json prompt
    results_generate = pipe(prompt=json_prompt_generate, num_inference_steps=50, guidance_scale=5)
    results_generate.images[0].save("image_generate.png")
```

#### encode_prompt[[diffusers.BriaFiboPipeline.encode_prompt]]

```python
encode_prompt(prompt: str | list[str], device: typing.Optional[torch.device] = None, num_images_per_prompt: int = 1, guidance_scale: float = 5, negative_prompt: str | list[str] | None = None, max_sequence_length: int = 3000, lora_scale: float | None = None)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo.py#L201)

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

prompt (`str` или `list[str]`, *необязательный*) : промпт для кодирования

device : (`torch.device`): устройство torch

num_images_per_prompt (`int`) : количество изображений, которые должны быть сгенерированы для каждого промпта
guidance_scale (`float`) : Масштаб руководства для классификаторного свободного руководства.

negative_prompt (`str` или `list[str]`, *необязательный*) : Промпт или промпты, которые не должны направлять генерацию изображения. Игнорируется, если не используется направляющая (то есть игнорируется, если `guidance_scale` меньше `1`).

Xet Storage Details

Size:: 13.6 kB
Xet hash:: 303c5bfbcb01a5b392ffd771a4c704dd292e947edf94c4322bbd96fe891e8cfa

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# Bria Fibo

	Модели text-to-image освоили воображение, но не контроль. FIBO меняет это.

	FIBO обучается на структурированных JSON-описаниях объёмом более 1000 слов и предназначен для понимания и управления различными визуальными параметрами, такими как освещение, композиция, цвет и настройки камеры, что позволяет получать точные и воспроизводимые результаты.

	Всего с 8 миллиардами параметров FIBO обеспечивает новый уровень качества изображений, соответствия промпту и профессионального контроля.

	FIBO is trained exclusively on a structured prompt and will not work with freeform text prompts. you can use the [FIBO-VLM-prompt-to-JSON](https://huggingface.co/briaai/FIBO-VLM-prompt-to-JSON) model or the [FIBO-gemini-prompt-to-JSON](https://huggingface.co/briaai/FIBO-gemini-prompt-to-JSON) to convert your freeform text prompt to a structured JSON prompt.

	> [!NOTE]
	> Избегайте использования свободных текстовых промптов непосредственно с FIBO, так как это не даёт наилучших результатов.

	См. страницу [Bria Fibo](https://huggingface.co/briaai/FIBO) на Hugging Face, чтобы узнать больше.

	## Использование

	_Поскольку модель доступна по запросу, перед её использованием с diffusers вам необходимо перейти на [страницу Bria Fibo на Hugging Face](https://huggingface.co/briaai/FIBO), заполнить форму и принять условия доступа. После этого вам нужно выполнить вход, чтобы система знала, что вы приняли условия._

	Используйте команду ниже для входа:

	```bash
	hf auth login
	```

	## BriaFiboPipeline[[diffusers.BriaFiboPipeline]]

	#### diffusers.BriaFiboPipeline[[diffusers.BriaFiboPipeline]]

	```python
	diffusers.BriaFiboPipeline(transformer: BriaFiboTransformer2DModel, scheduler: diffusers.schedulers.scheduling_flow_match_euler_discrete.FlowMatchEulerDiscreteScheduler \| diffusers.schedulers.scheduling_utils.KarrasDiffusionSchedulers, vae: AutoencoderKLWan, text_encoder: SmolLM3ForCausalLM, tokenizer: AutoTokenizer)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo.py#L76)

	Параметры:

	transformer (`BriaFiboTransformer2DModel`) : трансформерная модель для 2D-диффузионного моделирования.

	scheduler (`FlowMatchEulerDiscreteScheduler` или `KarrasDiffusionSchedulers`) : планировщик, используемый вместе с `transformer` для удаления шума из закодированных латентов.

	vae (`AutoencoderKLWan`) : вариационный автоэнкодер для кодирования изображений в латентные представления и декодирования из них.

	text_encoder (`SmolLM3ForCausalLM`) : Текстовый энкодер для обработки входных промптов.

	tokenizer (`AutoTokenizer`) : Токенизатор, используемый для обработки входных текстовых промптов для text_encoder.

	#### __call__[[diffusers.BriaFiboPipeline.__call__]]

	```python
	__call__(prompt: str \| list[str] = None, height: int \| None = None, width: int \| None = None, num_inference_steps: int = 30, timesteps: list[int] = None, guidance_scale: float = 5, negative_prompt: str \| list[str] \| None = None, num_images_per_prompt: int \| None = 1, generator: typing.Union[torch.Generator, list[torch.Generator], NoneType] = None, latents: typing.Optional[torch.FloatTensor] = None, output_type: str \| None = 'pil', return_dict: bool = True, joint_attention_kwargs: dict[str, typing.Any] \| None = None, callback_on_step_end: typing.Optional[typing.Callable[[int, int], NoneType]] = None, callback_on_step_end_tensor_inputs: list[str] = ['latents'], max_sequence_length: int = 3000, do_patching = False)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo.py#L435)

	Параметры:

	prompt (`str` или `list[str]`) : Промпт или промпты для управления генерацией изображения.

	height (`int`, optional, по умолчанию self.unet.config.sample_size * self.vae_scale_factor) : Высота генерируемого изображения в пикселях. По умолчанию установлено значение 1024 для достижения наилучших результатов.

	width (`int`, optional, по умолчанию self.unet.config.sample_size * self.vae_scale_factor) : Ширина генерируемого изображения в пикселях. По умолчанию установлено значение 1024 для достижения наилучших результатов.

	num_inference_steps (`int`, optional, по умолчанию 50) : Количество шагов денойзинга. Как правило, большее число шагов денойзинга приводит к изображению более высокого качества, но за счёт более медленного вывода.

	timesteps (`list[int]`, optional) : Пользовательские шаги для процесса денойзинга с планировщиками, поддерживающими аргумент `timesteps` в их методе `set_timesteps`. Если не определено, будет использоваться поведение по умолчанию при передаче `num_inference_steps`. Должны быть в порядке убывания.

	guidance_scale (`float`, optional, по умолчанию 5.0) : Масштаб руководства, определённый в [Classifier-Free Diffusion Guidance](https://huggingface.co/papers/2207.12598). `guidance_scale` определяется как `w` из уравнения 2 в [Imagen Paper](https://huggingface.co/papers/2205.11487). Масштаб руководства активируется при установке `guidance_scale > 1`. Более высокий масштаб руководства способствует генерации изображений, тесно связанных с текстовым `prompt`, обычно за счёт снижения качества изображения.

	negative_prompt (`str` или `list[str]`, необязательный) : Промпт или промпты, которые не должны направлять генерацию изображения. Игнорируется, если не используется направляющая (то есть игнорируется, если `guidance_scale` меньше `1`).

	num_images_per_prompt (`int`, необязательный, по умолчанию 1) : Количество изображений, генерируемых на один запрос.

	generator (`torch.Generator` или `list[torch.Generator]`, необязательный) : Один или список [генераторов torch](https://pytorch.org/docs/stable/generated/torch.Generator.html) для обеспечения детерминированности генерации.

	latents (`torch.FloatTensor`, optional) : Предварительно сгенерированные зашумлённые латенты, выбранные из гауссова распределения, которые используются в качестве входных данных для генерации изображений. Позволяет корректировать одну и ту же генерацию с помощью разных промптов. Если не указаны, тензор латентов будет сгенерирован путём выборки с использованием переданного случайного `generator`.

	output_type (`str`, необязательный, по умолчанию `"pil"`) : Формат вывода для генерируемого изображения. Выберите между [PIL](https://pillow.readthedocs.io/en/stable/): `PIL.Image.Image` или `np.array`.

	return_dict (`bool`, необязательный, по умолчанию `True`) : Возвращать ли `~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput` вместо обычного кортежа.

	joint_attention_kwargs (`dict`, необязательный) : Словарь kwargs, который при указании передается в `AttentionProcessor`, определенный в `self.processor` в [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

	callback_on_step_end (`Callable`, необязательный) : функция, вызываемая в конце каждого шага денойзинга во время инференса. Функция вызывается со следующими аргументами: `callback_on_step_end(self: DiffusionPipeline, step: int, timestep: int, callback_kwargs: Dict)`. `callback_kwargs` будет содержать список всех тензоров, как указано в `callback_on_step_end_tensor_inputs`.

	callback_on_step_end_tensor_inputs (`List`, необязательный) : Список тензорных входных данных для функции `callback_on_step_end`. Тензоры, указанные в списке, будут переданы в качестве аргумента `callback_kwargs`. Вы сможете включать только переменные, перечисленные в атрибуте `._callback_tensor_inputs` вашего класса конвейера.

	max_sequence_length (`int` по умолчанию 3000) : Максимальная длина последовательности, используемая с `prompt`.

	do_patching (`bool`, необязательный, по умолчанию `False`) : Использовать ли патчинг.

	Возвращает: `~pipelines.flux.BriaFiboPipelineOutput` или `tuple`

	`~pipelines.flux.BriaFiboPipelineOutput`, если `return_dict` равно True, иначе `tuple`. При возврате кортежа первым элементом является список с сгенерированными изображениями.

	Функция, вызываемая при обращении к конвейеру для генерации.

	Пример:
	```python
	import torch
	from diffusers import BriaFiboPipeline
	from diffusers.modular_pipelines import ModularPipeline

	torch.set_grad_enabled(False)
	vlm_pipe = ModularPipeline.from_pretrained("briaai/FIBO-VLM-prompt-to-JSON", trust_remote_code=True)

	pipe = BriaFiboPipeline.from_pretrained(
	"briaai/FIBO",
	trust_remote_code=True,
	torch_dtype=torch.bfloat16,
	)
	pipe.enable_model_cpu_offload()

	with torch.inference_mode():
	# 1. Create a prompt to generate an initial image
	output = vlm_pipe(prompt="a beautiful dog")
	json_prompt_generate = output.values["json_prompt"]

	# Generate the image from the structured json prompt
	results_generate = pipe(prompt=json_prompt_generate, num_inference_steps=50, guidance_scale=5)
	results_generate.images[0].save("image_generate.png")
	```

	#### encode_prompt[[diffusers.BriaFiboPipeline.encode_prompt]]

	```python
	encode_prompt(prompt: str \| list[str], device: typing.Optional[torch.device] = None, num_images_per_prompt: int = 1, guidance_scale: float = 5, negative_prompt: str \| list[str] \| None = None, max_sequence_length: int = 3000, lora_scale: float \| None = None)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo.py#L201)

	Параметры:

	prompt (`str` или `list[str]`, необязательный) : промпт для кодирования

	device : (`torch.device`): устройство torch

	num_images_per_prompt (`int`) : количество изображений, которые должны быть сгенерированы для каждого промпта

	guidance_scale (`float`) : Масштаб руководства для классификаторного свободного руководства.

	negative_prompt (`str` или `list[str]`, необязательный) : Промпт или промпты, которые не должны направлять генерацию изображения. Игнорируется, если не используется направляющая (то есть игнорируется, если `guidance_scale` меньше `1`).