pytorch/docs/source/mps.rst
Kulin Seth 8df56afc20 Add support in Python API for the recommended max working set size. (#128289)
Adds ways for users to request recommended max size for Metal on Mac. It plumbs through
https://developer.apple.com/documentation/metal/mtldevice/2369280-recommendedmaxworkingsetsize?language=objc

Can be used like
```
        max_memory = torch.mps.recommended_max_memory()
        print ("Recommended Max Memory : ", (max_memory/(1024*1024*1024)), "GB")
```

Co-authored-by: Nikita Shulga <2453524+malfet@users.noreply.github.com>
Pull Request resolved: https://github.com/pytorch/pytorch/pull/128289
Approved by: https://github.com/malfet
2024-06-12 16:03:57 +00:00

45 lines
799 B
ReStructuredText

torch.mps
===================================
.. automodule:: torch.mps
.. currentmodule:: torch.mps
.. autosummary::
:toctree: generated
:nosignatures:
device_count
synchronize
get_rng_state
set_rng_state
manual_seed
seed
empty_cache
set_per_process_memory_fraction
current_allocated_memory
driver_allocated_memory
recommended_max_memory
MPS Profiler
------------
.. autosummary::
:toctree: generated
:nosignatures:
profiler.start
profiler.stop
profiler.profile
MPS Event
------------
.. autosummary::
:toctree: generated
:nosignatures:
event.Event
.. This module needs to be documented. Adding here in the meantime
.. for tracking purposes
.. py:module:: torch.mps.event
.. py:module:: torch.mps.profiler