pytorch/docs/source/cuda.tunable.rst
Nichols A. Romero 08baaa7d63 [Docs][TunableOp] TunableOp documentation update (#148384)
This PR aligns documentation to what is in the README file:
https://github.com/pytorch/pytorch/blob/main/aten/src/ATen/cuda/tunable/README.md

and removes the prototype NOTE.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/148384
Approved by: https://github.com/jeffdaily, https://github.com/svekars

Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-03-07 21:02:49 +00:00

36 lines
905 B
ReStructuredText

.. currentmodule:: torch.cuda.tunable
TunableOp
=========
Overview
--------
.. automodule:: torch.cuda.tunable
API Reference
-------------
.. autofunction:: enable
.. autofunction:: is_enabled
.. autofunction:: tuning_enable
.. autofunction:: tuning_is_enabled
.. autofunction:: record_untuned_enable
.. autofunction:: record_untuned_is_enabled
.. autofunction:: set_max_tuning_duration
.. autofunction:: get_max_tuning_duration
.. autofunction:: set_max_tuning_iterations
.. autofunction:: get_max_tuning_iterations
.. autofunction:: set_filename
.. autofunction:: get_filename
.. autofunction:: get_results
.. autofunction:: get_validators
.. autofunction:: write_file_on_exit
.. autofunction:: write_file
.. autofunction:: read_file
.. autofunction:: tune_gemm_in_file
.. autofunction:: mgpu_tune_gemm_in_file
.. autofunction:: set_rotating_buffer_size
.. autofunction:: get_rotating_buffer_size