🌱 Scikit-plots APIs
0.5.dev0+git.20261115.c051ece - November 15, 2026 09:00 UTC

APIs Reference#

This is the class and function reference of scikit-plots. Please refer to the full user guide for further details, as the raw specifications of classes and functions may not be enough to give full guidelines on their uses. For reference on concepts repeated across the APIs, see glossary-index.

Object

Description

__version__

str(object=’’) -> str

__version_iso_8601__

str(object=’’) -> str

online_help

Open the online documentation search page in the default web browser.

config_context

Context manager for global scikit-plots configuration.

get_config

Retrieve current values for configuration set by set_config.

set_config

Set global scikit-plots configuration.

show_config

Show libraries and system information on which SciPy was built

show_versions

Print or return debugging information about the system, Python, dependencies, and hardware.

get_logger

Return SP (scikitplot) logger instance.

logger

logging (alias, logger) module provide unified both Python logging and logging.Logger utilities.

Agent

Run a goal with a planner and tools, within a policy and limits.

Decision

What the planner decided: call a tool, or finish with an answer.

Action

A call the planner proposes: a tool name and its arguments.

Usage

What producing one decision cost, as the planner reports it.

delegate

Return a tool that runs child toward the goal it is called with.

DelegateTool

A tool whose call is a bounded run of child.

evaluate_audit

Summarise every run in an audit trail.

AuditEvaluation

Per-run summaries and aggregate rates.

RunSummary

What one run did, read from its audit records.

WorkflowGraph

A checked, immutable workflow: nodes, edges and channels.

Task

A node that calls one tool.

FanOut

A node that calls several tools, then joins their results.

Branch

One branch of a FanOut: a tool and its arguments.

Finish

A node that ends the run with an answer.

Edge

A transition from source to target, taken when when is true.

WorkflowView

Where a run stands in its workflow, rebuilt from the recorded steps.

StepSummary

What one recorded step came to, as a callback sees it.

REDUCERS

WorkflowError

A graph that cannot be built, or a run the graph cannot continue.

WorkflowBranchError

A branch of a concurrent fan-out raised; the fan-out step failed.

ArtifactStore

Keeps JSON values under the digest of their canonical form.

MemoryArtifactStore

Keep artifacts in memory, as their canonical JSON text.

DirectoryArtifactStore

Keep each artifact in <directory>/<first two digits>/<digest>.json.

PlanItem

One item of a plan.

PlanStatus

Where one plan item stands.

MAX_PLAN_ITEMS

int([x]) -> integer

check_plan_change

Refuse a plan change that would hide or rewrite progress.

Tool

One callable tool and the facts the gate chain decides on.

ToolEffect

The kind of effect a tool has, which the policy permits or not.

Toolset

The tools one agent may call, by name.

Policy

What an agent may do: least privilege unless stated otherwise.

Limits

Stopping conditions: when a run stops, whatever the planner proposes.

GateKind

The five gates, in the order an action passes them.

GateResult

One gate’s answer for one action.

RunState

The whole of one run, saved after every step.

RunStatus

Where a run is.

StopReason

Why a run is no longer running. Set whenever the status is not running.

Step

One completed step: a decision and what came of it.

StepOutcome

What one step came to.

Spent

What a run has used so far, against its Limits.

ApprovalRequest

An action waiting at the Approval gate.

Approval

A person’s answer to an ApprovalRequest.

StateStore

Saves and loads run states. Subclasses implement both methods.

MemoryStore

Keep states in memory, as their JSON text (so a load is a real round trip).

JsonFileStore

Keep each run’s state in <directory>/<run_id>.json.

AuditSink

Where audit records go. Subclasses implement write.

MemoryAuditSink

Keep records in a list, records.

JsonlAuditSink

Append records to a JSON Lines file, one canonical line each.

read_audit

Read a JSON Lines audit file.

verify_audit

Check every run’s hash chain in records.

AgentError

One error, as recorded in a run’s state and audit trail.

ErrorCode

What went wrong, as a stable code a caller may branch on.

SchemaError

A tool’s parameter schema uses something outside the supported subset.

StateError

A saved run state is malformed, or of a schema version not supported.

check_schema

Check that a tool’s argument schema is in the supported subset.

validate

Return the reasons instance does not match schema.

canonical_json

Return the canonical JSON text of a plain value.

digest

Return the SHA-256 of a plain value’s canonical JSON, as 64 hex digits.

plain

Return value as a plain JSON value, or raise.

Index

Annoy Approximate Nearest Neighbors Index.

scikitplot.annoy._annoy

Annoy

Compiled with GCC/Clang. Using 512-bit AVX instructions.

AnnoyIndex

Compiled with GCC/Clang. Using 512-bit AVX instructions.

Index

High-level ANNoy index composed from mixins.

threads_info

Describe what decides the number of threads in this process.

CompressMode

IndexIOMixin

Mixin adding explicit Annoy-native persistence helpers.

MetaMixin

Mixin that exports and restores index metadata.

NDArrayMixin

NumPy / SciPy / pandas interoperability for Annoy-like indexes.

PickleMixin

Mixin adding pickle support.

PickleMode

PlottingMixin

Mixin that adds convenient plotting methods to high-level Annoy wrappers.

VectorOpsMixin

User-facing neighbor queries for Annoy-like backends.

plot_pca_2d_projection

Plots the 2-dimensional projection of PCA on a given dataset.

plot_pca_component_variance

Plots PCA components’ explained variance ratios. (new in v0.2.2)

plot_feature_importances

Generate a plot of a sklearn model’s feature importances.

plot_learning_curve

Generates a plot of the train and test learning curves for a classifier.

plot_elbow

Plot the elbow curve for different values of K in KMeans clustering.

plot_residuals_distribution

Plot residuals and fit various distributions to assess their goodness of fit.

plot_classifier_eval

Generates various evaluation plots for a classifier, including confusion matrix,

plot_confusion_matrix

Generates a confusion matrix plot from predictions and true labels.

plot_precision_recall

Generates the Precision-Recall AUC Curves from labels and predicted scores/probabilities.

plot_roc

Generates the ROC AUC curves from labels and predicted scores/probabilities.

plot_calibration

Plot calibration curves for a set of classifier probability estimates.

plot_silhouette

Plots silhouette analysis of clusters provided.

validate_labels

Validates the labels passed into arguments such as true_labels or pred_labels

scikitplot.api._utils

cumulative_gain_curve

Generate the data points necessary to plot the Cumulative Gain curve for binary classification tasks.

scikitplot.api._utils

binary_ks_curve

Generate the data points necessary to plot the Kolmogorov-Smirnov (KS)

scikitplot.api._utils

validate_plotting_kwargs

Validate the provided axes and figure or create new ones if needed.

scikitplot.api._utils

stack

Stack multiple matplotlib figures into a single combined figure.

EncodedPrompt

The result of encode: a safe text and the handle to undo it.

Handle

Everything needed to decode a reply. Holds the removed values.

Session

A conversation: consistent placeholders, and a vault with a lifetime.

decode

Put the original values back into a model’s reply.

encode

Replace sensitive values in text with placeholders.

session

SessionStore

Bounded, expiring, server-side store of vaults.

create_app

Build the Flask application.

TIERS

CapabilityReport

Outcome of probing one tier.

CapabilityStatus

Seven-state usability vocabulary for an optional dependency tier.

capabilities

Probe every optional tier.

probe

Report whether one optional tier is usable.

require

Return the report for tier, raising when it is not usable.

load_custom

Load user definitions from one or more files into a catalog of their own.

with_custom

Return the built-in catalog with custom definitions merged in.

Detector

Base class for detectors.

DetectorRegistry

An ordered, immutable-by-convention collection of detectors.

LiteralDetector

Detector for exact strings the caller names.

RegexDetector

Detector backed by one entry of the pattern library.

default_registry

Build a registry from the pattern library, plus optional literal terms.

BlindSpot

A category of sensitive information nothing currently detects.

Diagnosis

What a given configuration can and cannot detect.

Suggestion

A candidate the active detectors did not claim.

describe_outcome

Explain a redaction outcome, especially an empty one.

diagnose

Report what a configuration can and cannot detect.

suggest_terms

Offer candidate terms the active detectors did not claim.

CoverageRow

What covers one detection kind, and what happens to its values.

coverage_matrix

Return one row per detection kind, derived from the live registries.

Redactor

Reusable, stateless redactor.

reserved_label_spans

Find substrings of text that already match the placeholder grammar.

resolve_spans

Reduce possibly overlapping spans to a disjoint, ascending sequence.

restore

Replace placeholders in text with the values held in vault.

CANONICAL_LABELS

Built-in immutable sequence.

DEFAULT_ENGINE

str(object=’’) -> str

ENGINES

ENGINE_MODES

Built-in immutable sequence.

EngineSpec

Static description of one named-entity engine.

build_detectors

Construct the detectors for an engine mode.

canonical_label

Map an engine’s entity label onto the canonical vocabulary.

describe_engines

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

resolve_engine

Resolve an engine mode into the engines that will actually run.

trim_entity_span

Shrink an entity span until it carries no unmatched bracket.

EngineReadiness

Whether one engine can run here, now, and if not, the one step that fixes it.

engine_readiness

Decide whether one engine can run for a language, and how to fix it if not.

FormatSpec

One validated file format.

Guard

Encode what goes to a model, check it, and decode what comes back.

StreamDecoder

Decode a model’s reply as it streams in, never splitting a label.

DEFAULT_LANGUAGE

str(object=’’) -> str

LANGUAGES

MODEL_SIZES

Built-in immutable sequence.

MULTILINGUAL_MODEL

str(object=’’) -> str

LanguageSpec

One language spaCy publishes models for.

installed_models

Return the spaCy models installed here, mapped to their versions.

resolve_model

Resolve a language and size into a spaCy model name.

supported_languages

Return every language code with a dedicated model.

McpServer

Answer MCP requests with cleanprompt tools.

DEFAULT_ENTITY_LABELS

frozenset() -> empty frozenset object

DEFAULT_MODEL

str(object=’’) -> str

NerDetector

Detect named entities with a spaCy pipeline.

spacy_detector

NltkDetector

Detect named entities with NLTK’s maximum-entropy chunker.

