-
Notifications
You must be signed in to change notification settings - Fork 6k
Update Intel Gaudi doc #11479
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
Open
regisss
wants to merge
2
commits into
huggingface:main
Choose a base branch
from
regisss:update_gaudi_doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update Intel Gaudi doc #11479
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,67 +10,14 @@ an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express o | |
specific language governing permissions and limitations under the License. | ||
--> | ||
|
||
# Habana Gaudi | ||
# Intel Gaudi | ||
|
||
🤗 Diffusers is compatible with Habana Gaudi through 🤗 [Optimum](https://huggingface.co/docs/optimum/habana/usage_guides/stable_diffusion). Follow the [installation](https://docs.habana.ai/en/latest/Installation_Guide/index.html) guide to install the SynapseAI and Gaudi drivers, and then install Optimum Habana: | ||
The Intel Gaudi AI accelerator family includes [Intel Gaudi 1](https://habana.ai/products/gaudi/), [Intel Gaudi 2](https://habana.ai/products/gaudi2/), and [Intel Gaudi 3](https://habana.ai/products/gaudi3/). Each server is equipped with 8 devices, known as Habana Processing Units (HPUs), providing 128GB of memory on Gaudi 3, 96GB on Gaudi 2, and 32GB on the first-gen Gaudi. For more details on the underlying hardware architecture, check out the [Gaudi Architecture](https://docs.habana.ai/en/latest/Gaudi_Overview/Gaudi_Architecture.html) overview. | ||
|
||
```bash | ||
python -m pip install --upgrade-strategy eager optimum[habana] | ||
Diffusers pipelines can easily be run on Intel Gaudi. Given a pipeline `my_pipeline`, you simply need to do the following: | ||
```py | ||
my_pipeline.to("hpu") | ||
``` | ||
|
||
To generate images with Stable Diffusion 1 and 2 on Gaudi, you need to instantiate two instances: | ||
|
||
- [`~optimum.habana.diffusers.GaudiStableDiffusionPipeline`], a pipeline for text-to-image generation. | ||
- [`~optimum.habana.diffusers.GaudiDDIMScheduler`], a Gaudi-optimized scheduler. | ||
|
||
When you initialize the pipeline, you have to specify `use_habana=True` to deploy it on HPUs and to get the fastest possible generation, you should enable **HPU graphs** with `use_hpu_graphs=True`. | ||
|
||
Finally, specify a [`~optimum.habana.GaudiConfig`] which can be downloaded from the [Habana](https://huggingface.co/Habana) organization on the Hub. | ||
|
||
```python | ||
from optimum.habana import GaudiConfig | ||
from optimum.habana.diffusers import GaudiDDIMScheduler, GaudiStableDiffusionPipeline | ||
|
||
model_name = "stabilityai/stable-diffusion-2-base" | ||
scheduler = GaudiDDIMScheduler.from_pretrained(model_name, subfolder="scheduler") | ||
pipeline = GaudiStableDiffusionPipeline.from_pretrained( | ||
model_name, | ||
scheduler=scheduler, | ||
use_habana=True, | ||
use_hpu_graphs=True, | ||
gaudi_config="Habana/stable-diffusion-2", | ||
) | ||
``` | ||
|
||
Now you can call the pipeline to generate images by batches from one or several prompts: | ||
|
||
```python | ||
outputs = pipeline( | ||
prompt=[ | ||
"High quality photo of an astronaut riding a horse in space", | ||
"Face of a yellow cat, high resolution, sitting on a park bench", | ||
], | ||
num_images_per_prompt=10, | ||
batch_size=4, | ||
) | ||
``` | ||
|
||
For more information, check out 🤗 Optimum Habana's [documentation](https://huggingface.co/docs/optimum/habana/usage_guides/stable_diffusion) and the [example](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) provided in the official GitHub repository. | ||
|
||
## Benchmark | ||
|
||
We benchmarked Habana's first-generation Gaudi and Gaudi2 with the [Habana/stable-diffusion](https://huggingface.co/Habana/stable-diffusion) and [Habana/stable-diffusion-2](https://huggingface.co/Habana/stable-diffusion-2) Gaudi configurations (mixed precision bf16/fp32) to demonstrate their performance. | ||
|
||
For [Stable Diffusion v1.5](https://huggingface.co/stable-diffusion-v1-5/stable-diffusion-v1-5) on 512x512 images: | ||
|
||
| | Latency (batch size = 1) | Throughput | | ||
| ---------------------- |:------------------------:|:---------------------------:| | ||
| first-generation Gaudi | 3.80s | 0.308 images/s (batch size = 8) | | ||
| Gaudi2 | 1.33s | 1.081 images/s (batch size = 8) | | ||
|
||
For [Stable Diffusion v2.1](https://huggingface.co/stabilityai/stable-diffusion-2-1) on 768x768 images: | ||
|
||
| | Latency (batch size = 1) | Throughput | | ||
| ---------------------- |:------------------------:|:-------------------------------:| | ||
| first-generation Gaudi | 10.2s | 0.108 images/s (batch size = 4) | | ||
| Gaudi2 | 3.17s | 0.379 images/s (batch size = 8) | | ||
> [!TIP] | ||
> For Gaudi-optimized diffusion pipeline implementations, we recommend using [Optimum for Intel Gaudi](https://huggingface.co/docs/optimum/main/en/habana/index). | ||
Comment on lines
+22
to
+23
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we have particular benchmarks that worth mentioning, I'd mention them here briefly to catch the reader's attention. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might make sense to include a minimal yet fully working example. Maybe for Flux as that's quite popular?