pytorch/docs
Jing Xu 80b8886223 add itt unit test and docstrings (#84848)
Add unit tests and docstrings corresponding to PR https://github.com/pytorch/pytorch/pull/63289
UT:
1. `test_profiler_emit_itt` in `test/test_autograd.py`. This test is merely intended to catch if emit_itt breaks on construction.
2. Test `torch.profiler.itt` functions in `test/test_itt.py`
3. Only testing that emit_itt runs when `record_shapes` option is enabled in `test/test_profiler.py`.

Docstring:
1. add ITT related info into `docs/source/bottleneck.rst`
4. add `torch.profiler.itt` functions to `docs/source/profiler.rst`
5. add docstring to `torch.profiler.itt` functions in `torch/profiler/itt.py`
Pull Request resolved: https://github.com/pytorch/pytorch/pull/84848
Approved by: https://github.com/malfet
2022-09-28 01:39:58 +00:00
..
caffe2
cpp Fix typos in docs (#80602) 2022-08-29 23:32:44 +00:00
source add itt unit test and docstrings (#84848) 2022-09-28 01:39:58 +00:00
.gitignore
libtorch.rst
make.bat
Makefile [ONNX] Clean up onnx_supported_ops (#79424) 2022-06-23 20:44:51 +00:00
README.md
requirements.txt Freeze the rest of python docs requirement (#83785) 2022-08-20 03:37:21 +00:00

Please see the Writing documentation section of CONTRIBUTING.md for details on both writing and building the docs.