nltk_detector

corpora_status

Report whether NLTK’s data packages are present.

FieldSpec

A field whose value is sensitive wherever it appears in a record.

PackError

A pack document is invalid.

PackSpec

One validated pack.

PATTERNS

PatternSpec

One named structural pattern.

default_patterns

Return the patterns enabled when a policy does not name kinds.

get_pattern

Return one pattern specification by kind.

luhn_ok

Return whether digits satisfies the Luhn checksum.

PatternRiskWarning

A pack pattern has a shape that can backtrack catastrophically.

analyse_pattern

Report the shapes in source that can backtrack catastrophically.

CleanPlan

Everything a cleaner needs to know, and nothing it discovers.

FluentCleanPrompt

Build a CleanPlan one decision at a time.

DEFAULT_LIMITS

Hard bounds on one redaction pass.

DEFAULT_POLICY

Complete, declarative configuration for a redaction pass.

DEFAULT_TAG_STYLE

The placeholder grammar.

ACTIONS

Built-in immutable sequence.

Action

What happens to a value of one kind once it is detected.

Limits

Hard bounds on one redaction pass.

OverlapStrategy

How to arbitrate two detections that share characters.

RedactionPolicy

Complete, declarative configuration for a redaction pass.

TagStyle

The placeholder grammar.

ANSI

Terminal escape sequences used by highlight_placeholders.

highlight_placeholders

Return a copy of text with placeholders wrapped in colour.

restoration_note

Return a one-line, secret-free description of a restoration.

should_colorize

Decide whether to emit terminal colour.

summary_table

Render a table of what was redacted.

Cleaner

Apply one validated plan to text, files, folders and archives.

Encoded

One encoded input: safe text and a report. Holds no removed value.

Item

What happened to one file of a folder or archive.

Vault

A closed mapping from placeholder label to original secret.

decrypt_mapping

Decrypt a mapping produced by encrypt_mapping.

encrypt_mapping

Encrypt every value of mapping, leaving the labels in the clear.

new_key

Generate a fresh vault key.

Entry

One resolved detection and the placeholder label assigned to it.

RedactionResult

Output of a redaction pass.

RestorationResult

Output of a restoration pass.

Span

A half-open [start, end) character interval flagged by one detector.

Stats

Counters describing one redaction pass.

as_dict

Return a JSON-safe, secret-free dictionary for a result object.

CleanPromptError

Base class for every error raised by scikitplot.cleanprompt.

BlockedError

The text holds a value of a kind whose action is block; nothing was returned.

CapabilityError

An optional tier is not usable in this environment.

DetectorError

A detector raised while scanning.

LeakError

Outgoing text still holds a value the vault removed; it was not sent.

LimitExceededError

A policy limit was exceeded.

OverlapError

Two detections overlap under

PatternError

A detection pattern is uncompilable or structurally unsafe.

PatternTimeoutError

A custom pack pattern ran past the pattern time limit on one document.

PolicyError

RestorationError

A placeholder in the text cannot be restored from the supplied vault.

AUDIT_LOGGER_NAME

str(object=’’) -> str

LOGGER_NAME

str(object=’’) -> str

JsonFormatter

Format a record as one JSON object per line.

SecretFilter

Replace known secret surfaces in a record with REDACTION_MARK.

VaultScrubber

Keep a vault’s values out of every log record for as long as it holds them.

audit

Emit one structured audit event on AUDIT_LOGGER_NAME.

configure_logging

Attach a handler to this submodule’s logger.

get_logger

Return a logger under this submodule’s namespace.

log_level_from_env

Return the log level named by the environment, or default.

redacting

Scrub known secrets from log records for the duration of a block.

Catalog

An immutable set of packs and formats.

builtin_catalog

Return the built-in catalog, read from the compiled JSON.

SurrogateSet

A validated set of invented names.

load_surrogate_set

Read and validate a surrogate set from a .yaml, .yml or .json file.

redact_documents

Return corpus documents with every text field redacted by one cleaner.

register_corpus_readers

Let corpus read .docx, .xlsx and .pptx with cleanprompt’s reader.

__bibtex__

str(object=’’) -> str

__citation__

str(object=’’) -> str

citation

Return a BibTeX citation of scikit-plots.

config_context

Context manager for global scikit-plots configuration.

get_config

Retrieve current values for configuration set by set_config.

set_config

Set global scikit-plots configuration.

show_config

Show libraries and system information on which SciPy was built

to_langchain_documents

Convert CorpusDocument instances to LangChain Document.

to_langgraph_state

Convert documents to a LangGraph-compatible state dict.

to_mcp_resources

Convert documents to MCP resources/read response format.

to_mcp_tool_result

Format documents as an MCP tools/call response.

to_huggingface_dataset

Convert documents to a HuggingFace Dataset.

to_rag_tuples

Convert documents to (text, metadata, embedding) tuples.

to_jsonl

Yield documents as newline-delimited JSON strings.

to_numpy_arrays

Convert documents to a dict of NumPy arrays suitable for batch ML.

to_tensorflow_dataset

Convert documents to a tf.data.Dataset.

to_torch_dataloader

Convert documents to a torch.utils.data.DataLoader.

LangChainCorpusRetriever

LangChain-compatible retriever backed by RetrievalIndex.

MCPCorpusServer

MCP server adapter for corpus search.

AgenticRetrievalSession

Ephemeral state for one investigation.

BudgetPolicy

Deterministic, decrementing limits on an investigation.

InvestigationOutcome

The result of a bounded investigation.

InvestigationStatus

How an investigation finished.

RoutePlan

A deterministic decision about which evidence paths to use.

StopReason

Why the loop stopped. Always set – a loop that stops silently is a bug.

SufficiencySignals

The seven deterministic signals, computed before any model judgement.

route

Choose evidence paths by deterministic rule (autonomy level A1).

run_investigation

Run the bounded retrieve/evaluate/refine loop (autonomy level A2).

RoutingPolicy

An ordered set of RoutingRule, one per shape.

RoutingRule

One shape: the words that reveal it and the evidence paths it needs.

QueryShape

The built-in shapes of DEFAULT_ROUTING_POLICY.

DEFAULT_ROUTING_POLICY

An ordered set of RoutingRule, one per shape.

query_tokens

Return the words a routing rule matches against.

extract_archive

Extract an archive to a destination directory.

is_archive

Check if a file path has a supported archive extension.

ANNIndexArtifact

A persisted vector index together with its provenance.

ArtifactError

Raised when an artifact is missing, malformed or incompatible.

ChunkerBase

Abstract base class for all text chunkers.

DefaultFilter

Standard noise filter ported and improved from remarx’s include_sentence.

DocumentReader

Abstract base class for all format-specific document readers.

DummyReader

A no-op reader that validates source existence and accessibility.

FilterBase

Abstract base class for corpus document filters.

PipelineGuard

Wrap any document stream with resilience, deduplication, and checkpointing.

CapabilityStatus

Why a capability is or is not usable.

capability_snapshot

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

distribution_version

Return the installed version of a distribution, or None if absent.

probe_backend

Classify one backend’s availability.

CapabilityRegistry

Explicit, side-effect-free registry for component readiness probes.

CapabilityReport

Read-only readiness state for one optional component.

CapabilitySpec

Declarative probe specification for one optional component.

capability_report

Probe one registered component capability.

component_capabilities

Return JSON-compatible readiness records for components.

default_capability_registry

Return the built-in component readiness registry.

ComponentCatalog

An immutable snapshot of every registered component.

ComponentSpec

Everything the catalog knows about one component.

DiscoveryOutcome

What happened when one source was asked for its components.

DiscoveryStatus

Terminal outcome of asking one source what components it has.

component_catalog

Build a snapshot of every registered component.

ChunkedTextList

A list subclass that carries per-chunk metadata alongside (int, str) pairs.

ChunkerBridge

Adapter that wraps a new-style chunker as a ChunkerBase-

FixedWindowChunkerBridge

Bridge for FixedWindowChunker → ChunkerBase contract.

ParagraphChunkerBridge

Bridge for ParagraphChunker → ChunkerBase contract.

ProtocolChunkerBridge

Bridge for any chunker satisfying ChunkerProtocol (R3-1).

SemanticChunkerBridge

Bridge for SemanticChunker → ChunkerBase contract.

SentenceChunkerBridge

Bridge for SentenceChunker → ChunkerBase contract.

WordChunkerBridge

Bridge for WordChunker → ChunkerBase contract.

bridge_chunker

Wrap chunker in a bridge if it is a new-style chunker.

register_bridge

Register a custom bridge for a user-defined chunker class.

unregister_bridge

Remove a previously registered bridge for chunker_class.

TokenizerProtocol

Structural protocol for word tokenizers.

SentenceSplitterProtocol

Structural protocol for sentence segmenters.

StemmerProtocol

Structural protocol for word stemmers.

LemmatizerProtocol

Structural protocol for word lemmatizers.

FunctionTokenizer

Wrap any Callable[[str], list[str]] as a TokenizerProtocol.

FunctionSentenceSplitter

Wrap any Callable[[str], list[str]] as a SentenceSplitterProtocol.

FunctionStemmer

Wrap any Callable[[str], str] as a StemmerProtocol.

FunctionLemmatizer

Wrap any Callable[[str, Optional[str]], str] as a LemmatizerProtocol.

CustomTokenizerRegistry

Thread-safe module-level registry for named custom components.

register_tokenizer

Register a named TokenizerProtocol implementation.

get_tokenizer

Retrieve a registered tokenizer by name.

register_sentence_splitter

Register a named SentenceSplitterProtocol implementation.

get_sentence_splitter

Retrieve a registered sentence splitter by name.

register_stemmer

Register a named StemmerProtocol implementation.

get_stemmer

Retrieve a registered stemmer by name.

register_lemmatizer

Register a named LemmatizerProtocol implementation.

get_lemmatizer

Retrieve a registered lemmatizer by name.

ScriptType

Dominant Unicode script detected in a text sample.

detect_script

Detect the dominant Unicode script in text.

is_cjk_char

Return True if ch is a CJK / Japanese / Korean character.

is_rtl_char

Return True if ch belongs to a right-to-left script.

