Adding Compare in torch.utils.benchmark documentation

[Ghelfi]

torch.utils.benchmark.Compare is not directly exposed in torch.utils.benchmark documentation.

I think this is a valuable resource to add since it can help people embracing the torch benchmark way of doing things, and help people building documentation towards it.

[pytorch-bot]

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/125009

• 📄 Preview Python docs built from this PR
• 📄 Preview C++ docs built from this PR
• ❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 864eae5 with merge base da991fa ():
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: Ghelfi / name: Alexandre Ghelfi, PhD (aaf18b0, 4d20f3c, 09f456e, 6ba4ac6, 714dd71, f15d1ad, c860e6f, 050e6a6, 785c762, 4ca324a, 41472fd, e3b1e35, 7d95c33, 60eca63, 0246629, 61529a6, dda6d15, 79ef4cf, 1962244, 0a18b9c, ff4faac, 60c6a15, 4a7d9c6, 864eae5, efbef6d, 0844b81)

[mikaylagawarecki]

Thanks

edit: Actually it looks like there are no docstrings for this class. Would you be willing to add them?

[Ghelfi]

Added a docstring.

[mikaylagawarecki]

Could you also add a docstring for all the non private methods of compare please

[mikaylagawarecki]

You might need to run lintrunner to fix lint

[Ghelfi]

Sorry for that, my pre-commit was not activated...

[mikaylagawarecki]

@pytorchbot merge

[pytorchmergebot]

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here