pytorch/docs/source
Mark Saroufim 6110effa86 Rework torch.compile docs (#96706)
Chatted with @stas00 on slack and here are some great improvements he suggested to the compile docs

- [x] Rename `dynamo` folder to `compile`
- [x] Link `compile` docstring on `torch.html` to main index page for compile
- [x] Create a new index page that describes why people should care
  - [x] easy perf, memory reduction, 1 line
  - [x] Short benchmark table
  - [x] How to guide
  - [x] TOC that links to the more technical pages folks have written, make the existing docs we have a Technical overview
- [x] Highlight the new APIs for `torch._inductor.list_options()` and `torch._inductor.list_mode_options()` - clarify these are inductor specific and add more prose around which ones are most interesting

He also highlighted an interesting way to think about who is reading this doc we have

- [x] End users, that just want things to run fast
- [x] Library maintainers wrapping torch.compile which would care for example about understanding when in their code they should compile a model, which backends are supported
- [x] Debuggers who needs are somewhat addressed by the troubleshooting guide and faq but those could be dramatically reworked to say what we expect to break

And in a seperate PR I'll work on the below with @SherlockNoMad
- [ ] Authors of new backends that care about how to plug into dynamo or inductor layer so need to explain some more internals like
  - [ ] IR
  - [ ] Where to plugin, dynamo? inductor? triton?

Pull Request resolved: https://github.com/pytorch/pytorch/pull/96706
Approved by: https://github.com/svekars
2023-03-15 04:41:13 +00:00
..
_static Move Dynamo docs back to core (#89769) 2022-11-29 04:38:53 +00:00
_templates Add a private API banner (#93996) 2023-02-03 21:40:15 +00:00
community [PT-D] Update CODEOWNERS, merge_rules, and Persons-of-Interest for to… (#96321) 2023-03-13 17:38:43 +00:00
compile Rework torch.compile docs (#96706) 2023-03-15 04:41:13 +00:00
elastic [BE] Prefer dash over underscore in command-line options (#94505) 2023-02-09 20:16:49 +00:00
notes [BE] [1/3] Rewrite super() calls in caffe2 and benchmarks (#94587) 2023-02-11 18:19:48 +00:00
rpc
scripts Rename Canonical Aten IR to Core Aten IR (#92904) 2023-01-25 05:12:23 +00:00
_dynamo.rst Add torch._dynamo to docs (#89510) 2022-11-23 16:33:13 +00:00
amp.rst
autograd.rst Expose autograd.graph.Node as an abstract base class (#91475) 2023-01-18 00:20:13 +00:00
backends.rst [CUDA][cuFFT] Minor fix for cuFFT plan cache docs (#96373) 2023-03-14 00:28:14 +00:00
benchmark_utils.rst
bottleneck.rst
checkpoint.rst
complex_numbers.rst
conf.py Update copyright (#95652) 2023-02-27 23:15:55 +00:00
config_mod.rst
cpp_extension.rst
cpp_index.rst
cuda._sanitizer.rst
cuda.rst Add more GPU metric instrumentation (#91717) 2023-02-24 00:38:03 +00:00
cudnn_persistent_rnn.rst
cudnn_rnn_determinism.rst
data.rst
ddp_comm_hooks.rst [BE] [1/3] Rewrite super() calls in caffe2 and benchmarks (#94587) 2023-02-11 18:19:48 +00:00
deploy.rst
distributed.algorithms.join.rst
distributed.checkpoint.rst [DCP] Add DCP FSDP sharded_state_dict checkpoint example to DCP .rst file (#95517) 2023-03-03 18:09:10 +00:00
distributed.elastic.rst
distributed.optim.rst
distributed.rst [Doc][Distributed] Add missing functions to distributed.rst (#89905) 2022-12-04 07:22:54 +00:00
distributed.tensor.parallel.rst [PT-D][Sequence Parallelism] Enable DTensor based Naive sequence parallelism (#94369) 2023-02-16 21:21:00 +00:00
distributions.rst
dlpack.rst
docutils.conf
fft.rst
fsdp.rst
func.api.rst [functorch] linearize (#94173) 2023-02-09 15:45:08 +00:00
func.batch_norm.rst [functorch] move batch_norm_replacement to torch.func (#91412) 2023-01-12 19:15:41 +00:00
func.migrating.rst [torch.func] Add migration guide from functorch (#91811) 2023-01-17 22:14:42 +00:00
func.rst Fix typo under docs directory (#92762) 2023-01-23 18:07:22 +00:00
func.ux_limitations.rst [torch.func] Add docs (#91319) 2022-12-30 02:51:18 +00:00
func.whirlwind_tour.rst [torch.func] Add docs (#91319) 2022-12-30 02:51:18 +00:00
futures.rst
fx.rst
hub.rst Fix typo under docs directory (#92762) 2023-01-23 18:07:22 +00:00
index.rst Rework torch.compile docs (#96706) 2023-03-15 04:41:13 +00:00
ir.rst Rename Canonical Aten IR to Core Aten IR (#92904) 2023-01-25 05:12:23 +00:00
jit_builtin_functions.rst
jit_language_reference_v2.rst [BE] [1/3] Rewrite super() calls in caffe2 and benchmarks (#94587) 2023-02-11 18:19:48 +00:00
jit_language_reference.rst [BE] [1/3] Rewrite super() calls in caffe2 and benchmarks (#94587) 2023-02-11 18:19:48 +00:00
jit_python_reference.rst
jit_unsupported.rst
jit_utils.rst
jit.rst [BE] [1/3] Rewrite super() calls in caffe2 and benchmarks (#94587) 2023-02-11 18:19:48 +00:00
library.rst
linalg.rst
masked.rst Fix link in docs (#94686) 2023-02-13 20:42:24 +00:00
math-quantizer-equation.png
mobile_optimizer.rst [Reland] Clean Up MobileOptimizerType Rewrite Flags Public API and Documentation (#92081) 2023-01-14 17:06:00 +00:00
model_zoo.rst
monitor.rst
mps.rst [MPS] Enable Memory Leak Detection for test_mps.py (#94646) 2023-02-13 17:56:24 +00:00
multiprocessing.rst
name_inference.rst Softmax added to tensor, torch and docs (#91292) 2022-12-28 15:06:24 +00:00
named_tensor.rst
nested.rst Add torch.nn.LayerNorm() to documented list of supported nested tensor ops (#96434) 2023-03-13 23:16:09 +00:00
nn.functional.rst [SDPA] update type hint for scaled_dot_product_attention and documentation (#94008) 2023-02-10 18:02:43 +00:00
nn.init.rst
nn.rst Adding nn.ZeroPad1d and nn.ZeroPad3d (#96295) 2023-03-10 03:51:41 +00:00
onnx_diagnostics.rst [ONNX] Document ONNX diagnostics (#88371) 2022-11-16 19:21:46 +00:00
onnx_supported_aten_ops.rst
onnx.rst [ONNX] Documentation for torch.onnx.find_mismatch (#90728) 2023-01-11 23:58:57 +00:00
optim.rst [optim] Add general documentation on our algorithm defaults (#95391) 2023-02-24 21:35:30 +00:00
package.rst
pipeline.rst
profiler.rst
quantization-accuracy-debugging.rst
quantization-backend-configuration.rst update quantization doc: add x86 backend as default backend of server inference (#86794) 2022-12-02 02:10:25 +00:00
quantization-support.rst AO migration: migrate .rst files to new locations (#94211) 2023-02-07 02:32:23 +00:00
quantization.rst AO migration: migrate .rst files to new locations (#94211) 2023-02-07 02:32:23 +00:00
random.rst
rpc.rst
signal.rst Nuttall window (#90103) 2022-12-16 09:05:53 +00:00
sparse.rst Minor error in docs regarding execution time (#93258) 2023-01-31 23:32:42 +00:00
special.rst
storage.rst
tensor_attributes.rst Add a warning about performance cost of set_default_device (#92703) 2023-01-21 02:23:13 +00:00
tensor_view.rst
tensorboard.rst
tensors.rst Remove deprecated torch.symeig (#70988) 2023-01-31 11:59:11 +00:00
testing.rst document torch.testing.assert_allclose (#89526) 2022-12-01 11:22:50 +00:00
torch.ao.ns._numeric_suite_fx.rst
torch.ao.ns._numeric_suite.rst
torch.overrides.rst
torch.rst Rework torch.compile docs (#96706) 2023-03-15 04:41:13 +00:00
type_info.rst