split_cjk_chars

Split text into individual CJK character tokens.

MULTI_SCRIPT_SENTENCE_RE_PATTERN

str(object=’’) -> str

ScriptSpan

A contiguous span of text in a single Unicode script.

ScriptSegmenter

Segment NFC-normalised text into contiguous Unicode script spans.

FixedWindowChunker

Produce fixed-size sliding-window chunks over a document.

FixedWindowChunkerConfig

WindowUnit

Unit of measurement for window size and step.

ISO_TO_NLTK

ISO_TO_NAME

NLTK_TO_ISO

NLTK_STOPWORD_LANGUAGES

frozenset() -> empty frozenset object

BUILTIN_LANG_STOPWORDS

coerce_language

Normalise any language specifier into a list of canonical NLTK names.

resolve_stopwords

Return a frozenset of stopwords for one or more languages.

iso_to_nltk

Resolve an ISO 639-1/639-3 code to a canonical NLTK language name.

nltk_to_iso

Resolve a canonical NLTK language name to its primary ISO 639-1 code.

MultilangConfig

Multilang feature flags for any chunker.

MultilangMixin

Shared multilang analysis mixin for all five chunkers.

ParagraphChunker

Split a document into paragraph-level Chunk objects.

ParagraphChunkerConfig

Configuration for ParagraphChunker.

ParentChildChunker

Large parents for context, small children for retrieval, linked.

ParentChildChunkerConfig

RecursiveChunker

Split text by a separator hierarchy until each piece fits a budget.

RecursiveChunkerConfig

Configuration for RecursiveChunker.

SemanticBackend

Semantic chunking backend selector.

SemanticChunker

Embedding-aware, writing-system-aware semantic chunker (Layer 3).

SemanticChunkerConfig

Configuration for SemanticChunker.

SentenceBackend

Supported sentence-splitting backends.

SentenceChunker

Split a document into sentence-level Chunk objects.

SentenceChunkerConfig

Configuration for SentenceChunker.

StructureChunker

Chunk Markdown or reStructuredText by its headings and code blocks.

StructureChunkerConfig

Configuration for StructureChunker.

LemmatizationBackend

Lemmatization backend.

StemmingBackend

Stemming algorithm.

StopwordSource

Stopword list source.

TokenizerBackend

Word tokenisation backend.

WordChunker

Process a document at word level, producing normalised token chunks.

WordChunkerConfig

Configuration for WordChunker.

ArabicMorphologicalStrategy

Arabic and Hebrew morphological segmentation strategy.

CJKCharacterStrategy

Character-level segmentation for Han (Chinese logograph) script.

DeterminativeGroupStrategy

Egyptian Hieroglyph segmentation into determinative groups.

DictionaryBoundaryStrategy

Dictionary-based word boundary detection for no-space scripts.

EthiopicStrategy

Ethiopic (Amharic, Tigrinya) segmentation strategy.

GraphemeClusterStrategy

Grapheme-cluster-level fallback strategy for any script.

IndicAksharaStrategy

Grapheme-cluster segmentation for Indic scripts.

JapaneseStrategy

Multi-tier Japanese segmentation strategy.

KoreanSyllableStrategy

Space-delimited word segmentation for Korean Hangul.

MongolianStrategy

Traditional Mongolian segmentation strategy.

SegmentationStrategy

Protocol for per-script text segmentation strategies.

SpacePunctuationStrategy

Whitespace-and-punctuation segmentation for space-delimited scripts.

TibetanStrategy

Tibetan segmentation strategy.

WritingSystemAdapter

Dispatch per-script segmentation to the correct strategy.

WritingSystemAdapterConfig

BuildResult

Result of a corpus build operation.

BuilderConfig

Configuration for CorpusBuilder.

CorpusBuilder

Unified corpus builder — end-to-end pipeline orchestrator.

BuilderFactories

Component factory callables for FactoryCorpusBuilder.

CustomChunker

Wrap any callable as a ChunkerBase.

CustomEnricherConfig

Custom backend callables for CustomNLPEnricher.

CustomFilter

Wrap any callable as a FilterBase.

CustomNLPEnricher

NLPEnricher extended with

CustomNormalizer

Wrap any callable as a NormalizerBase.

CustomRetrievalIndex

RetrievalIndex extended with a

FactoryCorpusBuilder

HookableCorpusPipeline

PipelineHooks

Lifecycle callbacks for HookableCorpusPipeline.

ErrorCategory

Coarse classification of a diagnostic, for counting and filtering.

ErrorRecord

One structured, serialisable diagnostic.

AnyDownloader

Auto-dispatching downloader with multi-URL and per-parameter list support.

BaseDownloader

Abstract base class for all format-specific URL downloaders.

CustomDownloader

Wraps a user-supplied callable as a BaseDownloader.

DownloadResult

Immutable result object returned by every BaseDownloader.

GitHubDownloader

GitHub URL downloader with automatic blob → raw normalisation.

GoogleDriveDownloader

Google Drive share-link downloader.

WebDownloader

Generic HTTP/HTTPS file downloader.

YouTubeDownloader

YouTube content downloader.

DownloadPlan

Side-effect-free dispatch plan for one URL.

DownloadPolicy

Transport/resource policy shared by Corpus downloaders.

download_policy

Resolve an object, named preset or mapping without hidden global state.

CachePolicy

How EmbeddingEngine uses its disk cache.

CacheStatus

What one cached embedding call did.

CachedEmbeddings

resolve_hub_revision

Return the Hugging Face Hub commit a model id currently points to.

DEFAULT_CACHE_DIR

Path subclass for non-Windows systems.

DEFAULT_MODEL

str(object=’’) -> str

EmbeddingEngine

Multi-backend sentence embedding engine with SHA-256 file caching.

HashEmbedder

Embed text with deterministic signed feature hashing.

DEFAULT_AUDIO_MODEL

str(object=’’) -> str

DEFAULT_IMAGE_MODEL

str(object=’’) -> str

DEFAULT_TEXT_MODEL

str(object=’’) -> str

LLMTrainingExporter

Export a corpus with embeddings to LLM training formats.

MultimodalEmbeddingEngine

Unified embedding engine for any CorpusDocument

EmbeddingManifest

Identity of one embedding generation.

IncompatibleEmbeddingsError

Raised when vectors from incompatible generations would be combined.

BUILTIN_STOPWORDS

frozenset() -> empty frozenset object

EnricherConfig

Configuration for NLPEnricher.

NLPEnricher

Pipeline component that populates NLP enrichment fields on

SimpleEnricherSpec

Declarative configuration for SimpleFrequencyEnricher.

SimpleFrequencyEnricher

Populate tokens and deterministic frequency-ranked keywords.

hit_rate_at_k

Fraction of queries with at least one relevant identifier in the first k.

mean_average_precision

Mean average precision (MAP), normalised by all relevant identifiers.

mean_reciprocal_rank

Mean of 1 / rank of the first relevant identifier (MRR).

ndcg_at_k

Normalised discounted cumulative gain (nDCG@k) over graded judgments.

precision_at_k

Fraction of the first k ranked identifiers that are relevant.

r_precision

Precision at |R|, the number of relevant identifiers of each query.

ranking_metrics

Compute several ranking metrics in one validated pass.

recall_at_k

Fraction of the relevant identifiers found in the first k.

binary_log_loss

Mean negative log-likelihood of binary outcomes under the probabilities.

brier_score

Mean squared difference between probabilities and binary outcomes.

calibration_report

Every calibration measure for one set of labelled probabilities.

expected_calibration_error

Count-weighted mean absolute gap between prediction and observation.

reliability_table

Per-bin mean predicted probability against observed relevance frequency.

CALIBRATION_STRATEGIES

Built-in immutable sequence.

anls_score

Average normalised Levenshtein similarity (ANLS).

edit_similarity

Return 1 - levenshtein(a, b) / max(len(a), len(b)).

edit_similarity_score

Mean normalised edit similarity between predictions and references.

exact_match_score

Fraction of predicted answers equal to a reference after normalisation.

normalize_answer

Normalise an answer string for comparison.

token_f1_score

Token-overlap F1 between predicted and reference answers (SQuAD style).

ScorerBackendInfo

Which base class the corpus scorers use in this process.

get_corpus_scorer

Return a new scorer for a metric name.

get_corpus_scorer_names

Return the names get_corpus_scorer accepts.

make_corpus_scorer

Make a scikit-learn compatible scorer from a corpus metric.

scorer_backend_info

Report which base class corpus scorers use in this process.

EvaluationComparison

Paired comparison of two evaluations of the same queries.

MetricComparison

QueryEvaluation

RetrievalEvaluation

evaluate_retrieval

Run retriever on every query and score the rankings.

UndefinedMetricWarning

A metric is undefined for some queries and was scored by zero_division.

ranked_ids

Return the identifiers of retrieval results, in rank order.

CacheError

The response cache failed (a configuration problem, not a model failure).

Completion

One model response.

IncompleteCompletionError

A completion that did not end normally (cut off, filtered, refused).

LLM

A language model behind one call shape; made by make_llm.

make_llm

Make an LLM for OpenAI, Anthropic, Gemini or a callable.

JudgeParseError

A judge’s response that is not a valid verdict.

JudgeResult

One judged score.

LLMJudge

Judge answers and contexts with a language model.

context_texts

Return the texts of retrieved contexts, in order.

parse_verdict

Parse a judge response strictly.

AnswerEvaluation

AnswerItem

PreferenceEvaluation

evaluate_answers

Evaluate a system’s answers with text metrics and LLM judges.

evaluate_preference

Judge two systems’ answers head to head, in both orders.

cohen_kappa

Cohen’s kappa between two raters of the same items.

fleiss_kappa

Fleiss’ kappa for any number of raters with nominal labels.

krippendorff_alpha

Krippendorff’s alpha for any number of raters, with missing ratings.

export_documents

Export a list of documents to output_path in the given format.

load_documents

And

All sub-expressions must match. Empty And matches everything.

Eq

field == value.

Exists

The field is present and not None.

Filter

Base class for filter expressions.

FilterCapability

A backend’s declared answer for the operators in one expression.

In

field in values.

Not

Negates a sub-expression.

NotEq

field != value.

NotIn

