EngineSpec#

class scikitplot.cleanprompt.EngineSpec(name, tier, summary, languages, needs_model, priority=30, confidence=0.7)[source]#

Static description of one named-entity engine.

Parameters:

namestr

Engine name, as used by --ner-engine.

tierstr

Capability tier that must be available for it to run.

summarystr

One line describing what it is for.

languagestuple of str

Language codes it can handle, or ("*",) for “depends on the model”.

needs_modelbool

Whether a separate model download is required.

priorityint

Detector arbitration weight. Below the structural patterns, so an address recognised by both is labelled EMAIL, not ORG.

confidencefloat

Reported confidence for this engine’s spans.

Parameters:

• name (str)

• tier (str)

• summary (str)

• languages (tuple[str, ...])

• needs_model (bool)

• priority (int)

• confidence (float)

confidence: float = 0.7#

languages: tuple[str, ...][source]#

name: str[source]#

needs_model: bool[source]#

priority: int = 30#

summary: str[source]#

supports(language)[source]#

Return whether this engine can handle language.

Parameters:

language (str)

Return type:

bool

tier: str[source]#