TorchLens API map

built from commit 23dc5ee2c on 2026-11-04 17:01 UTC
Open depth
Legend: what the badges, tags and marks on each row mean

package class function property field Kind of the row: package (a directory with __init__.py), module (one file), class, function or method, property (read like an attribute), dataclass field, attribute, constant, enum member.

L4 core Implementation layer from torchlens/_architecture.py: the number is the layer (L0 is the foundation; a higher layer may import a lower one, never the reverse), the word its tier: core (L0 to L5, the capture engine and its data), appliance (L6, tools on the core), present (L7, rendering and reports), bridge (L8, adapters to external tools), recipe (L9, workflows over the rest). Not a deprecation mark.

facade A thin lazy namespace module (torchlens itself, torchlens.io) that re-exports things defined deeper; a role, not a layer. A root row shows the layer of the implementation it stands for and adds "facade" when the name is reached through such a module; in the package tree the facade module itself carries only "facade".

same as An alias row: the name re-exports a definition that lives elsewhere. The badges and tags sit on the real home, which the "same as" link opens.

legacy root A root tl.NAME implemented at L6 or above. Supported and kept at the top level until the next major release; the deeper module is the long-term spelling.

__all__ Dashed: declared in torchlens.__all__. Root names without it are public too (they are in the frozen surface table) but from torchlens import * skips them.

dataclass Python detail tags: frozen, enum, settable (property with a setter), classmethod, staticmethod, contextmanager, async.

+N internal N non-public members (underscore names, private modules), hidden until Internals is on.

=MISSING An argument you may leave out: MISSING is the TorchLens sentinel for "not passed", so the option's own default applies and an omitted argument is told apart from one passed explicitly.

rows Rows list argument names with short defaults (underscore-prefixed parameters left out); a blue N more) chip folds the rest of a long signature and opens on click. Click a row for the full typed signature, docstring and defining file; the caret opens its children.

summaries The one-line summary and the full docstring are the source's own text, shown verbatim. Codes in them such as "F20", "C01 item 18" or "L6 stage 1" are the project's internal plan references, not the layer tags on this page; "out" and "outs" mean a layer's captured output.

Root surface import torchlens as tl; everything reachable as tl.NAME

Package tree every module under torchlens/, with its classes and functions