Module families

Module families 

Source
Expand description

2026-09-29: The kernel-family manifest, kernels/<hw>/common/KERNEL_FAMILIES.toml: which circuit ops each family implements, the parameters it varies (runtime, compile-time or policy), the points it instantiates, the evidence envelope (the points with microbench records) and the rules that rediscover the instantiated points from the kernel sources.

Owner: metrale-circuit (venn). Invariants:

  • A parameter is an axis the family’s code is structured to vary (a runtime argument, a template or macro parameter, a policy or a per-point file copy), even when only one value is instantiated. A format the code cannot vary without a rewrite is a constraint on the op ([[family.op]]), not a parameter.
  • Every point states every compile-time and policy parameter, and nothing else: a runtime parameter never defines a point. Evidence sits on an instantiated point.
  • Nothing defaults: an op, format, parameter, extractor or mode the loader does not know is a typed error, and a parameter a node cannot supply is an error unless the manifest states its absent value.

Structs§

Evidence
2026-09-29: A microbench record at one point and the row counts it measured.
Families
2026-09-29: A parsed manifest.
Family
2026-09-29: One kernel family.
LegacyPath
2026-09-29: A fact about a legacy layer implementation the circuit cannot show: a mode in which the layer has no multi-row path and loops per sequence (or per row).
OpSpec
2026-09-29: An op a family implements, with the constraints a node must meet.
Param
2026-09-29: One parameter of a family.
Point
2026-09-29: One instantiated point.
Roofline
2026-09-29: The roofline constants of the hardware.
Workspace
2026-10-02: One workspace of a family ([[family.workspace]]).

Enums§

Discover
2026-09-29: A rule that rediscovers instantiated points from the sources.
EvidenceSource
2026-09-29: Where an evidence record lives.
Extract
2026-09-29: Where a parameter’s value is read from, for one node of one circuit.
FamilyError
2026-09-29: Why the manifest did not load.
How
2026-09-29: How an instantiated point is realised in the sources.
ParamKind
2026-09-29: How a parameter reaches the kernel.

Functions§

parse_families
2026-09-29: Parse the manifest text.

Type Aliases§

Values
2026-09-29: Parameter name to value.