diagnose#

scikitplot.cleanprompt.diagnose(policy=None, registry=None)[source]#

Report what a configuration can and cannot detect.

Parameters:
policyRedactionPolicy, optional

The policy to describe. Defaults to DEFAULT_POLICY.

registryDetectorRegistry, optional

The detectors that will run. When omitted, the default registry for policy is assumed, which means structural patterns only.

Returns:
Diagnosis

The report. Never raises and never imports an optional dependency.

Parameters:
Return type:

Diagnosis

Examples

>>> report = diagnose()
>>> "EMAIL" in report.active_kinds
True
>>> isinstance(report.headline(), str)
True