-
Notifications
You must be signed in to change notification settings - Fork 27.1k
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
Improve performance docs #17750
Improve performance docs #17750
Conversation
The documentation is not available anymore as the PR was closed or merged. |
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 working on this. Could we add at least one line in each of those files telling the reader "Coming soon"?
Definitely yes for grouping all of those guides in one subsection, like the Tasks one.
Sounds good @sgugger, I added the "Coming soon" and restructured the ToC. |
Communications are difficult. what I proposed is to add normal documents - not "Coming Soon" inside those documents they should all explicitly point the user to read the first document that is already filled out and that we will expand this other currently mostly empty doc with the missing material. In other words e.g,, perf_infer_gpu_many.mdx should have:
If the docs remain "Coming Soon" nobody will read them and will miss out on the already rich performance docs we have. And the impetus for this change was that we went from a complete solution - all performance notes in one doc, to very incomplete solution, making it look like we only have advise for those with 1 gpu and doing training. The original discussion back in winter was that all performance docs will be filled out, but it was dropped after the first document and no signs of new docs coming any time soon. So this proposal was my attempt to rescue the situation. |
docs/source/en/_toctree.yml
Outdated
title: Inference on Specialized Hardware | ||
- local: perf_hardware | ||
title: Custom hardware for training | ||
title: Performance anc scalability |
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.
Typo ? :)
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.
Indeed, thanks!
Ok I added references to each document and a small text explaining what will come there. Is that what you had in mind @stas00? |
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.
With a few suggestions to fix this looks good.
In particular I added pointers to 1-gpu train from infer docs since most of it applies and the current infer files are almost empty and don't have the essentials.
Co-authored-by: Stas Bekman <[email protected]>
Co-authored-by: Stas Bekman <[email protected]>
* add skeleton files * fix cpu inference link * add hint to make clear that single gpu section contains general info * add new files to ToC * update toctree to have subsection for performance * add "coming soon" to the still empty sections * fix missing title * fix typo * add reference to empty documents * Apply suggestions from code review Co-authored-by: Stas Bekman <[email protected]> * Apply suggestions from code review Co-authored-by: Stas Bekman <[email protected]> Co-authored-by: Stas Bekman <[email protected]>
* add skeleton files * fix cpu inference link * add hint to make clear that single gpu section contains general info * add new files to ToC * update toctree to have subsection for performance * add "coming soon" to the still empty sections * fix missing title * fix typo * add reference to empty documents * Apply suggestions from code review Co-authored-by: Stas Bekman <[email protected]> * Apply suggestions from code review Co-authored-by: Stas Bekman <[email protected]> Co-authored-by: Stas Bekman <[email protected]>
What does this PR do?
As discussed with @stas00 this PR does the following things:
Looking at the ToC I was wondering whether we should add subsections like it is done for the tasks to make the main ToC a bit slimmer. Otherwise we have the main performance docs (the entry point) there plus all the other sections (~8-10). What do you think?
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.