Diagnosis#

class scikitplot.cleanprompt.Diagnosis(active_kinds, inactive_kinds, tiers, blind_spots, ner_active)[source]#

What a given configuration can and cannot detect.

Parameters:
active_kindstuple of str

Detection kinds that will run.

inactive_kindstuple of str

Kinds available in the library but not enabled by this configuration.

tiersdict

Per-tier capability report, keyed by tier name.

blind_spotstuple of BlindSpot

Categories nothing currently covers.

ner_activebool

Whether named-entity detection will run.

Parameters:

Notes

User notes. blind_spots is the field to read. An empty tuple means every category this tool knows about is covered by something.

active_kinds: tuple[str, ...][source]#
as_dict()[source]#

Return a JSON-safe dictionary.

Return type:

dict[str, Any]

blind_spots: tuple[BlindSpot, ...][source]#
headline()[source]#

Return one sentence describing the detection posture.

Returns:
str

Suitable for a banner in a terminal or a web page.

Return type:

str

property healthy: bool#

True when no high-severity blind spot is present.

Type:

bool

inactive_kinds: tuple[str, ...][source]#
ner_active: bool[source]#
tiers: dict[str, Any][source]#