capability_snapshot#

scikitplot.corpus.capability_snapshot(extra_distributions=())[source]#

Return a read-only snapshot of the runtime corpus capabilities.

Parameters:
extra_distributionsiterable of str, optional

Additional distribution names to record beyond the built-in set.

Returns:
dict

A mapping with keys:

pythonstr

Python version (e.g. "3.11.6").

implementationstr

Interpreter implementation (e.g. "CPython").

platformstr

Platform identifier from platform.platform.

ann_backendsdict

{name: {"available": bool, "version": str | None}} for every registered ANN backend.

distributionsdict

{distribution: version | None} for the relevant optional packages (plus any extra_distributions).

Parameters:

extra_distributions (Iterable[str])

Return type:

dict[str, Any]

Notes

Purely observational — it acquires no locks, mutates no state, and never raises for a missing optional component (absent components report None / False), so it is safe to embed in a run/build manifest.