Skip to content

Add remote_decode to remote_utils #10898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 40 commits into from
Mar 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
47498fb
Add `remote_decode` to `remote_utils`
hlky Feb 25, 2025
5fb50f1
test dependency
hlky Feb 25, 2025
76f79b3
test dependency
hlky Feb 25, 2025
303e920
dependency
hlky Feb 25, 2025
8c405d5
dependency
hlky Feb 25, 2025
19414df
dependency
hlky Feb 25, 2025
2a2157e
docstrings
hlky Feb 25, 2025
f80ef6d
changes
hlky Feb 25, 2025
2c572f7
make style
hlky Feb 25, 2025
1978a8a
apply
sayakpaul Feb 25, 2025
e55139b
revert, add new options
hlky Feb 28, 2025
4773420
Apply style fixes
github-actions[bot] Feb 28, 2025
54280dd
Merge branch 'main' into remote-utils
hlky Feb 28, 2025
2af1995
deprecate base64, headers not needed
hlky Feb 28, 2025
d80d66c
address comments
hlky Feb 28, 2025
05b39ab
add license header
hlky Feb 28, 2025
c2a2daf
init test_remote_decode
hlky Feb 28, 2025
1c4fdea
more
hlky Feb 28, 2025
f03a105
more test
hlky Feb 28, 2025
7e7af59
more test
hlky Feb 28, 2025
d16c855
skeleton for xl, flux
hlky Feb 28, 2025
485d99e
more test
hlky Mar 1, 2025
2937eb2
flux test
hlky Mar 1, 2025
86c2236
flux packed
hlky Mar 1, 2025
b10ea13
no scaling
hlky Mar 1, 2025
7df21f2
-save
hlky Mar 1, 2025
562a4c0
hunyuanvideo test
hlky Mar 1, 2025
9a39e35
Apply style fixes
github-actions[bot] Mar 1, 2025
217e161
Merge branch 'main' into remote-utils
hlky Mar 1, 2025
3712dc3
init docs
hlky Mar 1, 2025
5302645
Update src/diffusers/utils/remote_utils.py
hlky Mar 1, 2025
3f69f92
comments
hlky Mar 1, 2025
08ffc8f
Apply style fixes
github-actions[bot] Mar 1, 2025
6c2f123
comments
hlky Mar 2, 2025
82aa5cd
hybrid_inference/vae_decode
hlky Mar 2, 2025
7151510
fix
hlky Mar 2, 2025
9f6d91f
tip?
hlky Mar 2, 2025
4c24111
tip
hlky Mar 2, 2025
9c39564
api reference autodoc
hlky Mar 2, 2025
ca53835
install tip
hlky Mar 2, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/source/en/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,14 @@
- local: advanced_inference/outpaint
title: Outpainting
title: Advanced inference
- sections:
- local: hybrid_inference/overview
title: Overview
- local: hybrid_inference/vae_decode
title: VAE Decode
- local: hybrid_inference/api_reference
title: API Reference
title: Hybrid Inference
- sections:
- local: using-diffusers/cogvideox
title: CogVideoX
Expand Down
5 changes: 5 additions & 0 deletions docs/source/en/hybrid_inference/api_reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Hybrid Inference API Reference

## Remote Decode

[[autodoc]] utils.remote_utils.remote_decode
54 changes: 54 additions & 0 deletions docs/source/en/hybrid_inference/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!--Copyright 2024 The HuggingFace Team. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->

# Hybrid Inference

**Empowering local AI builders with Hybrid Inference**


> [!TIP]
> Hybrid Inference is an [experimental feature](https://huggingface.co/blog/remote_vae).
> Feedback can be provided [here](https://github.com/huggingface/diffusers/issues/new?template=remote-vae-pilot-feedback.yml).



## Why use Hybrid Inference?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so here basically we listed the type of end points we offer, I think we can create a section for that later
for a "Why use ...?" section, let's highlight user benefits (I think currently the "key benefits" section is intended for)


Hybrid Inference offers a fast and simple way to offload local generation requirements.

- 🚀 **Reduced Requirements:** Access powerful models without expensive hardware.
- 💎 **Without Compromise:** Achieve the highest quality without sacrificing performance.
- 💰 **Cost Effective:** It's free! 🤑
- 🎯 **Diverse Use Cases:** Fully compatible with Diffusers 🧨 and the wider community.
- 🔧 **Developer-Friendly:** Simple requests, fast responses.

---

## Available Models

* **VAE Decode 🖼️:** Quickly decode latent representations into high-quality images without compromising performance or workflow speed.
* **VAE Encode 🔢 (coming soon):** Efficiently encode images into latent representations for generation and training.
* **Text Encoders 📃 (coming soon):** Compute text embeddings for your prompts quickly and accurately, ensuring a smooth and high-quality workflow.

---
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's add a section to showcase Real-World Use cases! we can link to comfy nodes etc


## Integrations

* **[SD.Next](https://github.com/vladmandic/sdnext):** All-in-one UI with direct supports Hybrid Inference.
* **[ComfyUI-HFRemoteVae](https://github.com/kijai/ComfyUI-HFRemoteVae):** ComfyUI node for Hybrid Inference.

## Contents

The documentation is organized into two sections:

* **VAE Decode** Learn the basics of how to use VAE Decode with Hybrid Inference.
* **API Reference** Dive into task-specific settings and parameters.
Loading
Loading