pytorch/docs/source/mps.rst
albanD c4db607607 Doc test non packages (#110568)
Add non-package python modules to the public API checks.
The original change is to remove the `ispkg` check in this line
https://github.com/pytorch/pytorch/blob/main/docs/source/conf.py#L518

Everything else is to add the appropriate modules to the rst files, make sure every module we provide can be imported (fixed by either making optional dependencies optional or just deleting files that have been un-importable for 3 years), make API that are both modules and functions (like torch.autograd.gradcheck) properly rendered on the docs website without confusion and add every non-documented API to the allow list (~3k of them).

Next steps will be to try and fix these missing docs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/110568
Approved by: https://github.com/zou3519
2023-10-06 14:16:01 +00:00

42 lines
754 B
ReStructuredText

torch.mps
===================================
.. automodule:: torch.mps
.. currentmodule:: torch.mps
.. autosummary::
:toctree: generated
:nosignatures:
synchronize
get_rng_state
set_rng_state
manual_seed
seed
empty_cache
set_per_process_memory_fraction
current_allocated_memory
driver_allocated_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