Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /pt /hybrid_inference /api_reference.md

mishig

7 days ago

preview code

download

raw

5.91 kB

# Inferência remota

A inferência remota fornece acesso a um [Inference Endpoint](https://huggingface.co/docs/inference-endpoints/index) para transferir os requisitos de geração local para decodificação e codificação.

## remote_decode[[diffusers.utils.remote_decode]]

#### diffusers.utils.remote_decode[[diffusers.utils.remote_decode]]

```python
diffusers.utils.remote_decode(endpoint: str, tensor: 'torch.Tensor', processor: 'VaeImageProcessor' | 'VideoProcessor' | None = None, do_scaling: bool = True, scaling_factor: float | None = None, shift_factor: float | None = None, output_type: Literal['mp4', 'pil', 'pt'] = 'pil', return_type: Literal['mp4', 'pil', 'pt'] = 'pil', image_format: Literal['png', 'jpg'] = 'jpg', partial_postprocess: bool = False, input_tensor_type: Literal['binary'] = 'binary', output_tensor_type: Literal['binary'] = 'binary', height: int | None = None, width: int | None = None)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/remote_utils.py#L190)

**Parâmetros:**

endpoint (`str`) : Ponto de acesso para Decodificação Remota.

tensor (`torch.Tensor`) : Tensor a ser decodificado.

processor (`VaeImageProcessor` ou `VideoProcessor`, *opcional*) : Usado com `return_type="pt"` e `return_type="pil"` para modelos de vídeo.

do_scaling (`bool`, padrão `True`, *opcional*) : **DEPRECATED**. **passar `scaling_factor`/`shift_factor` em vez disso.** **ainda definir do_scaling=None/do_scaling=False para não aplicar escala até a opção ser removida** Quando `True`, a escala, por exemplo, `latents / self.vae.config.scaling_factor`, é aplicada remotamente. Se `False`, a entrada deve ser passada com a escala já aplicada.

scaling_factor (`float`, *opcional*) : A escala é aplicada quando passada, por exemplo, [`latents / self.vae.config.scaling_factor`](https://github.com/huggingface/diffusers/blob/7007febae5cff000d4df9059d9cf35133e8b2ca9/src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion.py#L1083C37-L1083C77). - SD v1: 0.18215 - SD XL: 0.13025 - Flux: 0.3611 Se `None`, a entrada deve ser passada com a escala já aplicada.
shift_factor (`float`, *opcional*) : O deslocamento é aplicado quando é passado, por exemplo, `latents + self.vae.config.shift_factor`. - Flux: 0.1159 Se `None`, a entrada deve ser passada com a escala aplicada.

output_type (`"mp4"` ou `"pil"` ou `"pt", default `"pil") : tipo de saída do **Endpoint**. Sujeito a alterações. Informe seu feedback sobre o tipo preferido.  `"mp4": Supported by video models. Endpoint returns `bytes` of video. `"pil"`: Supported by image and video models. Image models: Endpoint returns `bytes` of an image in `image_format`. Video models: Endpoint returns `torch.Tensor` with partial `postprocessing` applied. Requires `processor` as a flag (any `None` value will work). `"pt"`: Support by image and video models. Endpoint returns `torch.Tensor`. With `partial_postprocess=True` the tensor is postprocessed `uint8` image tensor.  Recommendations: `"pt"` with `partial_postprocess=True` is the smallest transfer for full quality. `"pt"` with `partial_postprocess=False` is the most compatible with third party code. `"pil"` with `image_format="jpg"` is the smallest transfer overall.

return_type (`"mp4"` or `"pil"` or `"pt", default `"pil") : **Function** return type.  `"mp4": Function returns `bytes` of video. `"pil"`: Function returns `PIL.Image.Image`. With `output_type="pil" no further processing is applied. With `output_type="pt" a `PIL.Image.Image` is created. `partial_postprocess=False` `processor` is required. `partial_postprocess=True` `processor` is **not** required. `"pt"`: Function returns `torch.Tensor`. `processor` is **not** required. `partial_postprocess=False` tensor is `float16` or `bfloat16`, without denormalization. `partial_postprocess=True` tensor is `uint8`, denormalized.

image_format (`"png"` ou `"jpg"`, padrão `jpg`) : Usado com `output_type="pil"`. O endpoint retorna `jpg` ou `png`.

partial_postprocess (`bool`, padrão `False`) : Usado com `output_type="pt"`. `partial_postprocess=False` o tensor é `float16` ou `bfloat16`, sem desnornalização. `partial_postprocess=True` o tensor é `uint8`, desnornalizado.

input_tensor_type (`"binary"`, padrão `"binary"`) : Tipo de transferência de tensor.

output_tensor_type (`"binary"`, padrão `"binary"`) : Tipo de transferência de tensor.

height (`int`, **opcional**) : Obrigatório para latentes `"packed"`.

width (`int`, **opcional**) : Obrigatório para latentes `"packed"`.

**Retorna:**

output (`Image.Image` ou `list[Image.Image]` ou `bytes` ou `torch.Tensor`).

Hugging Face Hybrid Inference que permite executar o decodificação do VAE remotamente.

## remote_encode[[diffusers.utils.remote_utils.remote_encode]]
#### diffusers.utils.remote_utils.remote_encode[[diffusers.utils.remote_utils.remote_encode]]
```python
diffusers.utils.remote_utils.remote_encode(endpoint: str, image: 'torch.Tensor' | Image.Image, scaling_factor: float | None = None, shift_factor: float | None = None)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/remote_utils.py#L382)
**Parâmetros:**
endpoint (`str`) : Ponto de acesso para Decodificação Remota.
image (`torch.Tensor` ou `PIL.Image.Image`) : Imagem a ser codificada.
scaling_factor (`float`, *opcional*) : A escala é aplicada quando passada, por exemplo, `latents * self.vae.config.scaling_factor`. - SD v1: 0.18215 - SD XL: 0.13025 - Flux: 0.3611 Se `None`, a entrada deve ser passada com a escala já aplicada.
shift_factor (`float`, *opcional*) : O deslocamento é aplicado quando fornecido, por exemplo, `latents - self.vae.config.shift_factor`. - Flux: 0.1159 Se `None`, a entrada deve ser fornecida com a escala aplicada.
**Retorna:**
output (`torch.Tensor`).
Hugging Face Hybrid Inference que permite executar o encode do VAE remotamente.

Xet Storage Details

Size:: 5.91 kB
Xet hash:: aa420109f24741400a6a0a52c2f37318056a80dc974f2ab31290450d011c5834

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

	# Inferência remota

	A inferência remota fornece acesso a um [Inference Endpoint](https://huggingface.co/docs/inference-endpoints/index) para transferir os requisitos de geração local para decodificação e codificação.

	## remote_decode[[diffusers.utils.remote_decode]]

	#### diffusers.utils.remote_decode[[diffusers.utils.remote_decode]]

	```python
	diffusers.utils.remote_decode(endpoint: str, tensor: 'torch.Tensor', processor: 'VaeImageProcessor' \| 'VideoProcessor' \| None = None, do_scaling: bool = True, scaling_factor: float \| None = None, shift_factor: float \| None = None, output_type: Literal['mp4', 'pil', 'pt'] = 'pil', return_type: Literal['mp4', 'pil', 'pt'] = 'pil', image_format: Literal['png', 'jpg'] = 'jpg', partial_postprocess: bool = False, input_tensor_type: Literal['binary'] = 'binary', output_tensor_type: Literal['binary'] = 'binary', height: int \| None = None, width: int \| None = None)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/remote_utils.py#L190)

	Parâmetros:

	endpoint (`str`) : Ponto de acesso para Decodificação Remota.

	tensor (`torch.Tensor`) : Tensor a ser decodificado.

	processor (`VaeImageProcessor` ou `VideoProcessor`, opcional) : Usado com `return_type="pt"` e `return_type="pil"` para modelos de vídeo.

	do_scaling (`bool`, padrão `True`, opcional) : DEPRECATED. passar `scaling_factor`/`shift_factor` em vez disso. ainda definir do_scaling=None/do_scaling=False para não aplicar escala até a opção ser removida Quando `True`, a escala, por exemplo, `latents / self.vae.config.scaling_factor`, é aplicada remotamente. Se `False`, a entrada deve ser passada com a escala já aplicada.

	scaling_factor (`float`, opcional) : A escala é aplicada quando passada, por exemplo, [`latents / self.vae.config.scaling_factor`](https://github.com/huggingface/diffusers/blob/7007febae5cff000d4df9059d9cf35133e8b2ca9/src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion.py#L1083C37-L1083C77). - SD v1: 0.18215 - SD XL: 0.13025 - Flux: 0.3611 Se `None`, a entrada deve ser passada com a escala já aplicada.

	shift_factor (`float`, opcional) : O deslocamento é aplicado quando é passado, por exemplo, `latents + self.vae.config.shift_factor`. - Flux: 0.1159 Se `None`, a entrada deve ser passada com a escala aplicada.

	output_type (`"mp4"` ou `"pil"` ou `"pt", default `"pil") : tipo de saída do Endpoint. Sujeito a alterações. Informe seu feedback sobre o tipo preferido. `"mp4": Supported by video models. Endpoint returns `bytes` of video. `"pil"`: Supported by image and video models. Image models: Endpoint returns `bytes` of an image in `image_format`. Video models: Endpoint returns `torch.Tensor` with partial `postprocessing` applied. Requires `processor` as a flag (any `None` value will work). `"pt"`: Support by image and video models. Endpoint returns `torch.Tensor`. With `partial_postprocess=True` the tensor is postprocessed `uint8` image tensor. Recommendations: `"pt"` with `partial_postprocess=True` is the smallest transfer for full quality. `"pt"` with `partial_postprocess=False` is the most compatible with third party code. `"pil"` with `image_format="jpg"` is the smallest transfer overall.

	return_type (`"mp4"` or `"pil"` or `"pt", default `"pil") : Function return type. `"mp4": Function returns `bytes` of video. `"pil"`: Function returns `PIL.Image.Image`. With `output_type="pil" no further processing is applied. With `output_type="pt" a `PIL.Image.Image` is created. `partial_postprocess=False` `processor` is required. `partial_postprocess=True` `processor` is not required. `"pt"`: Function returns `torch.Tensor`. `processor` is not required. `partial_postprocess=False` tensor is `float16` or `bfloat16`, without denormalization. `partial_postprocess=True` tensor is `uint8`, denormalized.

	image_format (`"png"` ou `"jpg"`, padrão `jpg`) : Usado com `output_type="pil"`. O endpoint retorna `jpg` ou `png`.

	partial_postprocess (`bool`, padrão `False`) : Usado com `output_type="pt"`. `partial_postprocess=False` o tensor é `float16` ou `bfloat16`, sem desnornalização. `partial_postprocess=True` o tensor é `uint8`, desnornalizado.

	input_tensor_type (`"binary"`, padrão `"binary"`) : Tipo de transferência de tensor.

	output_tensor_type (`"binary"`, padrão `"binary"`) : Tipo de transferência de tensor.

	height (`int`, opcional) : Obrigatório para latentes `"packed"`.

	width (`int`, opcional) : Obrigatório para latentes `"packed"`.

	Retorna:

	output (`Image.Image` ou `list[Image.Image]` ou `bytes` ou `torch.Tensor`).

	Hugging Face Hybrid Inference que permite executar o decodificação do VAE remotamente.

	## remote_encode[[diffusers.utils.remote_utils.remote_encode]]

	#### diffusers.utils.remote_utils.remote_encode[[diffusers.utils.remote_utils.remote_encode]]

	```python
	diffusers.utils.remote_utils.remote_encode(endpoint: str, image: 'torch.Tensor' \| Image.Image, scaling_factor: float \| None = None, shift_factor: float \| None = None)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/remote_utils.py#L382)

	Parâmetros:

	endpoint (`str`) : Ponto de acesso para Decodificação Remota.

	image (`torch.Tensor` ou `PIL.Image.Image`) : Imagem a ser codificada.

	scaling_factor (`float`, opcional) : A escala é aplicada quando passada, por exemplo, `latents * self.vae.config.scaling_factor`. - SD v1: 0.18215 - SD XL: 0.13025 - Flux: 0.3611 Se `None`, a entrada deve ser passada com a escala já aplicada.

	shift_factor (`float`, opcional) : O deslocamento é aplicado quando fornecido, por exemplo, `latents - self.vae.config.shift_factor`. - Flux: 0.1159 Se `None`, a entrada deve ser fornecida com a escala aplicada.

	Retorna:

	output (`torch.Tensor`).

	Hugging Face Hybrid Inference que permite executar o encode do VAE remotamente.