field not in values; a missing field does not match.

Or

At least one sub-expression must match. Empty Or matches nothing.

Range

lo <= field <= hi, with either bound optional.

SecurityFilter

A scope bound to an index and AND-ed with every query’s own filter.

UnsupportedOperatorError

Raised when a backend is asked to evaluate an operator it rejects.

filter_from_dict

Rebuild a filter expression from its JSON form, refusing anything off contract.

filter_to_dict

Return the JSON form of a filter expression.

filterable_fields

Return the document fields a filter may name.

validate_filter

Return expression checked and frozen to the JSON-able form.

IndexGeneration

Identity of one built index.

derive_generation

Derive the generation identity for a set of documents.

DocIdScheme

How a corpus build names its documents.

IDENTITY_HEX_WIDTH

int([x]) -> integer

IncompatibleSchemaError

Raised for data written by another generation of the document schema.

UUID7Generator

Monotonic generator of RFC 9562 UUID version 7 identifiers.

assign_doc_ids

Return documents named by scheme, with parent links kept intact.

doc_id_scheme_of

Return the scheme that produced doc_id, judged by its exact form.

uuid7

Return a new RFC 9562 UUID version 7 from this process’s generator.

uuid7_unix_ms

Return the Unix time in milliseconds that a UUID version 7 carries.

EdgeTrust

How an edge came to exist.

GraphEdge

One relationship, with the provenance every edge must carry.

GraphNode

One node in the derived graph.

GraphQuery

A bounded traversal request.

GraphResponse

The outcome of a traversal, including why it stopped.

NodeKind

What a graph node represents.

RelationType

The kind of relationship an edge asserts.

derive_graph

Build the G0 view from document fields.

HierarchyReport

Outcome of validating a document hierarchy.

ancestors

Return the chain from doc_id’s parent up to the root.

children

Return the direct children of doc_id.

descendants

Yield all descendants of doc_id, breadth-first.

validate_hierarchy

Check referential integrity, cycles and depth of the hierarchy.

CollectionManifest

Descriptor for a named corpus collection.

CorpusStats

Aggregate statistics over a

compute_stats

Compute aggregate statistics over a document collection.

provenance_from_filename

Extract provenance metadata from a source filename using heuristics.

DedupLinesNormalizer

Remove exact duplicate lines while preserving first-occurrence order.

GraphemeClusterNormalizer

Normalize text to NFC and compute grapheme cluster boundaries.

HTMLStripNormalizer

Remove HTML and XML tags from the document text.

LanguageDetectionNormalizer

Detect document language and set CorpusDocument.language.

LowercaseNormalizer

Convert the document text to lowercase.

NormalizationPipeline

Apply a sequence of normalisers in order.

NormalizerBase

Abstract base class for all text normalisers.

UnicodeNormalizer

Apply Unicode normalisation (NFC, NFD, NFKC, or NFKD).

WhitespaceNormalizer

Collapse runs of whitespace and optionally strip leading/trailing space.

TextNormalizer

Pipeline component that populates normalized_text on

TextNormalizerConfig

Configuration for TextNormalizer.

normalize_text

Normalise text according to config.

CorpusPipeline

Orchestrates the full corpus ingestion pipeline.

PipelineResult

Immutable summary of a single pipeline run.

create_corpus

Create and export a corpus from a single source file.

CONFIG_DOMAINS

Built-in immutable sequence.

ConfigConflictError

Raised when one domain is configured twice without an explicit intent.

CorpusPlan

An immutable, canonical description of a corpus configuration.

FluentCorpus

Immutable fluent builder over a CorpusPlan.

ALTOReader

ALTO XML reader for scanned document archives.

AudioReader

Text extraction from audio files via companion transcript/lyrics parsing,

CustomReader

Fully user-customizable reader for any file extension and resource type.

normalize_extractor_output

Coerce an extractor return value to a list of raw chunk dicts.

ImageReader

OCR-based text extraction from raster image files.

OfficeReader

Read office documents: Office Open XML and OpenDocument.

PDFReader

PDF document reader with pdfminer.six → pypdf cascade.

MarkdownReader

Markdown document reader.

ReSTReader

reStructuredText document reader.

TextReader

Plain-text document reader.

VideoReader

Text extraction from video files via subtitle parsing and/or

WebReader

Fetch a web page and extract structured text via BeautifulSoup.

YouTubeReader

Extract the transcript of a YouTube video using youtube-transcript-api.

TEIReader

TEI/XML document reader with dramatic structure extraction.

XMLReader

Generic XML document reader with configurable XPath.

ArchiveBudgetError

Raised when the members of an archive tree inflate past its extraction budget.

ArchiveNestingError

Raised when archive nesting exceeds max_depth (nested-archive bomb).

ZipReader

Generic ZIP archive reader — dispatches each member to its natural reader.

ComponentRegistry

Central look-up table for corpus pipeline components.

registry

Central look-up table for corpus pipeline components.

LegKind

Which evidence path a leg represents.

LegOutcome

How one evidence path fared.

LegStatus

Outcome of one evidence path.

RetrievalResponse

Hits plus the story of how they were obtained.

RetrievalStatus

Outcome of a retrieval operation as a whole.

DenseRetriever

Vector-similarity evidence path.

FusedItem

One item of a fused ranking.

FusionContribution

One leg’s share of a fused item’s score.

FusionPolicy

Weighted reciprocal rank fusion with one tie-break and returned contributions.

GraphRetriever

Relationship-traversal evidence path.

LegContribution

One leg’s contribution to a fused hit.

LegResult

What one leg produced, and how it went.

LexicalRetriever

Keyword / BM25 evidence path.

LogOddsContribution

One leg’s evidence for one fused item.

LogOddsFusedItem

One item of a probability-fused ranking.

LogOddsFusion

Pool calibrated legs as log-odds evidence into probabilities of relevance.

LogOddsFusionResult

A fused ranking and the diagnostics needed to trust it.

CUT_MODES

Built-in immutable sequence.

CachedSearch

Exact, bounded cache in front of one retrieval index.

CutPolicy

A rule for how many ranked hits to keep.

CutResult

Where a list was cut, and why.

PROBABILITY_FUSION_LEGS

Built-in immutable sequence.

ProbabilityFusion

Opt-in probability fusion for hybrid search: a policy and a calibrator per leg.

Retriever

Base class for an independent evidence path.

fuse_by_rank

Combine leg results by weighted reciprocal rank fusion.

CharBudgetCompressor

Keep each hit’s text, best first, until a character budget is spent.

ContextPassage

The context a compressor kept from one hit.

ExecutionResult

Ranked hits plus the account of every stage.

PlannedHit

One ranked hit of a plan, with the score of each stage that ranked it.

RetrievalExecutionPlan

Run retrieval through typed, bounded stages.

StageBudget

Deterministic limits on the retrieve stage.

StageKind

One stage of a plan, in execution order.

StageOutcome

How one stage fared.

StageStatus

Outcome of one stage.

CorrectionResult

The returned hits, the verdict, and every round.

CorrectionRound

One round: the query run, how it was graded, what came back.

CorrectionVerdict

What the corrective retrieval came to.

CorrectiveRetrieval

Grade, then accept, retry with a rewritten query, or abstain (CRAG).

EvidenceGrade

How a grader judged one round’s hits.

GradeResult

One grader’s judgement of one round.

TermCoverageGrader

Grade hits by the share of the query’s words their text contains.

RuntimeCorpus

Materialized operational view of a validated CorpusPlan.

RuntimePolicy

Execution-boundary policy applied by RuntimeCorpus.

materialize_plan

Resolve a validated CorpusPlan into runtime components.

runtime_policy

Resolve a runtime policy object, preset name, or mapping.

CorpusPolicyBundle

Typed composition of the independent Corpus policy dimensions.

corpus_policy_bundle

Resolve a policy bundle object, named preset, or mapping.

BackendCandidate

One lazy backend attempt.

BackendOutcome

Structured, serialisable outcome from run_backend_chain.

BackendPlan

Side-effect-free preflight of candidate ordering and policy eligibility.

BackendPolicy

Policy for selecting and exhausting optional backend chains.

BackendSkip

Why a backend was not executed under the resolved policy.

BackendStatus

Outcome of one ordered backend operation.

backend_policy

Resolve an object, named preset or mapping without hidden global state.

plan_backend_chain

Resolve backend order/readiness without executing a backend.

run_backend_chain

Try candidates in order and return a structured outcome.

ASRBackend

User-defined ASR backend adapter.

ASRRequest

Stable immutable request passed to user-provided ASR backends.

WHISPER_MODELS

Built-in immutable sequence.

asr_segment_metadata

Return user/backend metadata without allowing core-field shadowing.

plan_whisper_backends

Plan the exact ASR chain without importing/loading/running a model.

transcribe_whisper

Transcribe media with a shared, policy-driven ASR backend chain.

HAMLET_TEXT

str(object=’’) -> str

SectionType

Semantic label for the role of a text chunk within its source document.

ChunkingStrategy

Describes how a CorpusDocument was segmented from raw text.

ExportFormat

Supported serialisation targets for a completed corpus.

SourceType

Semantic label for the kind of source from which a document was read.

MatchMode

Search mode for intertextual matching queries against a corpus index.

Modality

Primary content modality of a CorpusDocument.

ErrorPolicy

Per-document error handling behaviour for PipelineGuard.

CorpusDocument

Canonical representation of a single text chunk in a processed corpus.

documents_to_pandas

Convert a list of CorpusDocument instances to a

documents_to_polars

Convert a list of CorpusDocument instances to a

DEFAULT_BACKEND_ORDER

Built-in immutable sequence.

AnnoyBackend

ANN backend over a scikit-plots Annoy Index (default backend).

BruteForceBackend

Exact cosine similarity via a normalised dot product.

FaissBackend

ANN backend over a FAISS IndexFlatIP on normalised vectors.

FallbackRefusedError

A fallback was needed and allow_fallback=False refused it (R2-5).

VectorIndexBackend

Uniform contract for a dense vector index.

VoyagerBackend

ANN backend over a Voyager cosine-space index.

list_available_backends

Return the canonical names of currently importable backends.

select_backend

Construct an ANN backend by name.

