pytorch/docs/source/profiler.rst
Jeff Yang 5a4e5db9ad docs: fix profiler docstring (#55750)
Summary:
Description:
- change the docstrings for profiler module as per google docstring
- add link to `torch.autograd` module
- document `ProfilerAction` and `ProfilerActivity`

https://12292060-65600975-gh.circle-artifacts.com/0/docs/profiler.html

Pull Request resolved: https://github.com/pytorch/pytorch/pull/55750

Reviewed By: yinghai

Differential Revision: D27725494

Pulled By: ngimel

fbshipit-source-id: 32d0a18e274a871ac712b28b61ba63eb08299a03
2021-04-13 00:23:14 -07:00

26 lines
417 B
ReStructuredText

.. currentmodule:: torch.profiler
torch.profiler
==============
Overview
--------
.. automodule:: torch.profiler
API Reference
-------------
.. autoclass:: torch.profiler.profile
:members:
.. autoclass:: torch.profiler.ProfilerAction
:members:
.. autoclass:: torch.profiler.ProfilerActivity
:members:
.. autofunction:: torch.profiler.schedule
.. autofunction:: torch.profiler.tensorboard_trace_handler