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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Broken Link and unfinished sentence in Frequently Asked Questions #126367

Open
angelica-moreira opened this issue May 16, 2024 · 1 comment
Open
Labels
actionable module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@angelica-moreira
Copy link

angelica-moreira commented May 16, 2024

馃摎 The doc issue

In the torch.compiler_faq.rst file, there is a sentence that reads: The basic strategy for optimizing DDP with Dynamo is outlined in distributed.py where the main idea will be to graph break on DDP bucket boundaries.

However, the hyperlink that should lead to distributed.py is not functioning correctly. When clicked, it does not redirect to the intended destination, it seems the file is no longer available at the specified location.

In the same file, there is an unfinished sentence that reads:
For example, Inductor first takes care of fusing whatever it can and only then generates Triton kernels. It can also

This sentence ends abruptly and does not provide complete information.

Suggest a potential alternative/fix

I believe the distributed.py file mentioned in the documentation might be located at torch/_dynamo/backends/distributed.py. If this is the correct file, updating the hyperlink to point to this location should resolve the issue. However, please verify this as I might be mistaken.

Regarding the unfinished sentence I believe the It can also can be removed, but if there is something more to be said it should be completed.

cc @svekars @brycebortree

@mikaylagawarecki mikaylagawarecki added module: docs Related to our documentation, both in docs/ and docblocks actionable labels May 20, 2024
@mikaylagawarecki
Copy link
Contributor

Feel free to submit a PR that addresses both of these

@mikaylagawarecki mikaylagawarecki added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label May 20, 2024
@svekars svekars added easy label for easy docathon tasks docathon-h1-2024 module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module actionable and removed module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module actionable easy label for easy docathon tasks docathon-h1-2024 labels May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Development

No branches or pull requests

3 participants