pytorch/docs/source/cuda.tunable.rst
Nichols A. Romero c0a39ad35a [ROCm] Fix TunableOp UTs: Rotating Buffer (#143172)
TunableOp's rotating buffer feature cannot be properly tested because the environment variable that controls this feature is sticky. A Python API is introduced to modify this value.

Additional items in this PR:
* UT for rotating buffer API
* Clean up UTs that were setting the rotating buffer via the environment variable
* Align behavior of environment variable and Python API when a negative value (< 0) is set.
* Update documentation.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/143172
Approved by: https://github.com/jeffdaily
2024-12-14 06:18:11 +00:00

39 lines
1.0 KiB
ReStructuredText

.. currentmodule:: torch.cuda.tunable
TunableOp
=========
.. note::
This is a prototype feature, which means it is at an early stage
for feedback and testing, and its components are subject to change.
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