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

✏️ docs: Add training guide and improve documentation consistency #110

Merged
merged 4 commits into from
Oct 24, 2024

Conversation

baptistecolle
Copy link
Collaborator

📝 Enhance documentation clarity and structure: Add comprehensive training guide and fix inconsistencies

Overview

This PR addresses several documentation issues and improvements:

  1. Adds a new training documentation page for the huggingface docs website
  • This was previsouly missing and not up to date with the repo
  1. Resolves documentation inconsistencies

Motivation

Our documentation needed more clarity and structure around training capabilities, while some sections had inconsistent or incomplete information that could confuse users.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@baptistecolle baptistecolle marked this pull request as draft October 24, 2024 11:05
Copy link
Collaborator

@tengomucho tengomucho left a comment

Choose a reason for hiding this comment

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

Thanks for your first contribution on the project! 🥳 Few nits and we can merge.

.gitignore Outdated
jetstream-pt-deps
wip/
Copy link
Collaborator

Choose a reason for hiding this comment

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

you can remove the wip here

README.md Outdated
## Inference

`optimum-tpu` provides a set of dedicated tools and integrations in order to leverage Cloud TPUs for inference, especially
on the latest TPU version `v5e`.
on the latest TPU version `v5`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

it is actually called v5e, see https://cloud.google.com/tpu/docs/v5e

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There is also v5p that's why i wanted to say v5 directly, but with #108 this sentence is actually removed to make it more general

Copy link
Collaborator

Choose a reason for hiding this comment

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

In theory we could support v5p, but we haven't done any testing on that platform yet. You can remove the sentence as done on #108 and they will rebase later.

README.md Outdated
Comment on lines 75 to 77
### Optimum-TPU with JAX

JAX is coming very soon - stay tuned!
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think there is no need to add this

@baptistecolle
Copy link
Collaborator Author

baptistecolle commented Oct 24, 2024

@tengomucho Based on #108, it seems we should also make the documentation less v5-specific. Should we update it now or keep it as it is?

@baptistecolle baptistecolle marked this pull request as ready for review October 24, 2024 12:59
@tengomucho tengomucho merged commit 77f8f97 into main Oct 24, 2024
2 checks passed
@tengomucho tengomucho deleted the fix-documentation branch October 24, 2024 13:03
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