Buckets:

hf-doc-build/doc / diffusers /main /fr /api /pipelines /bria_fibo_edit.md
mishig's picture
|
download
raw
12.8 kB
# Bria Fibo Edit
Fibo Edit est un modèle image-à-image de 8 milliards de paramètres qui introduit un nouveau paradigme de contrôle structuré, fonctionnant sur des entrées JSON associées à des images sources pour permettre des flux de travail d'édition déterministes et reproductibles. Doté d'un masquage natif pour une précision granulaire, il va au-delà de la diffusion simple basée sur des prompts pour offrir un contrôle explicite et interprétable, optimisé pour les environnements de production. Son architecture légère est conçue pour une personnalisation approfondie, permettant aux chercheurs de créer des modèles « Edit » spécialisés pour des tâches spécifiques à un domaine, tout en offrant une qualité esthétique de premier plan
Consultez la [page](https://huggingface.co/briaai/Fibo-Edit-1.5-base) Hugging Face de Bria Fibo Edit pour en savoir plus. Un point de contrôle distillé est disponible sur [Fibo-Edit-1.5-turbo](https://huggingface.co/briaai/Fibo-Edit-1.5-turbo).
## Utilisation
_Le modèle étant soumis à une autorisation, avant de l’utiliser avec diffusers, vous devez d’abord accéder à la [page Hugging Face de Bria Fibo Edit](https://huggingface.co/briaai/Fibo-Edit-1.5-base), remplir le formulaire et accepter l’accès. Une fois autorisé, vous devez vous connecter afin que votre système prenne en compte votre acceptation._
Utilisez la commande ci-dessous pour vous connecter :
```bash
hf auth login
```
## BriaFiboEditPipeline[[diffusers.BriaFiboEditPipeline]]
#### diffusers.BriaFiboEditPipeline[[diffusers.BriaFiboEditPipeline]]
```python
diffusers.BriaFiboEditPipeline(transformer: BriaFiboTransformer2DModel, scheduler: typing.Union[diffusers.schedulers.scheduling_flow_match_euler_discrete.FlowMatchEulerDiscreteScheduler, diffusers.schedulers.scheduling_utils.KarrasDiffusionSchedulers], vae: AutoencoderKLWan, text_encoder: SmolLM3ForCausalLM, tokenizer: AutoTokenizer)
```
[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo_edit.py#L240)
**Paramètres :**
transformer (`BriaFiboTransformer2DModel`) : Le modèle de transformer pour la modélisation de diffusion 2D.
scheduler (`FlowMatchEulerDiscreteScheduler` ou `KarrasDiffusionSchedulers`) : Planificateur à utiliser avec `transformer` pour débruyer les latents encodés.
vae (`AutoencoderKLWan`) : Auto-encodeur variationnel pour encoder et décoder des images vers et depuis des représentations latentes.
text_encoder (`SmolLM3ForCausalLM`) : Encodeur de texte pour le traitement des invites d'entrée.
tokenizer (`AutoTokenizer`) : Tokenizer utilisé pour traiter les prompts de texte en entrée destinés au text_encoder.
#### __appel__[[diffusers.BriaFiboEditPipeline.__call__]]
```python
__call__(prompt: typing.Union[str, typing.List[str]] = None, image: typing.Union[PIL.Image.Image, typing.List[PIL.Image.Image], NoneType] = None, mask: typing.Union[torch.FloatTensor, PIL.Image.Image, typing.List[PIL.Image.Image], typing.List[torch.FloatTensor], numpy.ndarray, typing.List[numpy.ndarray], NoneType] = None, height: int | None = None, width: int | None = None, num_inference_steps: int = 30, timesteps: typing.List[int] = None, seed: int | None = None, guidance_scale: float = 5, negative_prompt: typing.Union[str, typing.List[str], NoneType] = None, num_images_per_prompt: typing.Optional[int] = 1, generator: typing.Union[torch.Generator, list[torch.Generator], NoneType] = None, latents: typing.Optional[torch.FloatTensor] = None, output_type: str = 'pil', return_dict: bool = True, joint_attention_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None, callback_on_step_end: typing.Optional[typing.Callable[[int, int, typing.Dict], NoneType]] = None, callback_on_step_end_tensor_inputs: typing.List[str] = ['latents'], max_sequence_length: int = 3000, do_patching = False, _auto_resize: bool = True)
```
[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo_edit.py#L599)
**Paramètres :**
prompt (`str` ou `List[str]`) : Le prompt ou les prompts pour guider la génération d'image.
image (`PIL.Image.Image` ou `List[PIL.Image.Image]`, *facultatif*) : Une ou plusieurs images de référence pour guider la génération d'image. Une liste est interprétée comme plusieurs références (et non comme un lot) : chaque référence est encodée par le VAE à son propre ratio d'aspect et placée sur son propre plan temporel RoPE 1, 2, ... . Si non défini, le pipeline génère une image à partir de zéro.
mask (`PipelineMaskInput`, *facultatif*) : Masque facultatif définissant la région de `image` à modifier. Les pixels couverts par le masque sont régénérés tandis que le reste de l'image est conservé.
height (`int`, *facultatif*, par défaut self.unet.config.sample_size * self.vae_scale_factor) : La hauteur en pixels de l'image générée. Cette valeur est fixée à 1024 par défaut pour obtenir les meilleurs résultats.
width (`int`, *facultatif*, par défaut self.unet.config.sample_size * self.vae_scale_factor) : La largeur en pixels de l'image générée. Cette valeur est fixée à 1024 par défaut pour obtenir les meilleurs résultats.
num_inference_steps (`int`, *facultatif*, valeur par défaut 30) : Le nombre d'étapes de débruitage. Un plus grand nombre d'étapes de débruitage conduit généralement à une image de meilleure qualité, au prix d'une inférence plus lente.
seed (`int`, *facultatif*) : Une graine utilisée pour rendre la génération déterministe.
timesteps (`List[int]`, *facultatif*) : Étapes de temps personnalisées à utiliser pour le processus de débruitage avec les planificateurs qui prennent en charge un argument `timesteps` dans leur méthode `set_timesteps`. S'il n'est pas défini, le comportement par défaut lorsque `num_inference_steps` est passé sera utilisé. Doit être dans l'ordre décroissant.
guidance_scale (`float`, *facultatif*, valeur par défaut 5.0) : Échelle de guidage telle que définie dans [Classifier-Free Diffusion Guidance](https://huggingface.co/papers/2207.12598). `guidance_scale` est défini comme `w` de l'équation 2. de [Imagen Paper](https://huggingface.co/papers/2205.11487). L'échelle de guidage est activée en définissant `guidance_scale > 1`. Une échelle de guidage plus élevée encourage la génération d'images étroitement liées au `prompt` texte, généralement au détriment de la qualité de l'image.
negative_prompt (`str` ou `List[str]`, *facultatif*) : Le prompt ou les prompts à ne pas utiliser pour guider la génération d'image. Ignoré lorsque la guidance n'est pas utilisée (c'est-à-dire ignoré si `guidance_scale` est inférieur à `1`).
num_images_per_prompt (`int`, *facultatif*, valeur par défaut 1) : Le nombre d'images à générer par invite.
generator (`torch.Generator` ou `List[torch.Generator]`, *facultatif*) : Un ou une liste de [générateurs torch](https://pytorch.org/docs/stable/generated/torch.Generator.html) pour rendre la génération déterministe.
latents (`torch.FloatTensor`, *facultatif*) : Latents bruités pré-générés, échantillonnés à partir d'une distribution gaussienne, à utiliser comme entrées pour la génération d'images. Peut être utilisé pour ajuster la même génération avec des prompts différents. S'il n'est pas fourni, un tenseur de latents sera généré par échantillonnage à l'aide du `generator` aléatoire fourni.
output_type (`str`, *facultatif*, par défaut `"pil"`) : Le format de sortie de l'image générée. Choisissez entre [PIL](https://pillow.readthedocs.io/en/stable/) : `PIL.Image.Image` ou `np.array`.
return_dict (`bool`, *facultatif*, par défaut `True`) : Indique s'il faut retourner un `~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput` plutôt qu'un simple tuple.
joint_attention_kwargs (`dict`, *facultatif*) : Un dictionnaire de kwargs qui, s'il est spécifié, est transmis à l'`AttentionProcessor` tel que défini sous `self.processor` dans [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).
callback_on_step_end (`Callable`, *facultatif*) : une fonction appelée à la fin de chaque étape de débruitage pendant l’inférence. La fonction est appelée avec les arguments suivants : `callback_on_step_end(self: DiffusionPipeline, step: int, timestep: int, callback_kwargs: Dict)`. `callback_kwargs` contiendra une liste de tous les tenseurs, tels que spécifiés par `callback_on_step_end_tensor_inputs`.
callback_on_step_end_tensor_inputs (`List`, *facultatif*) : La liste des entrées de tenseurs pour la fonction `callback_on_step_end`. Les tenseurs spécifiés dans la liste seront passés en tant qu'argument `callback_kwargs`. Vous ne pourrez inclure que les variables listées dans l'attribut `._callback_tensor_inputs` de votre classe de pipeline.
max_sequence_length (`int` par défaut 3000) : Longueur maximale de la séquence à utiliser avec le `prompt`.
do_patching (`bool`, *facultatif*, par défaut `False`) : Indique s'il faut utiliser le patching.
_auto_resize (`bool`, *facultatif*, valeur par défaut `True`) : Indique s'il faut arrondir la résolution de sortie par défaut (prise en charge de la première image de référence) aux résolutions préférées.
**Retourne :** `~pipelines.flux.BriaFiboPipelineOutput` ou `tuple`
`~pipelines.flux.BriaFiboPipelineOutput` si `return_dict` est True, sinon un `tuple`. En cas de retour d'un tuple, le premier élément est une liste contenant les images générées.
Fonction appelée lors de l'appel du pipeline pour la génération.
Exemple :
```python
import torch
from PIL import Image
from diffusers import BriaFiboEditPipeline
from diffusers.modular_pipelines import ModularPipelineBlocks
# This prompt-to-JSON block calls Gemini and needs GEMINI_API_KEY in the environment.
vlm_pipe = ModularPipelineBlocks.from_pretrained("briaai/FIBO-edit-gemini-prompt-to-JSON", trust_remote_code=True)
vlm_pipe = vlm_pipe.init_pipeline()
pipe = BriaFiboEditPipeline.from_pretrained(
"briaai/Fibo-Edit-1.5-base",
torch_dtype=torch.bfloat16,
)
pipe.to("cuda")
image = Image.open("owl.png")
json_prompt = vlm_pipe(image=image, prompt="Make the owl into a cat").values["json_prompt"]
result = pipe(prompt=json_prompt, image=image, num_inference_steps=30, guidance_scale=5)
# Multiple reference images: pass a list. Each reference conditions the edit at its
# own aspect ratio; the output resolution follows the first reference.
owl, forest = Image.open("owl.png"), Image.open("forest.png")
json_prompt = vlm_pipe(
image=[owl, forest], prompt="Place the owl from the first image in the forest from the second image"
).values["json_prompt"]
result = pipe(
prompt=json_prompt,
image=[owl, forest],
num_inference_steps=30,
guidance_scale=5,
)
# The distilled Turbo checkpoint edits in 4 steps without classifier-free guidance.
pipe = BriaFiboEditPipeline.from_pretrained("briaai/Fibo-Edit-1.5-turbo", torch_dtype=torch.bfloat16)
pipe.to("cuda")
result = pipe(prompt=json_prompt, image=[owl, forest], num_inference_steps=4, guidance_scale=1)
```
#### encode_prompt[[diffusers.BriaFiboEditPipeline.encode_prompt]]
```python
encode_prompt(prompt: typing.Union[str, typing.List[str]], device: typing.Optional[torch.device] = None, num_images_per_prompt: int = 1, guidance_scale: float = 5, negative_prompt: typing.Union[str, typing.List[str], NoneType] = None, max_sequence_length: int = 3000, lora_scale: bool | None = None)
```
[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo_edit.py#L365)
**Paramètres :**
prompt (`str` ou `List[str]`, *facultatif*) : invite à encoder
device : (`torch.device`) : appareil torch
num_images_per_prompt (`int`) : nombre d'images à générer par invite
guidance_scale (`float`) : Échelle de guidage pour le guidage sans classifieur.
negative_prompt (`str` ou `List[str]`, *facultatif*) : Le prompt ou les prompts à ne pas utiliser pour guider la génération d'image. Ignoré lorsque la guidance n'est pas utilisée (c'est-à-dire ignoré si `guidance_scale` est inférieur à `1`).
#### prepare_reference_latents[[diffusers.BriaFiboEditPipeline.prepare_reference_latents]]
```python
prepare_reference_latents(image: Image, num_channels_latents: int, dtype: dtype, device: device, do_patching: bool = False, reference_index: int = 1)
```
[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/bria_fibo/pipeline_bria_fibo_edit.py#L992)
Encoder une référence PIL unique à sa propre taille avec le VAE et l’empaqueter en tant que flux de jetons de contexte d’édition.

Xet Storage Details

Size:
12.8 kB
·
Xet hash:
1b3714a2d248d908d68b83db6280f130c1fb9d4fc3378f7bb8994a4934d9982e

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