Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Optimum-Habana docs re-org #1488

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

dsocek
Copy link
Contributor

@dsocek dsocek commented Nov 14, 2024

Hugging Face Gaudi Documentation Update

Comprehensive update to HF Gaudi docs

@dsocek dsocek requested a review from regisss as a code owner November 14, 2024 20:31
Signed-off-by: Daniel Socek <[email protected]>
Co-authored-by: Greg Serochi <[email protected]>
Co-authored-by: Kiangpeng Lau <[email protected]>
Co-authored-by: Seethong Vang <[email protected]>
@@ -32,20 +34,8 @@
title: How to use DeepSpeed
- local: usage_guides/multi_node_training
title: Multi-node Training
- local: usage_guides/quantization
title: Quantization
Copy link
Collaborator

Choose a reason for hiding this comment

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

why do we change this way?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

see answer below

<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./package_reference/trainer"
><div class="w-full text-center bg-gradient-to-br from-purple-400 to-purple-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Reference</div>
<p class="text-gray-700">Technical descriptions of how the Habana classes and methods of 🤗 Optimum Habana work.</p>
</a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

why this is removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@libinta , please note this new, simplified organization was suggested by Greg. As for why, I believe the intension was to simplify and reduce number of sections

# DistributedRunner

[[autodoc]] distributed.distributed_runner.DistributedRunner
- all
Copy link
Collaborator

Choose a reason for hiding this comment

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

why removed this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See Greg's vision plan below

The `GaudiDDPMPipeline` is to enable unconditional image generations on HPUs. It has similar APIs as the regular `DiffusionPipeline`.
It shares a common parent class, `GaudiDiffusionPipeline`, with other existing Gaudi pipelines. It now supports both DDPM and DDIM scheduler.
It is recommended to use the optimized scheduler, `GaudiDDIMScheduler`, to obtain the best performance and image outputs.

Copy link
Collaborator

Choose a reason for hiding this comment

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

why remove this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Greg suggested to upgrade to SDXL as SD is kind of old model now. We can keep too, it may be a good intro diffuser model.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kplau1128 can you comment here?

Copy link
Contributor

@kplau1128 kplau1128 Nov 15, 2024

Choose a reason for hiding this comment

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

Greq was requested and suggested consolidate SD into one tutorials/stable_diffusion.mdx, and remove others

## GaudiSeq2SeqTrainingArguments

[[autodoc]] transformers.training_args_seq2seq.GaudiSeq2SeqTrainingArguments
- all
Copy link
Collaborator

Choose a reason for hiding this comment

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

why removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Greg's vision of new doc org:
image

```

where `gaudi_config_name` is the name of a model from the [Hub](https://huggingface.co/Habana) (Gaudi configurations are stored in model repositories) or a path to a local Gaudi configuration file (you can see [here](./package_reference/gaudi_config) how to write your own).
where `gaudi_config_name` is the name of a model from the [Hub](https://huggingface.co/Habana) (Gaudi configurations are stored in model repositories)
Copy link
Collaborator

Choose a reason for hiding this comment

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

why do we talk about gaudi_config_name here? it seems we are talking about docker before.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This out of place. Good catch. Probably leftover from previous content.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. This is out of place, probably leftover from previous content

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants