Files
pytorch/docs/source/benchmark_utils.rst
Alexandre Ghelfi, PhD d18a6f46d0 Adding Compare in torch.utils.benchmark documentation (#125009)
`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.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/125009
Approved by: https://github.com/mikaylagawarecki
2024-05-03 00:50:54 +00:00

31 lines
719 B
ReStructuredText

.. role:: hidden
:class: hidden-section
Benchmark Utils - torch.utils.benchmark
==================================================
.. automodule:: torch.utils.benchmark
.. currentmodule:: torch.utils.benchmark
.. autoclass:: Timer
:members:
.. autoclass:: Measurement
:members:
.. autoclass:: CallgrindStats
:members:
.. autoclass:: FunctionCounts
:members:
.. autoclass:: Compare
:members:
.. These are missing documentation. Adding them here until a better place
.. is made in this file.
.. py:module:: torch.utils.benchmark.examples
.. py:module:: torch.utils.benchmark.op_fuzzers
.. py:module:: torch.utils.benchmark.utils
.. py:module:: torch.utils.benchmark.utils.valgrind_wrapper