xref: /aosp_15_r20/external/pytorch/torch/csrc/jit/README.md (revision da0073e96a02ea20f0ac840b70461e3646d07c45)
1# PyTorch JIT
2
3This folder contains (most of) the C++ code for the PyTorch JIT, a language
4and compiler stack for executing PyTorch models portably and efficiently. To
5learn more about the JIT from a user perspective, please consult our
6[reference documentation](https://pytorch.org/docs/stable/jit.html) and
7[tutorials](https://pytorch.org/tutorials/beginner/Intro_to_TorchScript_tutorial.html).
8
9A brief summary of the source tree:
10- [OVERVIEW.md](OVERVIEW.md): High-level technical overview of the JIT.
11- [frontend/](frontend): Taking PyTorch modules in Python and translating them into the
12  JIT IR.
13- [ir/](ir): Core IR abstractions.
14- [runtime/](runtime): Interpreter, graph execution, and JIT operators.
15- [codegen/](codegen): Generating efficient, hardware-specific code for JIT subgraphs.
16- [serialization/](serialization): Saving and loading modules.
17- [api/](api): Any user-facing C++ or Python interfaces.
18- [python/](python): Binding stuff into Python or accessing information from the Python
19  environment.
20- [testing/](testing): Utilities and helpers for testing.
21- [mobile/](mobile): Mobile-specific implementations of runtime components.
22- [passes/](passes): IR-to-IR passes, generally for optimization and lowering.
23- [generated/](generated): This folder is generated by the PyTorch build, and contains
24  bindings for native PyTorch operators into the JIT.
25
26**Refer** to each folder for more in-depth documentation.
27
28Other relevant parts of the codebase not contained here:
29- [aten/src/ATen/core](/aten/src/ATen/core): contains JIT code re-used by other elements of the
30  runtime system (eager, mobile, etc.)
31