RetrievalConfig

Configuration for similarity search.

RetrievalHit

A single search result.

RetrievalIndex

Multi-mode similarity index over CorpusDocument collections.

LevenshteinRanker

Ranker by normalised Levenshtein similarity, with backend provenance.

PairwiseRanker

Ranker built from a pairwise relevance function.

make_levenshtein_ranker

Make a CustomRetrievalIndex ranker by Levenshtein similarity.

make_pairwise_ranker

Make a CustomRetrievalIndex ranker from a pairwise function.

CorpusSource

Declarative descriptor for one or more document sources.

SourceEntry

A single resolved source entry yielded by CorpusSource.iter_entries.

SourceKind

Discriminant for the kind of source an entry represents.

FilterSupport

How a backend handled one requested filter.

InMemoryStorage

Thread-safe in-memory dict store.

JSONLStorage

Append-friendly JSONL (newline-delimited JSON) flat-file store.

QueryResult

Result container returned by StorageBase.query.

SQLiteStorage

SQLite-backed corpus store with FTS5 full-text search.

StorageBase

Abstract base class for all corpus storage backends.

StorageQuery

Query parameters for StorageBase.query.

MetadataDict

CharOffset

int([x]) -> integer

TokenId

int([x]) -> integer

BowVector

Built-in mutable sequence.

EmbeddingVector

Built-in mutable sequence.

DocumentStatus

Lifecycle state of a CorpusDocument in the corpus pipeline.

ContentType

MIME-style content type for raw document payloads.

StorageBackend

Storage backend identifiers for the corpus store.

NormalizerType

Normalisation step identifiers for pipeline ordering.

Chunk

A single unit of text produced by a chunker.

ChunkResult

Container returned by every ChunkerProtocol implementation.

ChunkerConfig

Abstract base configuration for all chunker implementations.

SourceConfig

Abstract base configuration for document source implementations.

NormalizerConfigBase

Abstract base configuration for text normaliser implementations.

StorageConfig

Abstract base configuration for storage backend implementations.

PipelineStep

Descriptor for a single step in a PipelineConfig.

PipelineConfig

Full pipeline configuration composed of ordered steps.

EmbeddedChunk

A Chunk decorated with a dense embedding vector.

RetrievalQuery

A query submitted to the corpus retrieval layer.

ChunkHit

A single result returned from the corpus retrieval layer.

CorpusRecord

A persisted record combining a Chunk with storage metadata.

ChunkerProtocol

Structural interface every chunker must satisfy.

NormalizerProtocol

Structural interface every text normaliser must satisfy.

SourceProtocol

Structural interface every document source must satisfy.

StorageProtocol

Structural interface every storage backend must satisfy.

ChunkerRegistration

An entry in the ChunkerRegistry.

ValidationError

A single validation failure raised during corpus processing.

ValidationResult

Aggregate result of a validation pass.

TrainingExample

A single example in an LLM fine-tuning dataset.

TrainingDataset

A named collection of TrainingExample objects.

ToolCallInput

Input payload for a Model Context Protocol tool call.

ToolCallResult

Result returned from a Model Context Protocol tool call.

SemantemeInfo

Rich semantic unit descriptor attached to each multilang chunk.

PreprocessingStep

Record of a single preprocessing transformation applied to raw text.

PreprocessingTrace

Ordered audit trail of all preprocessing transformations.

MultilangChunkMeta

Per-chunk multilang analysis bundle — stored in chunk.metadata.

URLKind

Classification of a URL for routing to the correct handler.

classify_url

Classify a URL into one of the known URLKind categories.

download_url

Download a URL to a local file.

infer_extension

Infer a file extension from HTTP response headers and URL path.

probe_url_kind

Probe a URL with a HEAD request to classify by Content-Type.

resolve_url

Resolve a provider-specific URL to a direct-download URL.

API_STABILITY

A dict that populates itself from the package __all__ on first use.

Stability

Stability tier of a public API symbol.

api_stability

Return the Stability tier of a public API symbol.

list_api

Return the sorted public symbol names in a given stability tier.

DEFAULT_COMPILER_DIRECTIVES

build_extension_module

Compile and import an extension module (module-only convenience wrapper).

build_extension_module_result

Compile and import an extension module, with deterministic caching.

build_extension_package_from_code_result

Compile a package of multiple extension modules from in-memory code strings.

build_extension_package_from_paths_result

Compile a package of multiple extension modules from existing .pyx files.

CACHE_SCHEMA_VERSION

int([x]) -> integer

CacheEntry

A compiled module cache entry.

PackageCacheEntry

A compiled package cache entry (multi-module build).

find_entries_by_name

Find module cache entries matching an exact module name.

find_entry_by_key

Find a single module cache entry by key.

find_package_entry_by_key

Find a single package cache entry by key.

is_meta_schema_compatible

Return whether meta can be trusted by the current reader.

is_valid_key

Return True if key is a valid cache key.

iter_all_entry_dirs

Return all cache entry directories whose name is a valid cache key.

iter_cache_entries

List module cache entries found under the cache directory.

iter_package_entries

List package cache entries found under the cache directory.

make_cache_key

Create a deterministic cache key from a JSON-serializable mapping.

meta_schema_version

Return the schema version recorded in meta (0 if absent/legacy).

peek_cache_dir

Resolve the cache directory path without creating it.

read_meta

Read meta.json from a build directory.

register_artifact_path

Register an existing compiled extension artifact into the cache registry.

resolve_cache_dir

Resolve and create the cache directory.

runtime_fingerprint

Compute a runtime fingerprint for caching correctness.

source_digest

SHA-256 digest of source bytes.

write_meta

Write meta.json in the build directory atomically.

CustomCompilerProtocol

Structural protocol for custom compiler callables.

CompilerRegistry

Thread-safe module-level registry of custom compiler callables.

register_compiler

Register a custom compiler in the module-level registry.

get_compiler

Retrieve a registered custom compiler by name.

list_compilers

Return sorted list of registered custom compiler names.

CompilerCapabilities

Versioned, declarative description of a custom compiler’s capabilities.

compiler_capabilities

Return the CompilerCapabilities a compiler declares.

COMPILER_SPEC_VERSION

int([x]) -> integer

pure_python_prereqs

Check prerequisites pure Python, setuptools only.

cython_cpp_prereqs

Check prerequisites compile C++ via Cython.

full_stack_prereqs

Check prerequisites full stack setuptools, Cython, pybind11, and NumPy.

pybind11_only_prereqs

Check prerequisites pybind11 only.

c_api_prereqs

Check prerequisites own custom C-API.

pybind11_include

Return the pybind11 include directory, or None if not installed.

numpy_include

Return the NumPy C-API include directory, or None if not installed.

collect_c_api_sources

Collect C/C++ source files from one or more files, directories, or globs.

collect_header_dirs

Collect unique directories that contain C/C++ header files.

PybindCompiler

Built-in custom compiler: pybind11-only projects.

CApiCompiler

Built-in custom compiler: NumPy C-API projects.

cache_stats

Compute cache statistics.

gc_cache

Deterministically garbage-collect cached build entries.

import_extension

Import an extension module from an explicit artifact path.

import_extension_from_bytes

Import an extension module from raw artifact bytes.

import_extension_from_path

Import an extension module from a filesystem path.

build_lock

Acquire an exclusive build lock via atomic directory creation.

PinRegistryError

Raised when the pin registry (pins.json) is corrupt or unreadable.

list_pins

List the current alias→key mappings.

pin

Pin a cache key under a human-friendly alias.

resolve_pinned_key

Resolve an alias to a cache key.

unpin

Remove an alias pin.

AppliedProfile

Result of applying a profile with user-precedence rules.

PlatformCapabilities

Declarative contract describing what the current platform supports.

ProfileDefaults

Normalized defaults produced by resolving a profile.

ResolvedToolchain

The compiler the build backend actually selects (CYTHON-PORT-001).

RuntimeCapabilities

Declared contract for native-extension runtime lifecycle (CYTHON-ABI-001).

UnsupportedRuntimeError

Raised when a runtime lifecycle operation is not supported (CYTHON-ABI-001).

apply_profile

Apply a profile with strict, three-state precedence.

check_runtime_supported

Fail fast on an unsupported runtime configuration (CYTHON-ABI-001).

is_windows

Return True if the host operating system is native Windows.

platform_capabilities

Return the PlatformCapabilities contract for this process.

resolve_profile

Resolve a profile name to deterministic defaults.

resolved_toolchain

Return the compiler the build backend actually selects (CYTHON-PORT-001).

runtime_capabilities

Return the RuntimeCapabilities contract for this process.

build_package_from_code

Build and import a multi-module extension package and return loaded modules.

build_package_from_code_result

Build and import a multi-module extension package from code strings.

build_package_from_paths

Build and import a multi-module extension package and return loaded modules.

build_package_from_paths_result

Build and import a multi-module extension package from .pyx file paths.

check_build_prereqs

Check whether build prerequisites are importable.

compile_and_load

Compile and import a Cython extension module and return the loaded module.

compile_and_load_result

Compile and import a Cython extension module from source text.

cython_import

Compile/import a Cython module from a .pyx file and return the loaded module.

cython_import_all

Compile and import all .pyx files in a directory.

cython_import_all_result

Compile and import all .pyx files in a directory, with a partial report.

cython_import_result

Compile/import a Cython module from a .pyx file.

export_cached

Export a cache entry directory to a destination folder.

get_cache_dir

Resolve (and create) the cache root directory.

import_artifact_bytes

Import a compiled extension artifact from raw bytes.

import_artifact_path

Import a compiled extension artifact from a path.

import_cached

Import a cached module entry and return the loaded module.

import_cached_by_name

Import the newest cached module entry matching module_name.

import_cached_package

Import a cached package and return the loaded modules.

import_cached_package_result

Import a cached package entry by cache key.

import_cached_result

Import a cached module entry by cache key.

import_pinned

Import a pinned alias and return the loaded module(s).

import_pinned_result

Import a pinned alias.

list_cached

List cached module entries.

list_cached_packages

List cached package entries.

purge_cache

Delete the entire cache directory.

register_cached_artifact_bytes

Register a compiled extension artifact from bytes and import it.

