Files
pytorch/GLOSSARY.md
Sam Estep 75651e3cc4 Add remaining ToCs to ToC lint (#56487)
Summary:
The lint was originally added in https://github.com/pytorch/pytorch/issues/54974, but at the time I didn't realize that these other Markdown files also each have a table of contents:

- `GLOSSARY.md`
- `torch/csrc/jit/OVERVIEW.md`
- `torch/csrc/jit/docs/serialization.md`
- `torch/fx/OVERVIEW.md`

This PR adds those files to the lint, and also changes the rule from using a fixed list of filenames to a `git grep` command that finds all Markdown files containing this magic comment:

```md

```

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

Test Plan: The "Lint / toc" job in GitHub Actions.

Reviewed By: janeyx99

Differential Revision: D27884885

Pulled By: samestep

fbshipit-source-id: 5462437502b17fba93abf5098e21754bf566a4fe
2021-04-20 10:28:47 -07:00

2.4 KiB

PyTorch Glossary

Operation and Kernel

ATen

Short for "A Tensor Library". The foundational tensor and mathematical operation library on which all else is built.

Operation

A unit of work. For example, the work of matrix multiplication is an operation called aten::matmul.

Native Operation

An operation that comes natively with PyTorch ATen, for example aten::matmul.

Custom Operation

An Operation that is defined by users and is usually a Compound Operation. For example, this tutorial details how to create Custom Operations.

Kernel

Implementation of a PyTorch operation, specifying what should be done when an operation executes.

Compound Operation

A Compound Operation is composed of other operations. Its kernel is usually device-agnostic. Normally it doesn't have its own derivative functions defined. Instead, AutoGrad automatically computes its derivative based on operations it uses.

Composite Operation

Same as Compound Operation.

Non-Leaf Operation

Same as Compound Operation.

Leaf Operation

An operation that's considered a basic operation, as opposed to a Compound Operation. Leaf Operation always has dispatch functions defined, usually has a derivative function defined as well.

Device Kernel

Device-specific kernel of a leaf operation.

Compound Kernel

Opposed to Device Kernels, Compound kernels are usually device-agnostic and belong to Compound Operations.

JIT Compilation

JIT

Just-In-Time Compilation.

TorchScript

An interface to the TorchScript JIT compiler and interpreter.

Tracing

Using torch.jit.trace on a function to get an executable that can be optimized using just-in-time compilation.

Scripting

Using torch.jit.script on a function to inspect source code and compile it as TorchScript code.