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

[benchmarks] Add docs file. #8023

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

ysiraichi
Copy link
Collaborator

@ysiraichi ysiraichi commented Sep 16, 2024

This PR introduces a docs/torchbench.md file. It explains how to use the benchmarking scripts for running, troubleshooting, and debugging the models inside Torchbench.


**PyTorch/XLA Metrics:** (repeat-specific) the flag `--dump-pytorch-xla-metrics` creates a
new file, dumping PyTorch/XLA metrics, such as graph compiling and execution information.

Copy link
Collaborator

@miladm miladm Sep 16, 2024

Choose a reason for hiding this comment

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

Can we have a section on Nightly CI runs - TPU and GPU

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure. But I don't really have any information on those nightly CI runs. What should it contain?

Copy link
Collaborator

Choose a reason for hiding this comment

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

@zpcore can you please help Yukio with this section?

Copy link
Collaborator

Choose a reason for hiding this comment

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

additional: ideally, we also want to run verifier as part of our tests


**PyTorch/XLA Metrics:** (repeat-specific) the flag `--dump-pytorch-xla-metrics` creates a
new file, dumping PyTorch/XLA metrics, such as graph compiling and execution information.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we include a troubleshooting section? this should include the pitfalls we ran into as well as approaches to debug the benchmark efficiently.

Copy link

Choose a reason for hiding this comment

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

@miladm I don't think it is appropriate to document any resolved issue here. If there are any features that can be used to debug different performance issues we should absolutely make sure they are captured.

@ysiraichi ysiraichi marked this pull request as ready for review September 23, 2024 17:00
@miladm
Copy link
Collaborator

miladm commented Sep 23, 2024

@ysiraichi

  • can we have a section called "tips and tricks" covering some of the ways we found helping with the performance gain of torch_xla. This can include flags like functionalization, cuda fallback, cuda garphs, etc.

@qihqi qihqi requested review from miladm and amjames October 31, 2024 16:27
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