register_cached_artifact_path

Register an existing compiled extension artifact on disk, then import it.

BatchBuildError

Raised by fail-fast batch builds, carrying the partial result.

BatchBuildResult

Structured result of a batch compile/import (CYTHON-BATCH-001).

BatchFailure

A single failure within a batch build (CYTHON-BATCH-001).

BuildResult

Result of compiling/importing a single Cython extension module.

CacheGCResult

Result of a cache garbage-collection operation.

CacheStats

Cache statistics for the compiled-artifact cache root.

PackageBuildResult

Result of compiling/importing a package of extension modules.

DEFAULT_SECURITY_POLICY

Immutable security policy applied to build inputs before compilation.

RELAXED_SECURITY_POLICY

Immutable security policy applied to build inputs before compilation.

SecurityError

Raised when a build input violates the active SecurityPolicy.

SecurityPolicy

Immutable security policy applied to build inputs before compilation.

is_safe_compiler_arg

Return True when a compiler argument string is safe to pass.

is_safe_macro_name

Return True when a C preprocessor macro name is safe to define.

is_safe_path

Return True when a filesystem path does not contain traversal sequences.

validate_build_inputs

Validate build inputs against a SecurityPolicy.

TEMPLATE_SCHEMA_VERSION

int([x]) -> integer

TemplateInfo

Structured metadata for a template.

TemplateValidationError

Raised when template metadata fails strict schema validation.

build_package_example

Build and import a multi-module package example and return loaded modules.

build_package_example_result

Build and import a multi-module package example and return a structured result.

compile_template

Compile and import a Cython template and return the loaded module.

compile_template_result

Compile and import a Cython template and return a structured result.

copy_workflow

Copy a workflow template folder to a destination directory.

generate_sphinx_template_docs

Generate Sphinx .rst pages listing templates and their usage.

get_package_example_path

Resolve a package example name to its on-disk folder path.

get_template_path

Resolve a template ID to an on-disk path.

get_workflow_path

Resolve a workflow name to its on-disk folder path.

list_package_examples

List available multi-module package examples.

list_templates

List available templates.

list_workflows

List available workflow template folders.

load_package_example_metadata

Load package example metadata from package.meta.json.

load_template_metadata

Load template metadata from an adjacent *.meta.json file.

read_template

Read template source text.

read_template_info

Read metadata for a template and return a TemplateInfo.

template_root

Return the on-disk template root directory.

validate_template_info

Strictly validate template metadata against the schema (CYTHON-TPL-002).

verify_template_assets

Verify every referenced template support asset is actually shipped.

workflow_cli_template_path

Return the workflow CLI template path.

sanitize

Convert an arbitrary string into a valid, collision-resistant module name.

get_data_home

Return a path to the cache directory for example datasets.

get_dataset_names

Report available example datasets, useful for reporting issues.

load_dataset

Load an example dataset from the online repository (requires internet).

print_labels

Display a legend for the abbreviations of decile table column names.

decile_table

Generate the Decile Table from labels and probabilities.

plot_cumulative_gain

Generate the Decile-wise Lift Plot from labels and probabilities.

plot_lift

Generate the Decile based cumulative Lift Plot from labels and probabilities.

plot_lift_decile_wise

Generate the Decile-wise Lift Plot from labels and probabilities.

plot_ks_statistic

Generate the KS Statistic Plot from labels and probabilities.

report

Generate a decile table and four plots.

ModelPlotPy

ModelPlotPy decile analysis.

ModelPlotPy

Decile/ntile analysis for sklearn classifiers.

summarize_selection

Return a standardized summary row per group at a selected ntile.

plot_response

Plot response curve.

plot_cumresponse

Plot cumulative response curve.

plot_cumlift

Plot cumulative lift curve.

plot_cumgains

Plot cumulative gains curve.

plot_all

Plot response, cumulative response, cumulative lift, and cumulative gains as a 2x2 panel.

plot_costsrevs

Plot costs and revenues curves.

plot_profit

Plot profit curve.

plot_roi

Plot ROI (return on investment) curve.

ScikitplotException

Generic exception thrown to surface failure information about external-facing operations.

CommandError

Raised when there is an error in command-line arguments.

ExecutionException

Exception thrown when executing a project fails.

InvalidUrlException

Exception thrown when a http request fails to send due to an invalid URL.

MissingConfigException

Exception thrown when expected configuration file/directory not found.

ScikitplotTracingException

Exception thrown from tracing logic.

ScikitplotTraceDataException

Exception thrown for trace data related errors.

ScikitplotTraceDataCorrupted

Exception thrown when trace data is corrupted.

ScikitplotTraceDataNotFound

Exception thrown when trace data is not found.

AxisError

Axis supplied was invalid.

DTypePromotionError

Multiple DTypes could not be converted to a common one.

TooHardError

max_work was exceeded.

ScikitplotWarning

The base warning class from which all scikit-plots warnings should inherit.

ScikitplotUserWarning

The primary warning class for scikit-plots.

ScikitplotDeprecationWarning

A warning class to indicate a deprecated feature.

ScikitplotPendingDeprecationWarning

A warning class to indicate a soon-to-be deprecated feature.

ScikitplotBackwardsIncompatibleChangeWarning

A warning class indicating a change in scikit-plots that is incompatible

DuplicateRepresentationWarning

A warning class indicating a representation name was already registered.

ComplexWarning

The warning raised when casting a complex dtype to a real dtype.

ModuleDeprecationWarning

Module deprecation warning.

RankWarning

Matrix rank warning.

VisibleDeprecationWarning

Visible deprecation warning.

profile_features

FeatureSchema

Immutable, fitted description of a table’s columns.

FeatureSpec

Everything a fitted schema knows about one column.

FeatureStats

Training statistics of one column.

FeaturePolicy

Complete, declarative description of how to profile a table.

ColumnRule

Select columns by exact name and/or shell-style pattern.

AssessmentSpec

Which provider answers one assessment question, with which parameters.

BinningPolicy

How bin recommendations are computed for numeric features.

DriftPolicy

How a drift reference is frozen and judged.

DEFAULT_ASSESSMENTS

load_policy

Load a FeaturePolicy from a file, a mapping or a policy.

dump_policy

Write policy to path atomically, verified by reading it back.

Assessment

The recorded answer to one assessment for one feature.

AssessmentContext

What a provider may read about one feature.

AssessmentOutcome

What a provider returns: a state, reason codes and evidence.

AssessmentProvider

A named, versioned function that answers one kind of question.

AssessmentRegistry

Name table of assessment providers.

default_registry

Name table of assessment providers.

register_assessment

Register an assessment provider; usable as a decorator.

list_assessment_providers

Tabulate registered providers.

BinningRecommendation

A frozen bin recommendation for one feature.

knuth_bin_count

Return the equal-width bin count that maximises Knuth’s posterior.

make_kbins_discretizer

Build a KBinsDiscretizer with the recommended per-feature bin counts.

FeatureProfiler

Fit a feature schema on the training data; pass data through unchanged.

FeatureFilter

Drop features whose assessments are true, and columns with non-feature roles.

FeatureColumnSelector

Column selector for ColumnTransformer driven by a feature schema.

FeatureRenamer

Rename columns with a plan frozen at fit time.

RenamePlan

A complete, frozen old -> new name mapping.

trace_pipeline

Trace the feature lineage of a fitted estimator.

FeatureLineage

Traced feature graph of a fitted pipeline.

FeatureMapping

How one transformer’s outputs derive from its inputs.

Attribution

Values of transformed features summed back onto raw input features.

ReferenceProfile

Frozen training distribution of every compared feature.

FeatureReference

Frozen reference buckets of one feature.

analysis_plan

Route every feature to the plots, summaries and tests that fit its kind.

recommend_treatments

Recommend an ordered preprocessing chain per feature.

treatment_groups

Group features that share the same recommended chain.

DEFAULT_ANALYSIS_RULES

AssessmentState

Outcome of one assessment of one feature.

DtypeFamily

Physical storage family of a column, read from its pandas dtype and values.

FeatureKind

Semantic kind of a feature: what analyses and treatments make sense.

FeatureRole

Role of a column in a modelling task; only FEATURE columns are model inputs.

LineageQuality

How strongly a lineage edge is supported.

Relation

How the outputs of one pipeline stage relate to its inputs.

FeatureSelectionError

Base class of every error raised by scikitplot.feature_selection.

PolicyError

A policy or configuration document is off contract (unknown key, wrong type, bad range).

SchemaMismatchError

Data given after fitting does not match the fitted schema (missing, extra or retyped columns).

SchemaMismatchWarning

Later data differs from the fitted schema and on_mismatch="warn" let it through.

IncompatibleSchemaError

A persisted artefact was written by another, unsupported schema generation.

LineageError

A pipeline’s feature topology cannot be traced or does not reconcile with its output.

ANNImputer

Approximate K-nearest-neighbours (KNN) imputer with pluggable ANN backends.

MissingIndicator

Binary indicators for missing values.

SimpleImputer

Univariate imputer for completing missing values with simple strategies.

BackendInfo

Read-only description of one implementation backend.

Match

One ranked fuzzy-match result with actual backend provenance.

available_backends

Return backend capability records in preferred order.

backend_info

Return capability information for one backend.

closest

Return the closest choice, or None for an empty iterable.

distance

Return the Levenshtein edit distance between two sequences.

normalized_distance

Return distance normalised to [0, 1] by maximum sequence length.

normalized_similarity

Return normalised Levenshtein similarity in [0, 1].

rank

Rank choices from most to least similar to query.

similarity

Return max(len(a), len(b)) - distance(a, b).

CRITICAL

int([x]) -> integer

DEBUG

int([x]) -> integer

ERROR

int([x]) -> integer

FATAL

int([x]) -> integer

INFO

int([x]) -> integer

NOTSET

int([x]) -> integer

WARN

int([x]) -> integer

WARNING

int([x]) -> integer

AlwaysStdErrHandler

A custom logging handler inherited from StreamHandler.

GoogleLogFormatter

A custom logging formatter inherited from Formatter.

getEffectiveLevel

Return the effective level for the scikit-plots logger.

get_logger

Return SP (scikitplot) logger instance.

get_verbosity

