describe_engines#

scikitplot.cleanprompt.describe_engines(language='en', mode='auto', model=None, size='sm', check_assets=False)[source]#

Report every engine’s readiness, and what mode would select.

Parameters:
languagestr, default=’en’

Language code to report against.

modestr, default=’auto’

The mode being asked about.

modelstr, optional

Explicit spaCy model.

sizestr, default=’sm’

Preferred spaCy model size.

check_assetsbool, default=False

Also check NLTK’s data packages, which imports NLTK. doctor passes True.

Returns:
dict

JSON-safe report with one entry per engine, a selected list, and ready: whether every selected engine is ready.

Parameters:
Return type:

dict[str, Any]

Notes

User notes. Per engine, installed, language_supported and assets_ready are the three conditions, ready is their conjunction, and remedy is the next step. usable is kept as a synonym of ready. The top-level ready is False when a selected engine is known not to be able to run, which is the case doctor must not call healthy.