Skip to main content

Diagnostic profiling of labeled embeddings for classification model complexity guidance.

Project description

separatix logo

Separatix

separatix profiles labeled feature spaces before supervised model training and returns transparent, confidence-aware guidance about apparent classification or regression complexity.

The intended use case includes learned embeddings, but the package is not restricted to embeddings. It also works on raw feature matrices when you want a coarse diagnostic of whether the observed supervised geometry looks mostly linear, smoothly nonlinear, local or kernel-like, fragmented or discontinuous, bottlenecked, or too unreliable to trust.

separatix does not claim to pick the optimal classifier or regressor. It is a pretraining diagnostic and auditing tool designed to make its reasoning visible.

Installation

pip install separatix

To install the latest development version directly from GitHub:

pip install "git+https://github.com/NiklasMelton/Separatix.git@develop"

Quick start

from separatix import diagnose

recommendation = diagnose(X, y, random_state=0)
print(recommendation)

For a structured audit:

from separatix import diagnose

report = diagnose(X, y, return_report=True, random_state=0)
print(report.recommendation_text)
print(report.decision_path)
print(report.scores)
print(report.to_json())

What It Accepts

  • Dense NumPy arrays
  • SciPy sparse matrices
  • pandas DataFrames and Series when pandas is installed
  • Binary and multiclass classification targets
  • Multilabel binary indicator targets with target_mode="multilabel" or auto-detection for unambiguous 2D indicators
  • Continuous single- or multi-target regression with explicit target_mode="regression"
  • String or numeric labels treated as categorical class identifiers

Regression is opt-in so numeric class identifiers remain categorical by default. General multioutput classification is not supported.

What It Returns

By default, diagnose(...) returns a plain-text recommendation. With return_report=True, it returns a DiagnosticReport that includes:

  • the recommendation label
  • plain-text recommendation text
  • confidence level
  • underlying metric groups
  • probe-family evidence, including uncertainty-aware family comparisons
  • normalized summary scores
  • a visible decision path
  • warnings and skipped diagnostics
  • sampling and densification events
  • preprocessing and runtime metadata

The report is JSON-serializable through report.to_dict() and report.to_json().

For multilabel targets, separatix compares probe families across micro F1, macro F1, and sample Jaccard rather than collapsing the evidence into a single weighted score. Optional iterative multilabel stratification can be installed with:

pip install "separatix[multilabel]"

For regression targets, call diagnose(X, y, target_mode="regression"). Regression evidence is compared across variance-weighted R2 and uniform-average R2, with normalized RMSE and target-neighborhood smoothness as supporting diagnostics. Classification-only boundary and fragmentation diagnostics are reported as skipped for continuous targets.

Optional persistent-topology diagnostics can be installed with:

pip install "separatix[tda]"

For multilabel targets, persistent topology is supporting evidence only. When enabled, it is computed on capped boundary-candidate subsets and a small capped set of high-support label-positive subsets.

For regression targets, optional topology is computed only on capped high-residual and high-local-discontinuity subsets. topology="graph" uses a sparse-compatible mutual-nearest-neighbor component summary; topology="persistent" adds persistent homology when ripser is installed. topology="auto" skips topology under the fast budget and otherwise attempts both summaries. Regression topology is descriptive supporting evidence: it is shown in the score and decision path but never changes the recommendation label or confidence.

Recommendation Categories

  • linear_likely_sufficient
  • smooth_nonlinear_recommended
  • kernel_or_local_recommended
  • high_capacity_or_partitioning_recommended
  • feature_or_label_bottleneck_likely
  • insufficient_data_or_unreliable_geometry
  • inconclusive

These categories are intentionally coarse. They describe the apparent geometry and difficulty of the labeled feature space, not a guaranteed best model choice.

The synthetic recommendation ladder below shows how separatix responds as the designed dataset geometry moves from simple linear structure toward smoother nonlinearity, local or kernel-like structure, fragmented boundaries, and finally weak-signal or random-label bottlenecks. The x-axis is the intended dataset complexity, while the y-axis is the coarse recommendation level reported by separatix.

separatix recommendation complexity ladder

Decision Pipeline

The recommendation is produced by a fixed, inspectable pipeline:

  1. Validate inputs and encode labels.
  2. Audit class counts, imbalance, sparsity, and basic dataset conditions.
  3. Compute geometry, neighborhood, boundary, fragmentation, and optional topology diagnostics, using a distinct multilabel path for binary indicator targets.
  4. Run simple probe models and compare them to a dummy baseline.
  5. Build probe-family evidence with uncertainty estimates for linear, smooth_nonlinear, and local_kernel.
  6. Apply a 95% signal-vs-dummy gate before making any model-family recommendation for single-label targets, or a two-of-three primary-metric signal gate for multilabel targets.
  7. Use conservative escalation: keep the simpler family unless a more complex family has a clear uncertainty-adjusted advantage.
  8. Treat fragmentation and optional topology as supporting structural evidence, not as shortcuts around weak probe evidence.
  9. Render both a plain-language summary and a structured report, including raw_best_family and recommended_family when a report is requested.

The full rationale and decision rules are documented in docs/decision_pipeline.md.

Sparse Inputs And Memory Behavior

Sparse matrices are accepted directly. Diagnostics that need dense data use a shared densification policy rather than a separate dense-only code path. When a step would require densification, separatix can fail, skip, or warn and subsample before densifying, depending on configuration. These events are recorded in the report.

Examples

Related Work

This package is not an implementation of a published dataset-complexity procedure, but the project is adjacent to and inspired by prior work on classification complexity and data geometry. In particular, would like to acknowledge:

  • Ho and Basu, "Complexity Measures of Supervised Classification Problems" (PDF)
  • Lorena, Garcia, Lehmann, Souto, and Ho, "How Complex Is Your Classification Problem? A Survey on Measuring Classification Complexity" (DOI, PDF)

We do not follow those procedures directly, but they are relevant background for why geometry-aware pretraining diagnostics are useful.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

separatix-0.1.0a4.tar.gz (73.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

separatix-0.1.0a4-py3-none-any.whl (84.7 kB view details)

Uploaded Python 3

File details

Details for the file separatix-0.1.0a4.tar.gz.

File metadata

  • Download URL: separatix-0.1.0a4.tar.gz
  • Upload date:
  • Size: 73.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for separatix-0.1.0a4.tar.gz
Algorithm Hash digest
SHA256 ed42b773f19bd6aca81230f935eb96d788760d0440f82e36142a2672648dfa15
MD5 968c53c605b1d658444126a58d992133
BLAKE2b-256 9fccf0e2831cfd3aca0d0f7b2b5674409a4e19170d7343332449fc4477aa8b46

See more details on using hashes here.

Provenance

The following attestation bundles were made for separatix-0.1.0a4.tar.gz:

Publisher: pypi-publish.yml on NiklasMelton/Separatix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file separatix-0.1.0a4-py3-none-any.whl.

File metadata

  • Download URL: separatix-0.1.0a4-py3-none-any.whl
  • Upload date:
  • Size: 84.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for separatix-0.1.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 fbed700dfa5dd7e93555f5bb5a6d66501fb352a8b5fa0f1e7775860f2cc51ab2
MD5 d8858f36b2435a03659fa9277cdbacb9
BLAKE2b-256 0eaeaff34af91036153aead282b0b29004308fcdfc92a731bdc10cae01ee2a85

See more details on using hashes here.

Provenance

The following attestation bundles were made for separatix-0.1.0a4-py3-none-any.whl:

Publisher: pypi-publish.yml on NiklasMelton/Separatix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page