Return the current verbosity level.

setLevel

Set the logger’s level.

set_verbosity

Set the verbosity level.

BASIC_FORMAT

str(object=’’) -> str

Filter

Filter instances are used to perform arbitrary filtering of LogRecords.

Formatter

Formatter instances are used to convert a LogRecord to text.

Handler

Handler instances dispatch logging events to specific destinations.

LogRecord

A LogRecord instance represents an event being logged.

Logger

Instances of the Logger class represent a single logging channel. A

NullHandler

This handler does nothing. It’s intended to be used to avoid the

StreamHandler

A handler class which writes logging records, appropriately formatted,

getLevelName

Return the textual or numeric representation of logging level ‘level’.

getLogger

Return a logger with the specified name, creating it if necessary.

log

Log a message at the specified log level.

log_every_n

Log once per n calls from the same call site.

log_first_n

Log only for the first n calls from the same call site.

log_if

Log only if a condition is True.

vlog

Log a message at the specified log level.

debug

Log a message at the DEBUG log level.

info

Log a message at the INFO log level.

warning

Log a message at the WARNING log level.

warn

Log a message at the WARN -> WARNING log level.

error

Log a message at the ERROR log level.

error_log

Log an error-like message at a specified level.

exception

Log a message with severity ‘ERROR’ on the root logger.

TaskLevelStatusMessage

Compatibility wrapper for legacy call sites.

critical

Log a message at the CRITICAL log level.

fatal

Log a message at the FATAL -> CRITICAL log level.

assert_capability_vocabulary_matches_corpus

Verify this module’s capability vocabulary still matches Corpus’s.

effective_server_capabilities

Return the effective surface for a specific server configuration.

server_capabilities

Return the static / potential tool/resource inventory, without importing

server_runtime_status

Report, without importing the MCP SDK, whether the protocol server can

DOC_ID_RE

Compiled regular expression object.

MAX_CHUNK_CHARS

int([x]) -> integer

MAX_QUERY_CHARS

int([x]) -> integer

MAX_RESOURCE_CHARS

int([x]) -> integer

MAX_RESULTS

int([x]) -> integer

RESOURCE_METADATA_ALLOWANCE

int([x]) -> integer

DocsRetriever

Structural contract every retrieval backend must satisfy.

RetrievedChunk

One retrieved passage with the metadata needed to cite it.

SearchCoordinator

Validated, concurrency-bounded search orchestration, free of wire models.

build_search_docs_result

Format retrieval results as an MCP tools/call response with citations.

is_valid_doc_id

Return whether value is an acceptable document identifier.

CorpusAnnoyRetriever

Docs dense retriever backed by an embedder + a vector index + a document lookup.

CorpusIndexRetriever

Text-level retriever over a corpus RetrievalIndex: hybrid by default.

Embedder

Anything that turns a query string into a vector (e.g. corpus EmbeddingEngine).

VectorIndex

Anything that returns (doc_id, score) pairs for a query vector.

DEFAULT_RRF_K

int([x]) -> integer

Bm25Retriever

Lexical retriever (FTS/BM25) leg backed by a full-text search seam.

HybridRetriever

Fuse several retrievers into one via Reciprocal Rank Fusion.

reciprocal_rank_fusion

Fuse weighted ranked lists into a single key -> score map.

DemoDocument

One in-memory document used by InMemoryBm25Retriever.

InMemoryBm25Retriever

A compact BM25 implementation suitable for demos and small corpora.

builtin_demo_retriever

Return a tiny corpus that explains the sample’s own mechanism.

CANCELLED

str(object=’’) -> str

DEGRADED

str(object=’’) -> str

EMPTY

str(object=’’) -> str

FAILED

str(object=’’) -> str

SUCCESS

str(object=’’) -> str

LegRecord

How one retrieval leg fared.

RetrievalOutcome

Ranked hits plus the story of how they were obtained.

assert_matches_corpus

Verify this module’s vocabulary still matches Corpus’s.

to_corpus_status

CitationOutput

Stable source metadata for one returned passage.

SearchDocsOutput

Structured output schema automatically advertised by MCP SDK v2.

SearchService

Wire adapter: bounded, validated search returning pydantic tool models.

create_server

Create an official MCP Python SDK v2 MCPServer instance.

RuntimeConfig

Validated effective CLI configuration.

main

require_count

Return value as a non-negative count within its declared maximum.

require_index

Return value as a position valid in [0, count).

MemoryMap

Memory-mapped region with automatic resource management.

mmap_region

mmap_region(int size: int, int prot: int = 0x3, int flags: int = 0x22, int fd: int = -1, int offset: int = 0) -> MemoryMap

DEFAULT_MLFLOW_SERVER_FLAGS

frozenset() -> empty frozenset object

MlflowServerCliCaps

Parsed capability set for mlflow server CLI flags.

ensure_flags_supported

Validate that all long-form CLI flags in args are supported.

get_mlflow_server_cli_caps

Get supported mlflow server flags for the installed MLflow version.

import_mlflow

Import MLflow lazily with a user-friendly error.

resolve_download_artifacts

Resolve a canonical artifact download function across MLflow versions.

ServerConfig

Configuration that maps directly to mlflow server CLI flags.

SessionConfig

Session-level configuration for scikitplot.mlflow.session.

running_in_docker

Detect whether the current process is running in a Docker container.

MlflowProvider

A customizable provider for MLflow-like libraries.

get_provider

Retrieve the currently active MLflow provider.

set_provider

Set the active MLflow provider globally.

use_provider

Temporarily set the MLflow provider for a context block.

EnvSnapshot

Full snapshot of process environment for strict restoration.

apply_env

Apply .env and explicit overrides to os.environ.

parse_dotenv

Parse a minimal .env file containing KEY=VALUE assignments.

MlflowCliIncompatibleError

Raised when a requested mlflow server option is not supported by the installed MLflow.

MlflowIntegrationError

Base exception for scikitplot.mlflow errors.

MlflowNotInstalledError

Raised when MLflow is required but not installed.

MlflowServerStartError

Raised when the managed MLflow server fails to start or exits prematurely.

SecurityPolicyViolationError

Raised when an operation is rejected by the active SecurityPolicy.

ArtifactsFacade

Artifact helper facade bound to a specific MLflow client/URI.

ModelsFacade

Model helper facade bound to a session-bound MLflow client.

DEFAULT_PROJECT_MARKERS

Built-in immutable sequence.

ProjectConfig

Project-level configuration for MLflow usage across multiple scripts.

dump_project_config_yaml

Write a ProjectConfig to a YAML file.

ensure_local_store_layout

Ensure local backend/artifact directories exist.

find_project_root

Find a project root directory deterministically.

get_project_markers

Resolve project markers deterministically.

load_project_config

Load project MLflow config from TOML or YAML based on file extension.

load_project_config_toml

Load project MLflow config from a TOML file.

load_project_config_yaml

Load project MLflow config from a YAML file.

normalize_mlflow_store_values

Normalize local store values for consistent multi-script usage.

project_markers

Temporarily override module default markers for a block.

set_project_markers

Set the module default markers.

wait_tracking_ready

Wait until the MLflow tracking REST API responds.

DEFAULT_SECURITY_POLICY

Declarative security policy for scikitplot.mlflow operations.

RELAXED_SECURITY_POLICY

Declarative security policy for scikitplot.mlflow operations.

SecurityPolicy

Declarative security policy for scikitplot.mlflow operations.

get_security_policy

Return the currently active SecurityPolicy, or None.

security_policy

Temporarily activate a SecurityPolicy for a context block.

set_security_policy

Set the active SecurityPolicy globally.

SpawnedServer

Spawned MLflow server process state.

build_server_args

Build the CLI args for mlflow server from a ServerConfig.

build_server_command

Build a deterministic mlflow server command.

spawn_server

Spawn an MLflow server subprocess.

MlflowHandle

A handle that proxies the upstream mlflow module while adding session context.

session

Create a strict, context-managed MLflow session.

session_from_file

Create an MLflow session using a shared project config file (TOML or YAML).

session_from_toml

Create an MLflow session using a shared project TOML config.

MlflowVersion

Parsed MLflow version.

is_mlflow_installed

Check whether MLflow is installed in the current Python environment.

mlflow_version

Retrieve the installed MLflow version (if available).

WorkflowPaths

Standardized project config paths used by the workflow.

builtin_config_path

Return the path to the built-in demo config shipped with the package.

default_project_paths

Compute standard config file paths for a project.

export_builtin_config

Export the built-in demo config into the current project.

patch_experiment_name_in_toml

Patch experiment_name = ... in a TOML config deterministically.

run_demo

Run a beginner-friendly end-to-end demo workflow.

workflow

Run the built-in end-to-end MLflow workflow demo.

get_include

Return the absolute path to the NumCpp C++ headers include directory.

dot

dot(a: numpy.ndarray, b: numpy.ndarray) -> numpy.ndarray

DummyCodeEncoder

Encode categorical features into dummy/indicator 0/1 variables.

GetDummies

Multi-column multi-label string column one-hot encoder [Rbcee2ffc57f9-1].

Kiss32Random

32-bit KISS RNG with complete serialization support.

Kiss64Random

Low-level 64-bit KISS RNG with context manager support.

KissRandom

Factory function for auto-detecting 32-bit vs 64-bit RNG.

KissSeedSequence

Seed sequence compatible with numpy.random.SeedSequence.

KissBitGenerator

NumPy-compatible BitGenerator using KISS algorithm with complete serialization.

KissGenerator

High-level random number generator using KISS algorithm.

KissRandomState

NumPy RandomState-compatible interface with complete serialization.

default_rng

Create default KISS random number generator.

kiss_context

Context manager for temporary RNG.

choice

Random sample from array.

integers

Random integers in [low, high) or [low, high].

normal

Normal distribution (Box-Muller transform).

permutation

Randomly permute sequence or return permuted range.

random

Random floats in [0, 1).

shuffle

Shuffle array in-place (Fisher-Yates algorithm).

uniform

Uniform distribution in [low, high).

RECIPES

Analyzer

How text becomes tokens, declared so a build can record it.

Recipe

A named, versioned scoring formula.

lexical_identity

Return the identity of a lexical build.

BM25

