coverage_matrix#
- scikitplot.cleanprompt.coverage_matrix(policy=None, catalog=None)[source]#
Return one row per detection kind, derived from the live registries.
- Parameters:
- policyRedactionPolicy, optional
Decides each kind’s action. Defaults to
DEFAULT_POLICY.- catalogCatalog, optional
Supplies the packs. Defaults to the built-in catalog.
- Returns:
- tuple of CoverageRow
Sorted by kind.
- Parameters:
policy (RedactionPolicy | None)
catalog (Any | None)
- Return type:
tuple[CoverageRow, …]
Notes
User notes.
kinds --matrixprints this, and the user guide’s coverage table is generated from it, so neither can drift from what the library really does. It says which surfaces can find a kind; whether they run depends on the packs, kinds and engines a plan selects.Developer notes (``CP-116``). Every column is read from a registry:
PATTERNS, the catalog’s packs,CANONICAL_LABELSandDEFAULT_ENTITY_LABELS, the plan’s runtime kinds,SURROGATE_KINDSand the policy’s actions. No optional engine is imported. Columns the registries do not record (a locale per kind, a semantic risk) are not invented here.