-
Notifications
You must be signed in to change notification settings - Fork 24
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
Conversation
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your first contribution on the project! 🥳 Few nits and we can merge.
.gitignore
Outdated
jetstream-pt-deps | ||
wip/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is actually called v5e
, see https://cloud.google.com/tpu/docs/v5e
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
### Optimum-TPU with JAX | ||
|
||
JAX is coming very soon - stay tuned! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there is no need to add this
@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? |
📝 Enhance documentation clarity and structure: Add comprehensive training guide and fix inconsistencies
Overview
This PR addresses several documentation issues and improvements:
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