BM25Okapi

Okapi BM25 with an epsilon floor on negative IDFs (ATIRE-style IDF).

BM25L

BM25Plus

CALIBRATION_METHODS

Built-in immutable sequence.

ScoreCalibrator

Monotone map from BM25 scores to probabilities of relevance.

require_count

Return value as a non-negative count within its declared maximum.

require_index

Return value as a position valid in [0, count).

aucplot

Plot PR or ROC curves with a seaborn-like API.

evalplot

Visualization of the Confusion Matrix [Ra7e29df24177-1] alongside a text report showing key classification metrics.

modelplot

Model Instance and/or Attributes Visualization.

decileplot

Given binary labels y_true (0/1) and probabilities y_score 1d array, compute/plot a decile [Rd1ed195c7ca1-2] table.

print_labels

Pretty-print the legend of decile table column names.

Events

Bayesian blocks fitness for binned or unbinned events.

FitnessFunc

Base class for bayesian blocks fitness functions.

PointMeasures

Bayesian blocks fitness for point measures.

RegularEvents

Bayesian blocks fitness for regular events.

bayesian_blocks

Compute optimal segmentation of data with Scargle’s Bayesian Blocks.

binned_binom_proportion

Binomial proportion and confidence interval in bins of a continuous

binom_conf_interval

Binomial proportion confidence interval given k successes,

bootstrap

Performs bootstrap resampling on numpy arrays.

cdf_from_intervals

Construct a callable piecewise-linear CDF from a pair of arrays.

fold_intervals

Fold the weighted intervals to the interval (0,1).

gaussian_fwhm_to_sigma

Convert a string or number to a floating-point number, if possible.

gaussian_sigma_to_fwhm

Convert a string or number to a floating-point number, if possible.

histogram_intervals

Histogram of a piecewise-constant weight function.

interval_overlap_length

Compute the length of overlap of two intervals.

kuiper

Compute the Kuiper statistic.

kuiper_false_positive_probability

Compute the false positive probability for the Kuiper statistic.

kuiper_two

Compute the Kuiper statistic to compare two samples.

mad_std

Calculate a robust standard deviation using the median absolute deviation (MAD).

median_absolute_deviation

Calculate the median absolute deviation (MAD).

poisson_conf_interval

Poisson parameter confidence interval given observed counts.

signal_to_noise_oir_ccd

Computes the signal to noise ratio for source being observed in the

calculate_bin_edges

Calculate histogram bin edges like numpy.histogram_bin_edges.

freedman_bin_width

Return the optimal histogram bin width using the Freedman-Diaconis rule.

histogram

Enhanced histogram function, providing adaptive binnings.

knuth_bin_width

Return the optimal histogram bin width using Knuth’s rule.

scott_bin_width

Return the optimal histogram bin width using Scott’s rule.

akaike_info_criterion

Computes the Akaike Information Criterion (AIC).

akaike_info_criterion_lsq

Computes the Akaike Information Criterion assuming that the observations

bayesian_info_criterion

Computes the Bayesian Information Criterion (BIC) given the log of the

bayesian_info_criterion_lsq

Computes the Bayesian Information Criterion (BIC) assuming that the

biweight_location

Compute the biweight location.

biweight_midcorrelation

Compute the biweight midcorrelation between two variables.

biweight_midcovariance

Compute the biweight midcovariance between pairs of multiple

biweight_midvariance

Compute the biweight midvariance.

biweight_scale

Compute the biweight scale.

SigmaClip

Class to perform sigma clipping.

SigmaClippedStats

Class to calculate sigma-clipped statistics on the provided data.

sigma_clip

Perform sigma-clipping on the provided data.

sigma_clipped_stats

Calculate sigma-clipped statistics on the provided data.

circcorrcoef

Computes the circular correlation coefficient between two array of

circmean

Computes the circular mean angle of an array of circular data.

circmoment

Computes the p-th trigonometric circular moment for an array

circstd

Computes the circular standard deviation of an array of circular data.

circvar

Computes the circular variance of an array of circular data.

rayleightest

Performs the Rayleigh test of uniformity.

vonmisesmle

Computes the Maximum Likelihood Estimator (MLE) for the parameters of

vtest

Performs the Rayleigh test of uniformity where the alternative

jackknife_resampling

Performs jackknife resampling on numpy arrays.

jackknife_stats

Performs jackknife estimation on the basis of jackknife resamples.

RipleysKEstimator

Estimators for Ripley’s K function for two-dimensional spatial data.

tweedie_gen

A Tweedie continuous random variable inherited scipy.stats.rv_continuous.

tweedie

An instance of tweedie_gen, providing Tweedie distribution functionality.

Timer

Lightweight ⏱ timing context manager with logger support.

PathNamer

Generate portable, collision-resistant filenames and paths.

get_path

Generate a full file path for saving result images, ensuring the target directory exists.

make_path

Make Convenience wrapper to build a unique path (callable with zero args).

remove_path

Remove unwanted files or directories from a specified base path.

graph_view

Generates an architectural visualization for a given linear Keras

layered_view

Generates an architectural visualization for a given linear Keras

SpacingDummyLayer

A factory class for dynamically generating a dummy Keras layer with custom spacing.

expit

Compute the sigmoid (expit) of a scalar input.

log_expit

Compute the natural logarithm of the sigmoid (expit) of a scalar input.

logit

Compute the logit (inverse sigmoid) of a scalar input.

py_print

py_print(message: str = ‘Hello, from Pybind11 C++!’) -> None

sigmoid

Compute the sigmoid function for the input array x.

softmax

Compute the softmax function.

logsumexp

Compute the log of the sum of exponentials of input elements.

log_softmax

Compute the logarithm of the softmax function.

enable_ann_imputer

Enables ANNImputer

pipeline

ENVELOPES

Mapping of envelope types to amplitude-modulation functions.

compose_as_waveform

Generate a concatenated waveform from a musical composition input.

play_waveform

Play audio from a NumPy array using either IPython (for Jupyter) or sounddevice.

plot_waveform

Plot the waveform of mono or multi-channel audio data.

save_waveform

Save waveform to an audio file using specified or auto-selected backend.

save_waveform_as_mp3

Save waveform as an MP3 file using pydub and ffmpeg, with support for mono or stereo.

sheet_to_note

Convert input sheet (str/list/dict) to a list of (note, octave, duration).

sheet_converter

Display parsed notes or note frequencies from a musical sheet.

serialize_sheet

Serialize sheet notes to JSON or YAML string.

export_sheet

Enable serialization of compositions or note sheets.

_annoy

High-level Python interface for the C++ ANNoy backend.

annoylib

Compiled with GCC/Clang(Using 512-bit AVX instructions).

Annoy

Compiled with GCC/Clang. Using 512-bit AVX instructions.

AnnoyIndex

Compiled with GCC/Clang. Using 512-bit AVX instructions.

_astropy

Astropy is a package intended to contain core functionality and some

stats

This subpackage contains statistical tools provided for or used by Astropy.

_f2py

Fortran to Python Interface Generator.

get_include

Return the directory that contains the fortranobject.c and .h files.

_numcpp

array_api_compat

NumPy Array API compatibility library

array_api_extra

Extra array functions built on top of the array API standard.

ProbScale

A probability scale for matplotlib Axes.

probplot

Probability, percentile, and quantile plots.

plot_pos

Compute the plotting positions for a dataset. Heavily borrows from

fit_line

Fits a line to x-y data in various forms (linear, log, prob scales).

_seaborn

_sphinxext

figmpl_directive

Add a figure-mpl directive that is a responsive version of figure.

mathmpl

A role and directive to display mathtext in Sphinx.

plot_directive

A directive for including a Matplotlib plot in a Sphinx document.

roles

Custom roles for the Matplotlib documentation.

sphinx_tabs_patch

Sphinx compatibility shim for docutils backrefs.

_tweedie

Tweedie Distribution Module.

tweedie

An instance of tweedie_gen, providing Tweedie distribution functionality.

tweedie_gen

A Tweedie continuous random variable inherited scipy.stats.rv_continuous.

load_ipython_extension

Register the scikitplot magics (%load_ext scikitplot._ipymagic).

unload_ipython_extension

Remove the magics, stop snakeviz servers, delete temporary profiles.

run_command

Run one scikitplot command and return its result.

split_line

Split a magic’s line into arguments the way a POSIX shell would.

route

Return the command argv names, as the CLI would find it.

wants_json

Return whether argv asks for JSON output (--format json).

complete

Return the completions of the last word of a %scikitplot line.

Route

Which command an argument list names, and whether the CLI delegates it.

CommandResult

The outcome of one scikitplot command run from a notebook or Python.

MagicSettings

Behaviour of the magics for one IPython session.

profile_code

Run code under cProfile and summarise the profile.

profiler_busy_reason

Return why a profiler cannot be enabled now, or None when it can.

ProfileResult

A profile of a statement or cell, displayed as a table.

ProfileRow

One function of a profile.

IpyMagicError

Base class of every error raised by scikitplot._ipymagic.

MagicUsageError

The magic was called with arguments it cannot run (nothing was run).

CommandFailedError

A command exited with a non-zero status (raised only when asked to).

ProfilerBusyError

Another profiler is active in this process (Rule 133); nothing was run.

CapabilityMissingError

An optional package the request needs is not installed.

_sphinx_ai_assistant

✨ A Sphinx extension that adds AI-Assistant (AI-Powered) features

add_ai_assistant_context

Inject AI-assistant configuration into each HTML page’s template context.

generate_llms_txt

Post-build hook: write llms.txt listing all generated .md URLs.

generate_llms_txt_standalone

Write llms.txt from an existing set of .md files.

generate_markdown_files

Post-build hook: generate .md companions for every .html file.

html_to_markdown

Convert an HTML string to Markdown using the Sphinx-tuned converter.

html_to_markdown_converter

Convert an HTML string to Markdown using the Sphinx-tuned converter.

process_html_directory

Walk any HTML directory tree and convert pages to Markdown.

_factory_api

Scikit-plots Factory API module.

plot_roc_curve

Generates the ROC curves from labels and predicted scores/probabilities

plot_precision_recall_curve

Generates the Precision Recall Curve from labels and probabilities