pytorch/docs/source
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
..
_static
_templates
community [Docs] Update sparse Maintainers (#85126) 2022-09-27 22:50:31 +00:00
elastic Add watchdog to TorchElastic agent and trainers (#84081) 2022-09-07 00:17:20 +00:00
notes [CUBLAS][TF32][CUDNN] Update numerical_accuracy.rst (#79537) 2022-09-07 18:30:26 +00:00
rpc
scripts [ONNX] Update ONNX documentation to include unsupported operators (#84496) 2022-09-16 23:48:37 +00:00
amp.rst Remove deprecated torch.matrix_rank (#70981) 2022-09-22 17:40:46 +00:00
autograd.rst
backends.rst Update backends.rst (#82525) 2022-08-03 18:33:15 +00:00
benchmark_utils.rst
bottleneck.rst add itt unit test and docstrings (#84848) 2022-09-28 01:39:58 +00:00
checkpoint.rst
complex_numbers.rst
conf.py Add user facing documentation for CSAN (#84689) 2022-09-09 15:29:34 +00:00
config_mod.rst
cpp_extension.rst
cpp_index.rst
cuda._sanitizer.rst Rework printing tensor aliases in CSAN error message (#85008) 2022-09-21 13:41:52 +00:00
cuda.rst Add user facing documentation for CSAN (#84689) 2022-09-09 15:29:34 +00:00
cudnn_persistent_rnn.rst
cudnn_rnn_determinism.rst
data.rst
ddp_comm_hooks.rst
deploy.rst
distributed.algorithms.join.rst
distributed.elastic.rst
distributed.optim.rst
distributed.rst Add all_gather_into_tensor in place of _all_gather_base (#85686) 2022-09-27 22:50:22 +00:00
distributions.rst
dlpack.rst
docutils.conf
fft.rst
fsdp.rst
futures.rst
fx.rst
hub.rst
index.rst Add torch.nested namespace (#84102) 2022-09-12 16:31:05 +00:00
jit.rst
jit_builtin_functions.rst
jit_language_reference.rst
jit_language_reference_v2.rst Fix typos in docs (#80602) 2022-08-29 23:32:44 +00:00
jit_python_reference.rst
jit_unsupported.rst
jit_utils.rst
library.rst
linalg.rst
masked.rst [maskedtensor] first commit, core and creation (#82836) 2022-08-16 20:10:34 +00:00
math-quantizer-equation.png
mobile_optimizer.rst
model_zoo.rst
monitor.rst
multiprocessing.rst
name_inference.rst
named_tensor.rst Add torch.unflatten and improve its docs (#81399) 2022-07-29 15:02:42 +00:00
nested.rst Add torch.nested namespace (#84102) 2022-09-12 16:31:05 +00:00
nn.functional.rst
nn.init.rst
nn.rst
onnx.rst [ONNX] Reland #81953 Type utility for converting among JIT, torch and ONNX data types (#82995) 2022-08-08 23:43:43 +00:00
onnx_supported_aten_ops.rst [ONNX] Update ONNX documentation to include unsupported operators (#84496) 2022-09-16 23:48:37 +00:00
optim.rst feat: add PolynomialLR scheduler (#82769) 2022-08-10 18:21:00 +00:00
package.rst Fix typos in torch.package documentation (#82994) 2022-08-08 20:19:17 +00:00
pipeline.rst
profiler.rst add itt unit test and docstrings (#84848) 2022-09-28 01:39:58 +00:00
quantization-accuracy-debugging.rst
quantization-backend-configuration.rst
quantization-support.rst Rename 'torch/ao/nn/quantized._reference' to 'torch/ao/nn/quantized/reference'. (#84974) 2022-09-16 17:49:07 +00:00
quantization.rst Rename 'torch/ao/nn/quantized._reference' to 'torch/ao/nn/quantized/reference'. (#84974) 2022-09-16 17:49:07 +00:00
random.rst
rpc.rst
sparse.rst Revise sparse docs regarding Sparse Compressed tensors (#82108) 2022-07-29 18:15:09 +00:00
special.rst
storage.rst Fix typos in docs (#80602) 2022-08-29 23:32:44 +00:00
tensor_attributes.rst
tensor_view.rst
tensorboard.rst
tensors.rst Remove deprecated torch.lstsq (#70980) 2022-09-23 00:16:55 +00:00
testing.rst
torch.ao.ns._numeric_suite.rst
torch.ao.ns._numeric_suite_fx.rst
torch.overrides.rst
torch.rst Remove deprecated torch.lstsq (#70980) 2022-09-23 00:16:55 +00:00
type_info.rst