diff --git a/README.md b/README.md
index e9b1a96f4a..28b3cb6e87 100644
--- a/README.md
+++ b/README.md
@@ -15,11 +15,11 @@ limitations under the License.
-->
-
+
-
+
@@ -123,8 +123,8 @@ The [GaudiTrainer](https://huggingface.co/docs/optimum/habana/package_reference/
[Transformers Trainer](https://huggingface.co/docs/transformers/main_classes/trainer), and adapting a script using the Trainer to
make it work with Intel Gaudi accelerators will mostly consist in simply swapping the `Trainer` class for the `GaudiTrainer` one.
-That's how most of the [example scripts](https://github.com/huggingface/optimum-habana/tree/main/examples) were adapted from their
-[original counterparts](https://github.com/huggingface/transformers/tree/main/examples/pytorch).
+That's how most of the [example scripts](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples) were adapted from their
+[original counterparts](https://github.com/huggingface/transformers/tree/v1.20-release/examples/pytorch).
Here is an example:
```diff
@@ -230,62 +230,62 @@ The following model architectures, tasks and device distributions have been vali
| Architecture | Training | Inference | Tasks |
|:-------------|:--------:|:---------:|:------|
-| BERT | :heavy_check_mark: | :heavy_check_mark: |
[text classification](https://github.com/huggingface/optimum-habana/tree/main/examples/text-classification)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text feature extraction](https://github.com/huggingface/optimum-habana/tree/main/examples/text-feature-extraction) |
-| RoBERTa | :heavy_check_mark: | :heavy_check_mark: | [question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling) |
-| ALBERT | :heavy_check_mark: | :heavy_check_mark: | [question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling) |
-| DistilBERT |:heavy_check_mark: | :heavy_check_mark: | [question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling) |
-| GPT2 | :heavy_check_mark: | :heavy_check_mark: | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| BLOOM(Z) | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| StarCoder / StarCoder2 | :heavy_check_mark: | Single-card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| GPT-J | DeepSpeed | Single cardDeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| GPT-Neo | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| GPT-NeoX | DeepSpeed | DeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| OPT | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Llama 2 / CodeLlama / Llama 3 / Llama Guard / Granite | :heavy_check_mark: | :heavy_check_mark: | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[text classification](https://github.com/huggingface/optimum-habana/tree/main/examples/text-classification) (Llama Guard) |
-| StableLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Falcon | LoRA | :heavy_check_mark: | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| CodeGen | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| MPT | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Mistral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Phi | :heavy_check_mark: | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Mixtral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Persimmon | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Qwen2 / Qwen3 | Single card | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Qwen2-MoE | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Gemma | :heavy_check_mark: | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Gemma2 | | :heavy_check_mark: | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| XGLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Cohere | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| T5 / Flan T5 | :heavy_check_mark: | :heavy_check_mark: | [summarization](https://github.com/huggingface/optimum-habana/tree/main/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/main/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering#fine-tuning-t5-on-squad20) |
-| BART | | Single card | [summarization](https://github.com/huggingface/optimum-habana/tree/main/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/main/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering#fine-tuning-t5-on-squad20) |
-| ViT | :heavy_check_mark: | :heavy_check_mark: | [image classification](https://github.com/huggingface/optimum-habana/tree/main/examples/image-classification) |
-| Swin | :heavy_check_mark: | :heavy_check_mark: | [image classification](https://github.com/huggingface/optimum-habana/tree/main/examples/image-classification) |
-| Wav2Vec2 | :heavy_check_mark: | :heavy_check_mark: | [audio classification](https://github.com/huggingface/optimum-habana/tree/main/examples/audio-classification)[speech recognition](https://github.com/huggingface/optimum-habana/tree/main/examples/speech-recognition) |
-| Whisper | :heavy_check_mark: | :heavy_check_mark: | [speech recognition](https://github.com/huggingface/optimum-habana/tree/main/examples/speech-recognition) |
-| SpeechT5 | | Single card | [text to speech](https://github.com/huggingface/optimum-habana/tree/main/examples/text-to-speech) |
-| CLIP | :heavy_check_mark: | :heavy_check_mark: | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/main/examples/contrastive-image-text) |
-| BridgeTower | :heavy_check_mark: | :heavy_check_mark: | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/main/examples/contrastive-image-text) |
-| ESMFold | | Single card | [protein folding](https://github.com/huggingface/optimum-habana/tree/main/examples/protein-folding) |
-| Blip | | Single card | [visual question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/visual-question-answering)[image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| OWLViT | | Single card | [zero shot object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/zero-shot-object-detection) |
-| ClipSeg | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/main/examples/object-segementation) |
-| Llava / Llava-next / Llava-onevision | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| idefics2 | LoRA | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| Paligemma | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| Segment Anything Model | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/main/examples/object-segementation) |
-| VideoMAE | | Single card | [Video classification](https://github.com/huggingface/optimum-habana/tree/main/examples/video-classification) |
-| TableTransformer | | Single card | [table object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/table-detection) |
-| DETR | | Single card | [object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/object-detection) |
-| Mllama | LoRA | :heavy_check_mark: | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| MiniCPM3 | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Baichuan2 | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| DeepSeek-V2 | :heavy_check_mark: | :heavy_check_mark: | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| DeepSeek-V3 / Moonlight | | :heavy_check_mark: | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| ChatGLM | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Qwen2-VL | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| VideoLLaVA | | Single card | [Video comprehension](https://github.com/huggingface/optimum-habana/tree/main/examples/video-comprehension) |
-| GLM-4V | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| Arctic | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
+| BERT | :heavy_check_mark: | :heavy_check_mark: | [text classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-classification)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text feature extraction](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-feature-extraction) |
+| RoBERTa | :heavy_check_mark: | :heavy_check_mark: | [question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling) |
+| ALBERT | :heavy_check_mark: | :heavy_check_mark: | [question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling) |
+| DistilBERT |:heavy_check_mark: | :heavy_check_mark: | [question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling) |
+| GPT2 | :heavy_check_mark: | :heavy_check_mark: | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| BLOOM(Z) | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| StarCoder / StarCoder2 | :heavy_check_mark: | Single-card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| GPT-J | DeepSpeed | Single cardDeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| GPT-Neo | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| GPT-NeoX | DeepSpeed | DeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| OPT | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Llama 2 / CodeLlama / Llama 3 / Llama Guard / Granite | :heavy_check_mark: | :heavy_check_mark: | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[text classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-classification) (Llama Guard) |
+| StableLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Falcon | LoRA | :heavy_check_mark: | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| CodeGen | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| MPT | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Mistral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Phi | :heavy_check_mark: | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Mixtral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Persimmon | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Qwen2 / Qwen3 | Single card | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Qwen2-MoE | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Gemma | :heavy_check_mark: | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Gemma2 | | :heavy_check_mark: | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| XGLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Cohere | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| T5 / Flan T5 | :heavy_check_mark: | :heavy_check_mark: | [summarization](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering#fine-tuning-t5-on-squad20) |
+| BART | | Single card | [summarization](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering#fine-tuning-t5-on-squad20) |
+| ViT | :heavy_check_mark: | :heavy_check_mark: | [image classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-classification) |
+| Swin | :heavy_check_mark: | :heavy_check_mark: | [image classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-classification) |
+| Wav2Vec2 | :heavy_check_mark: | :heavy_check_mark: | [audio classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/audio-classification)[speech recognition](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/speech-recognition) |
+| Whisper | :heavy_check_mark: | :heavy_check_mark: | [speech recognition](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/speech-recognition) |
+| SpeechT5 | | Single card | [text to speech](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-to-speech) |
+| CLIP | :heavy_check_mark: | :heavy_check_mark: | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/contrastive-image-text) |
+| BridgeTower | :heavy_check_mark: | :heavy_check_mark: | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/contrastive-image-text) |
+| ESMFold | | Single card | [protein folding](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/protein-folding) |
+| Blip | | Single card | [visual question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/visual-question-answering)[image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| OWLViT | | Single card | [zero shot object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/zero-shot-object-detection) |
+| ClipSeg | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-segementation) |
+| Llava / Llava-next / Llava-onevision | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| idefics2 | LoRA | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| Paligemma | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| Segment Anything Model | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-segementation) |
+| VideoMAE | | Single card | [Video classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/video-classification) |
+| TableTransformer | | Single card | [table object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/table-detection) |
+| DETR | | Single card | [object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-detection) |
+| Mllama | LoRA | :heavy_check_mark: | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| MiniCPM3 | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Baichuan2 | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| DeepSeek-V2 | :heavy_check_mark: | :heavy_check_mark: | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| DeepSeek-V3 / Moonlight | | :heavy_check_mark: | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| ChatGLM | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Qwen2-VL | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| VideoLLaVA | | Single card | [Video comprehension](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/video-comprehension) |
+| GLM-4V | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| Arctic | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
@@ -294,33 +294,33 @@ The following model architectures, tasks and device distributions have been vali
| Architecture | Training | Inference | Tasks |
|:--------------------|:--------:|:---------:|:------|
-| Stable Diffusion | :heavy_check_mark: | :heavy_check_mark: | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#text-to-image-generation)[image-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#image-to-image-generation) |
-| Stable Diffusion XL | :heavy_check_mark: | :heavy_check_mark: | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#stable-diffusion-xl-sdxl)[image-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#stable-diffusion-xl-refiner) |
-| Stable Diffusion Depth2img | | Single card | [depth-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) |
-| Stable Diffusion 3 | :heavy_check_mark: | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#stable-diffusion-3-and-35-sd3) |
-| LDM3D | | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#text-to-image-generation) |
-| FLUX.1 | LoRA | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#flux1)[image-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#flux1-image-to-image) |
-| Text to Video | | Single card | [text-to-video generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#text-to-video-generation) |
-| Image to Video | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#image-to-video-generation) |
-| i2vgen-xl | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#I2vgen-xl) |
+| Stable Diffusion | :heavy_check_mark: | :heavy_check_mark: | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#text-to-image-generation)[image-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#image-to-image-generation) |
+| Stable Diffusion XL | :heavy_check_mark: | :heavy_check_mark: | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#stable-diffusion-xl-sdxl)[image-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#stable-diffusion-xl-refiner) |
+| Stable Diffusion Depth2img | | Single card | [depth-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion) |
+| Stable Diffusion 3 | :heavy_check_mark: | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#stable-diffusion-3-and-35-sd3) |
+| LDM3D | | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#text-to-image-generation) |
+| FLUX.1 | LoRA | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#flux1)[image-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#flux1-image-to-image) |
+| Text to Video | | Single card | [text-to-video generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#text-to-video-generation) |
+| Image to Video | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#image-to-video-generation) |
+| i2vgen-xl | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#I2vgen-xl) |
### PyTorch Image Models/TIMM:
| Architecture | Training | Inference | Tasks |
|:--------------------|:--------:|:---------:|:------|
-| FastViT | | Single card | [image classification](https://github.com/huggingface/optimum-habana/tree/main/examples/image-classification) |
+| FastViT | | Single card | [image classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-classification) |
### TRL:
| Architecture | Training | Inference | Tasks |
|:-----------------|:--------:|:--------------------:|:-----------------------------------------------------------------------------------------------|
-| Llama 2 | :heavy_check_mark: | | [DPO Pipeline](https://github.com/huggingface/optimum-habana/tree/main/examples/trl#dpo-pipeline) |
-| Llama 2 | :heavy_check_mark: | | [PPO Pipeline](https://github.com/huggingface/optimum-habana/tree/main/examples/trl#ppo-pipeline) |
-| Stable Diffusion | :heavy_check_mark: | | [DDPO Pipeline](https://github.com/huggingface/optimum-habana/tree/main/examples/trl#ddpo-pipeline) |
+| Llama 2 | :heavy_check_mark: | | [DPO Pipeline](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/trl#dpo-pipeline) |
+| Llama 2 | :heavy_check_mark: | | [PPO Pipeline](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/trl#ppo-pipeline) |
+| Stable Diffusion | :heavy_check_mark: | | [DDPO Pipeline](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/trl#ddpo-pipeline) |
Other models and tasks supported by the Transformers and Diffusers libraries may also work. You can refer to this [section](https://github.com/huggingface/optimum-habana#how-to-use-it)
-for using them with Optimum for Intel Gaudi. In addition, [this page](https://github.com/huggingface/optimum-habana/tree/main/examples) explains how to modify any
-[example](https://github.com/huggingface/transformers/tree/main/examples/pytorch) from the Transformers library to make it work with Optimum for Intel Gaudi.
+for using them with Optimum for Intel Gaudi. In addition, [this page](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples) explains how to modify any
+[example](https://github.com/huggingface/transformers/tree/v1.20-release/examples/pytorch) from the Transformers library to make it work with Optimum for Intel Gaudi.
If you find any issues while using those, please open an issue or a pull request.
@@ -328,8 +328,8 @@ After training your model, feel free to submit it to the Intel [leaderboard](htt
to evaluate, score, and rank open-source LLMs that have been pre-trained or fine-tuned on Intel Hardwares. Models submitted to the leaderboard will be evaluated on
the Intel Developer Cloud. The evaluation platform consists of Gaudi Accelerators and Xeon CPUs running benchmarks from the Eleuther AI Language Model Evaluation Harness.
-The list of validated models through continuous integration tests is posted [here](https://github.com/huggingface/optimum-habana/tree/main/tests/Habana_Validated_Models.md)
+The list of validated models through continuous integration tests is posted [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/tests/Habana_Validated_Models.md)
## Development
-Check the [contributor guide](https://github.com/huggingface/optimum/blob/main/CONTRIBUTING.md) for instructions.
+Check the [contributor guide](https://github.com/huggingface/optimum/blob/v1.20-release/CONTRIBUTING.md) for instructions.
diff --git a/docs/source/index.mdx b/docs/source/index.mdx
index 4aba07b70d..74c7ef4287 100644
--- a/docs/source/index.mdx
+++ b/docs/source/index.mdx
@@ -58,92 +58,92 @@ In the tables below, ✅ means single-card, multi-card and DeepSpeed have all be
| Architecture | Training | Inference | Tasks |
|--------------|:--------:|:---------:|:------|
-| BERT | ✅ | ✅ | [text classification](https://github.com/huggingface/optimum-habana/tree/main/examples/text-classification)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text feature extraction](https://github.com/huggingface/optimum-habana/tree/main/examples/text-feature-extraction) |
-| RoBERTa | ✅ | ✅ | [question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling) |
-| ALBERT | ✅ | ✅ | [question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling) |
-| DistilBERT | ✅ | ✅ | [question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling) |
-| GPT2 | ✅ | ✅ | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| BLOOM(Z) | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| StarCoder / StarCoder2 | ✅ | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| GPT-J | DeepSpeed | Single cardDeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| GPT-Neo | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| GPT-NeoX | DeepSpeed | DeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| OPT | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Llama 2 / CodeLlama / Llama 3 / Llama Guard / Granite | ✅ | ✅ | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)[text classification](https://github.com/huggingface/optimum-habana/tree/main/examples/text-classification) (Llama Guard) |
-| StableLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Falcon | LoRA | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| CodeGen | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| MPT | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Mistral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Phi | ✅ | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Mixtral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Gemma | ✅ | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Gemma2 | | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Qwen2 / Qwen3 | Single card | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Qwen2-MoE | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Persimmon | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| XGLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Cohere | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| T5 / Flan T5 | ✅ | ✅ | [summarization](https://github.com/huggingface/optimum-habana/tree/main/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/main/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering#fine-tuning-t5-on-squad20) |
-| BART | | Single card | [summarization](https://github.com/huggingface/optimum-habana/tree/main/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/main/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering#fine-tuning-t5-on-squad20) |
-| ViT | ✅ | ✅ | [image classification](https://github.com/huggingface/optimum-habana/tree/main/examples/image-classification) |
-| Swin | ✅ | ✅ | [image classification](https://github.com/huggingface/optimum-habana/tree/main/examples/image-classification) |
-| Wav2Vec2 | ✅ | ✅ | [audio classification](https://github.com/huggingface/optimum-habana/tree/main/examples/audio-classification)[speech recognition](https://github.com/huggingface/optimum-habana/tree/main/examples/speech-recognition) |
-| Whisper | ✅ | ✅ | [speech recognition](https://github.com/huggingface/optimum-habana/tree/main/examples/speech-recognition) |
-| SpeechT5 | | Single card | [text to speech](https://github.com/huggingface/optimum-habana/tree/main/examples/text-to-speech) |
-| CLIP | ✅ | ✅ | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/main/examples/contrastive-image-text) |
-| BridgeTower | ✅ | ✅ | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/main/examples/contrastive-image-text) |
-| ESMFold | | Single card | [protein folding](https://github.com/huggingface/optimum-habana/tree/main/examples/protein-folding) |
-| Blip | | Single card | [visual question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/visual-question-answering)[image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| OWLViT | | Single card | [zero shot object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/zero-shot-object-detection) |
-| ClipSeg | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/main/examples/object-segementation) |
-| Llava / Llava-next / Llava-onevision | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| Paligemma | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| idefics2 | LoRA | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| SAM | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/main/examples/object-segementation) |
-| VideoMAE | | Single card | [Video classification](https://github.com/huggingface/optimum-habana/tree/main/examples/video-classification) |
-| TableTransformer | | Single card | [table object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/table-detection) |
-| DETR | | Single card | [object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/object-detection) |
-| Mllama | LoRA |✅ | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| Video-LLaVA | | Single card | [video comprehension](https://github.com/huggingface/optimum-habana/tree/main/examples/video-comprehension) |
-| MiniCPM3 | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Baichuan2 | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| DeepSeek-V2 | ✅ | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| DeepSeek-V3 / Moonlight | | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| ChatGLM | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
-| Qwen2-VL | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| GLM-4V | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text) |
-| Arctic | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) |
+| BERT | ✅ | ✅ | [text classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-classification)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text feature extraction](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-feature-extraction) |
+| RoBERTa | ✅ | ✅ | [question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling) |
+| ALBERT | ✅ | ✅ | [question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling) |
+| DistilBERT | ✅ | ✅ | [question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling) |
+| GPT2 | ✅ | ✅ | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| BLOOM(Z) | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| StarCoder / StarCoder2 | ✅ | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| GPT-J | DeepSpeed | Single cardDeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| GPT-Neo | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| GPT-NeoX | DeepSpeed | DeepSpeed | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| OPT | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Llama 2 / CodeLlama / Llama 3 / Llama Guard / Granite | ✅ | ✅ | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)[text classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-classification) (Llama Guard) |
+| StableLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Falcon | LoRA | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| CodeGen | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| MPT | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Mistral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Phi | ✅ | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Mixtral | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Gemma | ✅ | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Gemma2 | | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Qwen2 / Qwen3 | Single card | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Qwen2-MoE | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Persimmon | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| XGLM | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Cohere | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| T5 / Flan T5 | ✅ | ✅ | [summarization](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering#fine-tuning-t5-on-squad20) |
+| BART | | Single card | [summarization](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/summarization)[translation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/translation)[question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering#fine-tuning-t5-on-squad20) |
+| ViT | ✅ | ✅ | [image classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-classification) |
+| Swin | ✅ | ✅ | [image classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-classification) |
+| Wav2Vec2 | ✅ | ✅ | [audio classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/audio-classification)[speech recognition](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/speech-recognition) |
+| Whisper | ✅ | ✅ | [speech recognition](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/speech-recognition) |
+| SpeechT5 | | Single card | [text to speech](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-to-speech) |
+| CLIP | ✅ | ✅ | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/contrastive-image-text) |
+| BridgeTower | ✅ | ✅ | [contrastive image-text training](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/contrastive-image-text) |
+| ESMFold | | Single card | [protein folding](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/protein-folding) |
+| Blip | | Single card | [visual question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/visual-question-answering)[image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| OWLViT | | Single card | [zero shot object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/zero-shot-object-detection) |
+| ClipSeg | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-segementation) |
+| Llava / Llava-next / Llava-onevision | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| Paligemma | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| idefics2 | LoRA | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| SAM | | Single card | [object segmentation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-segementation) |
+| VideoMAE | | Single card | [Video classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/video-classification) |
+| TableTransformer | | Single card | [table object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/table-detection) |
+| DETR | | Single card | [object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-detection) |
+| Mllama | LoRA |✅ | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| Video-LLaVA | | Single card | [video comprehension](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/video-comprehension) |
+| MiniCPM3 | | Single card | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Baichuan2 | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| DeepSeek-V2 | ✅ | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| DeepSeek-V3 / Moonlight | | ✅ | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| ChatGLM | DeepSpeed | Single card | [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)[text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
+| Qwen2-VL | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| GLM-4V | | Single card | [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text) |
+| Arctic | | DeepSpeed | [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) |
- Diffusers
| Architecture | Training | Inference | Tasks |
|---------------------|:--------:|:---------:|:------|
-| Stable Diffusion | ✅ | ✅ | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) |
-| Stable Diffusion XL | ✅ | ✅ | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) |
-| Stable Diffusion Depth2img | | Single card | [depth-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) |
-| Stable Diffusion 3 | ✅ | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#stable-diffusion-3-and-35-sd3) |
-| LDM3D | | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) |
-| FLUX.1 | LoRA | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) |
-| Text to Video | | Single card | [text-to-video generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#text-to-video-generation) |
-| Image to Video | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#image-to-video-generation) |
-| i2vgen-xl | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion#I2vgen-xl) |
+| Stable Diffusion | ✅ | ✅ | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion) |
+| Stable Diffusion XL | ✅ | ✅ | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion) |
+| Stable Diffusion Depth2img | | Single card | [depth-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion) |
+| Stable Diffusion 3 | ✅ | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#stable-diffusion-3-and-35-sd3) |
+| LDM3D | | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion) |
+| FLUX.1 | LoRA | Single card | [text-to-image generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion) |
+| Text to Video | | Single card | [text-to-video generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#text-to-video-generation) |
+| Image to Video | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#image-to-video-generation) |
+| i2vgen-xl | | Single card | [image-to-video generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion#I2vgen-xl) |
- PyTorch Image Models/TIMM:
| Architecture | Training | Inference | Tasks |
|---------------------|:--------:|:---------:|:------|
-| FastViT | | Single card | [image classification](https://github.com/huggingface/optimum-habana/tree/main/examples/image-classification) |
+| FastViT | | Single card | [image classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-classification) |
- TRL:
| Architecture | Training | Inference | Tasks |
|------------------|:--------:|:--------------------:|:------|
-| Llama 2 | ✅ | | [DPO Pipeline](https://github.com/huggingface/optimum-habana/tree/main/examples/trl) |
-| Llama 2 | ✅ | | [PPO Pipeline](https://github.com/huggingface/optimum-habana/tree/main/examples/trl) |
-| Stable Diffusion | ✅ | | [DDPO Pipeline](https://github.com/huggingface/optimum-habana/tree/main/examples/trl) |
+| Llama 2 | ✅ | | [DPO Pipeline](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/trl) |
+| Llama 2 | ✅ | | [PPO Pipeline](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/trl) |
+| Stable Diffusion | ✅ | | [DDPO Pipeline](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/trl) |
Other models and tasks supported by the 🤗 Transformers and 🤗 Diffusers library may also work.
You can refer to this [section](https://github.com/huggingface/optimum-habana#how-to-use-it) for using them with 🤗 Optimum for Intel Gaudi.
-In addition, [this page](https://github.com/huggingface/optimum-habana/tree/main/examples) explains how to modify any [example](https://github.com/huggingface/transformers/tree/main/examples/pytorch) from the 🤗 Transformers library to make it work with 🤗 Optimum for Intel Gaudi.
+In addition, [this page](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples) explains how to modify any [example](https://github.com/huggingface/transformers/tree/v1.20-release/examples/pytorch) from the 🤗 Transformers library to make it work with 🤗 Optimum for Intel Gaudi.
diff --git a/docs/source/package_reference/trainer.mdx b/docs/source/package_reference/trainer.mdx
index 740038cee8..69cdc11797 100644
--- a/docs/source/package_reference/trainer.mdx
+++ b/docs/source/package_reference/trainer.mdx
@@ -16,7 +16,7 @@ limitations under the License.
# GaudiTrainer
-The [`GaudiTrainer`](https://huggingface.co/docs/optimum/habana/package_reference/trainer#optimum.habana.GaudiTrainer) class provides an extended API for the feature-complete [Transformers Trainer](https://huggingface.co/docs/transformers/main_classes/trainer). It is used in all the [example scripts](https://github.com/huggingface/optimum-habana/tree/main/examples).
+The [`GaudiTrainer`](https://huggingface.co/docs/optimum/habana/package_reference/trainer#optimum.habana.GaudiTrainer) class provides an extended API for the feature-complete [Transformers Trainer](https://huggingface.co/docs/transformers/main_classes/trainer). It is used in all the [example scripts](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples).
Before instantiating your [`GaudiTrainer`](https://huggingface.co/docs/optimum/habana/package_reference/trainer#optimum.habana.GaudiTrainer), create a [`GaudiTrainingArguments`] object to access all the points of customization during training.
diff --git a/docs/source/quickstart.mdx b/docs/source/quickstart.mdx
index 1c3ec01d3a..91001247d8 100644
--- a/docs/source/quickstart.mdx
+++ b/docs/source/quickstart.mdx
@@ -73,9 +73,9 @@ git clone -b v1.19.0 https://github.com/huggingface/optimum-habana
pip install ./optimum-habana
```
-All available examples are under [optimum-habana/examples](https://github.com/huggingface/optimum-habana/tree/main/examples).
+All available examples are under [optimum-habana/examples](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples).
-Here is [text-generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) example,
+Here is [text-generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) example,
to run Llama-2 7B text generation example on Gaudi, complete the prerequisite setup:
```bash
cd ~/optimum-habana/examples/text-generation
@@ -136,7 +136,7 @@ run_generation.py \
🤗 Optimum for Intel Gaudi contains a number of examples demonstrating single and multi Gaudi device training/fine-tuning.
For example, a number of language models can be trained with the scripts provided
-[language modeling examples section](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling).
+[language modeling examples section](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling).
As an illustration, let us run GPT-2 single and multi card training examples on Gaudi.
@@ -240,7 +240,7 @@ outputs = pipeline(
```
In addition, sample scripts for fine-tuning diffusion models are given in
-[Stable Diffusion training section](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion/training).
+[Stable Diffusion training section](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion/training).
A more comprehensive list of examples in Optimum for Intel Gaudi is given next.
@@ -253,37 +253,37 @@ to see more options for running inference.
Here are examples for various modalities and tasks that can be used out of the box:
- **Text**
- - [language modeling](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling)
- - [multi node training](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training)
- - [protein folding](https://github.com/huggingface/optimum-habana/tree/main/examples/protein-folding)
- - [question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/question-answering)
- - [sentence transformers training](https://github.com/huggingface/optimum-habana/tree/main/examples/sentence-transformers-training)
- - [summarization](https://github.com/huggingface/optimum-habana/tree/main/examples/summarization)
- - [table detection](https://github.com/huggingface/optimum-habana/tree/main/examples/table-detection)
- - [text classification](https://github.com/huggingface/optimum-habana/tree/main/examples/text-classification)
- - [text feature extraction](https://github.com/huggingface/optimum-habana/tree/main/examples/text-feature-extraction)
- - [text generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation)
- - [translation](https://github.com/huggingface/optimum-habana/tree/main/examples/translation)
- - [trl](https://github.com/huggingface/optimum-habana/tree/main/examples/trl)
+ - [language modeling](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling)
+ - [multi node training](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training)
+ - [protein folding](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/protein-folding)
+ - [question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/question-answering)
+ - [sentence transformers training](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/sentence-transformers-training)
+ - [summarization](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/summarization)
+ - [table detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/table-detection)
+ - [text classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-classification)
+ - [text feature extraction](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-feature-extraction)
+ - [text generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation)
+ - [translation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/translation)
+ - [trl](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/trl)
- **Audio**
- - [audio classification](https://github.com/huggingface/optimum-habana/tree/main/examples/audio-classification)
- - [speech recognition](https://github.com/huggingface/optimum-habana/tree/main/examples/speech-recognition)
- - [text to speech](https://github.com/huggingface/optimum-habana/tree/main/examples/text-to-speech)
+ - [audio classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/audio-classification)
+ - [speech recognition](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/speech-recognition)
+ - [text to speech](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-to-speech)
- **Images**
- - [object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/object-detection)
- - [object segementation](https://github.com/huggingface/optimum-habana/tree/main/examples/object-segementation)
- - [image classification](https://github.com/huggingface/optimum-habana/tree/main/examples/image-classification)
- - [image to text](https://github.com/huggingface/optimum-habana/tree/main/examples/image-to-text)
- - [contrastive image text](https://github.com/huggingface/optimum-habana/tree/main/examples/contrastive-image-text)
- - [stable diffusion](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion)
- - [visual question answering](https://github.com/huggingface/optimum-habana/tree/main/examples/visual-question-answering)
- - [zero-shot object detection](https://github.com/huggingface/optimum-habana/tree/main/examples/zero-shot-object-detection)
+ - [object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-detection)
+ - [object segementation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/object-segementation)
+ - [image classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-classification)
+ - [image to text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/image-to-text)
+ - [contrastive image text](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/contrastive-image-text)
+ - [stable diffusion](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion)
+ - [visual question answering](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/visual-question-answering)
+ - [zero-shot object detection](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/zero-shot-object-detection)
- **Video**
- - [stable-video-diffusion](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion)
- - [video-classification](https://github.com/huggingface/optimum-habana/tree/main/examples/video-classification)
+ - [stable-video-diffusion](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion)
+ - [video-classification](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/video-classification)
To learn more about how to adapt 🤗 Transformers or Diffusers scripts for Intel Gaudi, check out
[Script Adaptation](https://huggingface.co/docs/optimum/habana/usage_guides/script_adaptation) guide.
diff --git a/docs/source/tutorials/distributed.mdx b/docs/source/tutorials/distributed.mdx
index f664ab4e14..c6624ae144 100644
--- a/docs/source/tutorials/distributed.mdx
+++ b/docs/source/tutorials/distributed.mdx
@@ -18,10 +18,10 @@ limitations under the License.
As models get bigger, parallelism has emerged as a strategy for training larger models on limited hardware and accelerating training speed by several orders of magnitude.
-All the [PyTorch examples](https://github.com/huggingface/optimum-habana/tree/main/examples) and the `GaudiTrainer` script work out of the box with distributed training.
+All the [PyTorch examples](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples) and the `GaudiTrainer` script work out of the box with distributed training.
There are two ways of launching them:
-1. Using the [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/main/examples/gaudi_spawn.py) script:
+1. Using the [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/gaudi_spawn.py) script:
- Use MPI for distributed training:
@@ -32,7 +32,7 @@ There are two ways of launching them:
```
where `--argX` is an argument of the script to run in a distributed way.
- Examples are given for question answering [here](https://github.com/huggingface/optimum-habana/blob/main/examples/question-answering/README.md#multi-card-training) and text classification [here](https://github.com/huggingface/optimum-habana/tree/main/examples/text-classification#multi-card-training).
+ Examples are given for question answering [here](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/question-answering/README.md#multi-card-training) and text classification [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-classification#multi-card-training).
- Use DeepSpeed for distributed training:
@@ -43,7 +43,7 @@ There are two ways of launching them:
```
where `--argX` is an argument of the script to run in a distributed way.
- Examples are given for question answering [here](https://github.com/huggingface/optimum-habana/blob/main/examples/question-answering/README.md#using-deepspeed) and text classification [here](https://github.com/huggingface/optimum-habana/tree/main/examples/text-classification#using-deepspeed).
+ Examples are given for question answering [here](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/question-answering/README.md#using-deepspeed) and text classification [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-classification#using-deepspeed).
2. Using the `DistributedRunner` directly in code:
diff --git a/docs/source/tutorials/inference.mdx b/docs/source/tutorials/inference.mdx
index 309fe54191..71023c88c4 100644
--- a/docs/source/tutorials/inference.mdx
+++ b/docs/source/tutorials/inference.mdx
@@ -22,7 +22,7 @@ An effective quick start would be to review the inference examples provided in t
[here].
You can also explore the
-[examples in the Optimum for Intel Gaudi repository]((https://github.com/huggingface/optimum-habana/tree/main/examples)).
+[examples in the Optimum for Intel Gaudi repository]((https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples)).
While the examples folder includes both training and inference, the inference-specific content
provides valuable guidance for optimizing and running workloads on Intel Gaudi accelerators.
@@ -64,7 +64,7 @@ The variable `my_args` should contain some inference-specific arguments, you can
## In our Examples
-All [our examples](https://github.com/huggingface/optimum-habana/tree/main/examples) contain instructions for running inference with a given model on a given dataset.
+All [our examples](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples) contain instructions for running inference with a given model on a given dataset.
The reasoning is the same for every example: run the example script with `--do_eval` and `--per_device_eval_batch_size` and without `--do_train`.
A simple template is the following:
```bash
diff --git a/docs/source/tutorials/stable_diffusion.mdx b/docs/source/tutorials/stable_diffusion.mdx
index 574b7bbc25..0c249dd045 100644
--- a/docs/source/tutorials/stable_diffusion.mdx
+++ b/docs/source/tutorials/stable_diffusion.mdx
@@ -60,7 +60,7 @@ Generated images can be returned as either PIL images or NumPy arrays, depending
-Check out the [example](https://github.com/huggingface/optimum-habana/tree/main/examples/stable-diffusion) provided in the official Github repository.
+Check out the [example](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/stable-diffusion) provided in the official Github repository.
@@ -179,4 +179,4 @@ pipeline = GaudiStableDiffusionPipeline.from_pretrained(
[Textual Inversion](https://arxiv.org/abs/2208.01618) is a method to personalize text2image models like Stable Diffusion on your own images using just 3-5 examples.
-You can find [here](https://github.com/huggingface/optimum-habana/blob/main/examples/stable-diffusion/textual_inversion.py) an example script that implements this training method.
+You can find [here](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/stable-diffusion/textual_inversion.py) an example script that implements this training method.
diff --git a/docs/source/usage_guides/deepspeed.mdx b/docs/source/usage_guides/deepspeed.mdx
index 40cd670383..04c9085240 100644
--- a/docs/source/usage_guides/deepspeed.mdx
+++ b/docs/source/usage_guides/deepspeed.mdx
@@ -105,7 +105,7 @@ This argument both indicates that DeepSpeed should be used and points to your De
Finally, there are two possible ways to launch your script:
-1. Using the [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/main/examples/gaudi_spawn.py) script:
+1. Using the [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/gaudi_spawn.py) script:
```bash
python gaudi_spawn.py \
diff --git a/docs/source/usage_guides/multi_node_training.mdx b/docs/source/usage_guides/multi_node_training.mdx
index 9b49ccda10..ebd342f520 100644
--- a/docs/source/usage_guides/multi_node_training.mdx
+++ b/docs/source/usage_guides/multi_node_training.mdx
@@ -46,7 +46,7 @@ Once your Intel Gaudi instances are ready, follow the steps for [setting up a mu
Finally, there are two possible ways to run your training script on several nodes:
-1. With the [`gaudi_spawn.py`](https://github.com/huggingface/optimum-habana/blob/main/examples/gaudi_spawn.py) script, you can run the following command:
+1. With the [`gaudi_spawn.py`](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/gaudi_spawn.py) script, you can run the following command:
```bash
python gaudi_spawn.py \
--hostfile path_to_my_hostfile --use_deepspeed \
@@ -79,7 +79,7 @@ env_variable_2_name=value
## Recommendations
-- It is strongly recommended to use gradient checkpointing for multi-node runs to get the highest speedups. You can enable it with `--gradient_checkpointing` in [these examples](https://github.com/huggingface/optimum-habana/tree/main/examples) or with `gradient_checkpointing=True` in your `GaudiTrainingArguments`.
+- It is strongly recommended to use gradient checkpointing for multi-node runs to get the highest speedups. You can enable it with `--gradient_checkpointing` in [these examples](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples) or with `gradient_checkpointing=True` in your `GaudiTrainingArguments`.
- Larger batch sizes should lead to higher speedups.
- Multi-node inference is not recommended and can provide inconsistent results.
- On Intel Tiber AI Cloud instances, run your Docker containers with the `--privileged` flag so that EFA devices are visible.
@@ -88,7 +88,7 @@ env_variable_2_name=value
## Example
In this example, we fine-tune a pre-trained GPT2-XL model on the [WikiText dataset](https://huggingface.co/datasets/wikitext).
-We are going to use the [causal language modeling example which is given in the Github repository](https://github.com/huggingface/optimum-habana/tree/main/examples/language-modeling#gpt-2gpt-and-causal-language-modeling).
+We are going to use the [causal language modeling example which is given in the Github repository](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/language-modeling#gpt-2gpt-and-causal-language-modeling).
The first step consists in training the model on several nodes with this command:
```bash
diff --git a/docs/source/usage_guides/quantization.mdx b/docs/source/usage_guides/quantization.mdx
index a22cc1a9c8..65f766f165 100644
--- a/docs/source/usage_guides/quantization.mdx
+++ b/docs/source/usage_guides/quantization.mdx
@@ -17,7 +17,7 @@ limitations under the License.
# Quantization
Intel® Gaudi® offers several possibilities to make inference faster. For examples of FP8 and UINT4 for Inference, see the
-[text-generation](https://github.com/huggingface/optimum-habana/tree/main/examples/text-generation) example.
+[text-generation](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/text-generation) example.
This guide provides the steps required to enable FP8 and UINT4 precision on your Intel® Gaudi® AI
accelerator using the Intel® Neural Compressor (INC) package.
diff --git a/examples/README.md b/examples/README.md
index 9b4a65f31d..76c101a921 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -17,7 +17,7 @@ limitations under the License.
This folder contains actively maintained examples of use of 🤗 Optimum Habana for various ML tasks.
-Other [examples](https://github.com/huggingface/transformers/tree/main/examples/pytorch) from the 🤗 Transformers library can be adapted the same way to enable deployment on Gaudi processors. This simply consists in:
+Other [examples](https://github.com/huggingface/transformers/tree/v1.20-release/examples/pytorch) from the 🤗 Transformers library can be adapted the same way to enable deployment on Gaudi processors. This simply consists in:
- replacing the `Trainer` from 🤗 Transformers with the `GaudiTrainer` from 🤗 Optimum Habana,
- replacing the `TrainingArguments` from 🤗 Transformers with the `GaudiTrainingArguments` from 🤗 Optimum Habana.
@@ -70,7 +70,7 @@ ip_2 slots=8
ip_n slots=8
```
-You can find more information about multi-node training in the [documentation](https://huggingface.co/docs/optimum/habana/usage_guides/multi_node_training) and in the [`multi-node-training`](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training) folder where a Dockerfile is provided to easily set up your environment.
+You can find more information about multi-node training in the [documentation](https://huggingface.co/docs/optimum/habana/usage_guides/multi_node_training) and in the [`multi-node-training`](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training) folder where a Dockerfile is provided to easily set up your environment.
## Loading from a Tensorflow/Flax checkpoint file instead of a PyTorch model
diff --git a/examples/contrastive-image-text/README.md b/examples/contrastive-image-text/README.md
index f69ac8c8f9..881757a33a 100644
--- a/examples/contrastive-image-text/README.md
+++ b/examples/contrastive-image-text/README.md
@@ -164,7 +164,7 @@ python3 ../gaudi_spawn.py --world_size 8 --use_mpi run_clip.py \
### DeepSpeed
-You can check the [DeepSpeed](https://github.com/huggingface/optimum-habana/tree/main/examples#deepspeed) section in Optimum Habana examples for how to run DeepSpeed.
+You can check the [DeepSpeed](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples#deepspeed) section in Optimum Habana examples for how to run DeepSpeed.
You can also look at the [documentation](https://huggingface.co/docs/optimum/habana/usage_guides/deepspeed) for more information about how to use DeepSpeed in Optimum Habana.
diff --git a/examples/image-to-text/README.md b/examples/image-to-text/README.md
index 2cb8532c70..97139907a5 100644
--- a/examples/image-to-text/README.md
+++ b/examples/image-to-text/README.md
@@ -17,7 +17,7 @@ limitations under the License.
# Image to Text Examples
This directory contains a script that showcases how to perform image to text generation on Intel® Gaudi® AI Accelerators.
-Habana FusedSDPA is a fused and optimized implementation of torch.nn.functional.scaled_dot_product_attention() for Gaudi. For more details, refer to [Gaudi online documentation](https://docs.habana.ai/en/latest/PyTorch/Model_Optimization_PyTorch/Optimization_in_PyTorch_Models.html?highlight=fusedsdpa#using-fused-scaled-dot-product-attention-fusedsdpa). We optimized many models with FusedSDPA implementation as in [optimum/habana/transformers/models](https://github.com/huggingface/optimum-habana/tree/main/optimum/habana/transformers/models). If a model is not optimized with FusedSDPA, it uses [SDPA implementation](https://pytorch.org/docs/stable/generated/torch.nn.functional.scaled_dot_product_attention.html).
+Habana FusedSDPA is a fused and optimized implementation of torch.nn.functional.scaled_dot_product_attention() for Gaudi. For more details, refer to [Gaudi online documentation](https://docs.habana.ai/en/latest/PyTorch/Model_Optimization_PyTorch/Optimization_in_PyTorch_Models.html?highlight=fusedsdpa#using-fused-scaled-dot-product-attention-fusedsdpa). We optimized many models with FusedSDPA implementation as in [optimum/habana/transformers/models](https://github.com/huggingface/optimum-habana/tree/v1.20-release/optimum/habana/transformers/models). If a model is not optimized with FusedSDPA, it uses [SDPA implementation](https://pytorch.org/docs/stable/generated/torch.nn.functional.scaled_dot_product_attention.html).
## Inference with mixed-precision (BF16)
diff --git a/examples/language-modeling/README.md b/examples/language-modeling/README.md
index 6db5d4f5ca..1895a81a60 100644
--- a/examples/language-modeling/README.md
+++ b/examples/language-modeling/README.md
@@ -128,7 +128,7 @@ PT_HPU_LAZY_MODE=1 python ../gaudi_spawn.py \
--deepspeed path_for_deepspeed_config
```
-This example has been validated with the following DeepSpeed ZeRO-2 config: https://github.com/huggingface/optimum-habana/blob/main/tests/configs/deepspeed_zero_2.json
+This example has been validated with the following DeepSpeed ZeRO-2 config: https://github.com/huggingface/optimum-habana/blob/v1.20-release/tests/configs/deepspeed_zero_2.json
## Multi-Node Training with Deepspeed (GPT-NeoX)
@@ -140,7 +140,7 @@ It reaches a perplexity of 10.469.
> [!NOTE]
> For GPT-NeoX-20B model, please switch to jemalloc in case of host OOM issues using ``` export LD_PRELOAD=/libjemalloc.so.2 ```
-> Please refer to [this page](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training) for performing multi-node training properly.
+> Please refer to [this page](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training) for performing multi-node training properly.
```bash
PT_HPU_LAZY_MODE=1 python ../gaudi_spawn.py \
@@ -162,7 +162,7 @@ PT_HPU_LAZY_MODE=1 python ../gaudi_spawn.py \
--deepspeed path_for_deepspeed_config
```
-This example has been validated with the following DeepSpeed ZeRO-2 config: https://github.com/huggingface/optimum-habana/blob/main/tests/configs/deepspeed_zero_2.json
+This example has been validated with the following DeepSpeed ZeRO-2 config: https://github.com/huggingface/optimum-habana/blob/v1.20-release/tests/configs/deepspeed_zero_2.json
## RoBERTa/BERT/DistilBERT and masked language modeling
diff --git a/examples/multi-node-training/README.md b/examples/multi-node-training/README.md
index bc0ba8fda0..a6e98f1404 100644
--- a/examples/multi-node-training/README.md
+++ b/examples/multi-node-training/README.md
@@ -30,8 +30,8 @@ where `--argX` is an argument of the script to run.
Check out the [documentation](https://huggingface.co/docs/optimum/habana/usage_guides/multi_node_training) to know how to set up your Gaudi instances for multi-node runs on premises or on AWS.
We provide two `Dockerfile` to easily start your multi-node runs:
-- A `Dockerfile` provided [here](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training/EFA/Dockerfile) for multi-node runs on AWS.
-- A `Dockerfile` provided [here](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training/GaudiNIC/Dockerfile) for multi-node runs using GaudiNIC.
+- A `Dockerfile` provided [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training/EFA/Dockerfile) for multi-node runs on AWS.
+- A `Dockerfile` provided [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training/GaudiNIC/Dockerfile) for multi-node runs using GaudiNIC.
The Dockerfile is based on an image compatible with Ubuntu 22.04 but you can easily adapt it to another OS.
@@ -99,7 +99,7 @@ ip_2 slots=8
ip_n slots=8
```
-You can find a template [here](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training/hostfile).
+You can find a template [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training/hostfile).
## Environment variables
@@ -111,11 +111,11 @@ env_variable_2_name=value
...
```
-You can find an example for GaudiNIC instances [here](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training/GaudiNIC/.deepspeed_env).
+You can find an example for GaudiNIC instances [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training/GaudiNIC/.deepspeed_env).
> Note above environment variables refers to /etc/profile.d/habanalabs.sh inside docker, and should set only on GaudiNIC master node.
-You can find an example for AWS instances [here](https://github.com/huggingface/optimum-habana/tree/main/examples/multi-node-training/EFA/.deepspeed_env).
+You can find an example for AWS instances [here](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/multi-node-training/EFA/.deepspeed_env).
> Note that one should set `HCCL_OVER_OFI=1` and `LD_LIBRARY_PATH=/root/hccl_ofi_wrapper:/opt/amazon/openmpi/lib:/opt/amazon/efa/lib` only on AWS DL1 instances. *These should not be used otherwise*.
diff --git a/examples/sentence-transformers-training/README.md b/examples/sentence-transformers-training/README.md
index 8936d91abf..a8265d3bbe 100644
--- a/examples/sentence-transformers-training/README.md
+++ b/examples/sentence-transformers-training/README.md
@@ -2,11 +2,11 @@
We provide 3 examples to show how to use Sentence Transformers with HPU devices.
-- **[training_stsbenchmark.py](https://github.com/huggingface/optimum-habana/tree/main/examples/sentence-transformers-training/sts)** - This example shows how to create a Sentence Transformers model from scratch by using a pre-trained transformer model (e.g. [`distilbert-base-uncased`](https://huggingface.co/distilbert/distilbert-base-uncased)) together with a pooling layer.
+- **[training_stsbenchmark.py](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/sentence-transformers-training/sts)** - This example shows how to create a Sentence Transformers model from scratch by using a pre-trained transformer model (e.g. [`distilbert-base-uncased`](https://huggingface.co/distilbert/distilbert-base-uncased)) together with a pooling layer.
-- **[training_nli.py](https://github.com/huggingface/optimum-habana/tree/main/examples/sentence-transformers-training/nli)** - This example provides two sentences (a premise and a hypothesis), and the task of Natural Language Inference (NLI) is to determine whether the premise entails the hypothesis, contradicts it, or if they are neutral. Commonly the NLI dataset in [SNLI](https://huggingface.co/datasets/stanfordnlp/snli) and [MultiNLI](https://huggingface.co/datasets/nyu-mll/multi_nli) are used.
+- **[training_nli.py](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/sentence-transformers-training/nli)** - This example provides two sentences (a premise and a hypothesis), and the task of Natural Language Inference (NLI) is to determine whether the premise entails the hypothesis, contradicts it, or if they are neutral. Commonly the NLI dataset in [SNLI](https://huggingface.co/datasets/stanfordnlp/snli) and [MultiNLI](https://huggingface.co/datasets/nyu-mll/multi_nli) are used.
-- **[training_paraphrases.py](https://github.com/huggingface/optimum-habana/tree/main/examples/sentence-transformers-training/paraphrases)** - This example loads various datasets from Sentence Transformers. We construct batches by sampling examples from the respective dataset.
+- **[training_paraphrases.py](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/sentence-transformers-training/paraphrases)** - This example loads various datasets from Sentence Transformers. We construct batches by sampling examples from the respective dataset.
### Tested Examples/Models and Configurations
diff --git a/examples/sentence-transformers-training/nli/README.md b/examples/sentence-transformers-training/nli/README.md
index d59fc7b03b..3b9d4e7d5e 100644
--- a/examples/sentence-transformers-training/nli/README.md
+++ b/examples/sentence-transformers-training/nli/README.md
@@ -50,7 +50,7 @@ If you want to save the checkpoints for the model you need using `--saving_model
## Multi-card Training
-For multi-card training you can use the script of [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/main/examples/gaudi_spawn.py) to execute. There are two options to run the multi-card training by using '--use_deepspeed' or '--use_mpi'. We take the option of '--use_deepspeed' for our example of multi-card training.
+For multi-card training you can use the script of [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/gaudi_spawn.py) to execute. There are two options to run the multi-card training by using '--use_deepspeed' or '--use_mpi'. We take the option of '--use_deepspeed' for our example of multi-card training.
```bash
HABANA_VISIBLE_MODULES="2,3" PT_HPU_LAZY_MODE=1 python ../../gaudi_spawn.py --use_deepspeed --world_size 2 training_nli.py bert-base-uncased
diff --git a/examples/sentence-transformers-training/sts/README.md b/examples/sentence-transformers-training/sts/README.md
index 7c6e27536c..1838219802 100644
--- a/examples/sentence-transformers-training/sts/README.md
+++ b/examples/sentence-transformers-training/sts/README.md
@@ -37,7 +37,7 @@ If you want to save the checkpoints for training model you need using `--saving_
## Multi-card Training
-For multi-card training you can use the script of [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/main/examples/gaudi_spawn.py) to execute. There are two options to run the multi-card training by using '--use_deepspeed' or '--use_mpi'. We take the option of '--use_deepspeed' for our example of multi-card training.
+For multi-card training you can use the script of [gaudi_spawn.py](https://github.com/huggingface/optimum-habana/blob/v1.20-release/examples/gaudi_spawn.py) to execute. There are two options to run the multi-card training by using '--use_deepspeed' or '--use_mpi'. We take the option of '--use_deepspeed' for our example of multi-card training.
```bash
HABANA_VISIBLE_MODULES="2,3" PT_HPU_LAZY_MODE=1 python ../../gaudi_spawn.py --use_deepspeed --world_size 2 training_stsbenchmark.py bert-base-uncased
diff --git a/examples/speech-recognition/README.md b/examples/speech-recognition/README.md
index 69625cc0ab..6453bd3779 100644
--- a/examples/speech-recognition/README.md
+++ b/examples/speech-recognition/README.md
@@ -42,11 +42,11 @@ pip install -r requirements.txt
## Connectionist Temporal Classification
-The script [`run_speech_recognition_ctc.py`](https://github.com/huggingface/optimum-habana/tree/main/examples/speech-recognition/run_speech_recognition_ctc.py) can be used to fine-tune any pretrained [Connectionist Temporal Classification Model](https://huggingface.co/docs/transformers/main/en/model_doc/auto#transformers.AutoModelForCTC) for automatic speech recognition on one of the [official speech recognition datasets](https://huggingface.co/datasets?task_ids=task_ids:automatic-speech-recognition) or a custom dataset.
+The script [`run_speech_recognition_ctc.py`](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/speech-recognition/run_speech_recognition_ctc.py) can be used to fine-tune any pretrained [Connectionist Temporal Classification Model](https://huggingface.co/docs/transformers/main/en/model_doc/auto#transformers.AutoModelForCTC) for automatic speech recognition on one of the [official speech recognition datasets](https://huggingface.co/datasets?task_ids=task_ids:automatic-speech-recognition) or a custom dataset.
Speech recognition models that have been pretrained in an unsupervised fashion on audio data alone, *e.g.* [Wav2Vec2](https://huggingface.co/transformers/main/model_doc/wav2vec2.html), have shown to require only very little annotated data to yield good performance on automatic speech recognition datasets.
-In the script [`run_speech_recognition_ctc`](https://github.com/huggingface/optimum-habana/tree/main/examples/speech-recognition/run_speech_recognition_ctc.py), we first create a vocabulary from all unique characters of both the training data and evaluation data. Then, we preprocess the speech recognition dataset, which includes correct resampling, normalization and padding. Finally, the pretrained speech recognition model is fine-tuned on the annotated speech recognition datasets using CTC loss.
+In the script [`run_speech_recognition_ctc`](https://github.com/huggingface/optimum-habana/tree/v1.20-release/examples/speech-recognition/run_speech_recognition_ctc.py), we first create a vocabulary from all unique characters of both the training data and evaluation data. Then, we preprocess the speech recognition dataset, which includes correct resampling, normalization and padding. Finally, the pretrained speech recognition model is fine-tuned on the annotated speech recognition datasets using CTC loss.