Skip to main content

Critical Difference diagram generator in pure Python

Project description

cddiagram

A pure Python library for generating Critical Difference (CD) diagrams as SVG.

CD diagrams visualize the statistical comparison of multiple classifiers (or models) over multiple datasets, as introduced by Demsar (2006). They show the average rank of each model and connect groups of models whose performance differences are not statistically significant.

J. Demsar, "Statistical Comparisons of Classifiers over Multiple Data Sets", Journal of Machine Learning Research, vol. 7, pp. 1-30, 2006. https://jmlr.org/papers/v7/demsar06a.html

How it works

  1. A Friedman test checks whether at least one model differs significantly from the others (at alpha = 0.05).
  2. If significant, a pairwise post-hoc test determines which pairs of models differ. Two options are supported:
    • posthoc="wilcoxon-holm" (default): pairwise two-sided Wilcoxon signed-rank tests with Holm step-down correction. Each pairwise decision uses only those two models' per-dataset scores, so it is robust to which other models are in the experiment (Benavoli, Corani & Mangili, 2016).
    • posthoc="nemenyi": original Nemenyi test from Demšar (2006). A single critical distance CD = q_α · √(k(k+1)/6N) is computed; pairs with |R̄_i − R̄_j| ≤ CD are deemed non-significant. The diagram includes the iconic CD bar.
  3. Maximal contiguous cliques of mutually non-significant models are connected by horizontal bars below the rank axis.
  4. The result is rendered as an SVG diagram showing ranked models and significance groups.

Install

pip install cddiagram

Requires Python 3.12+ and depends on numpy and scipy.

Usage

Write to file

import numpy as np
from cddiagram import draw_cd_diagram

rng = np.random.default_rng(1)

models = {
    "model1": rng.normal(loc=0.2, scale=0.1, size=30),
    "model2": rng.normal(loc=0.2, scale=0.1, size=30),
    "model3": rng.normal(loc=0.4, scale=0.1, size=30),
    "model4": rng.normal(loc=0.5, scale=0.1, size=30),
    "model5": rng.normal(loc=0.7, scale=0.1, size=30),
    "model6": rng.normal(loc=0.7, scale=0.1, size=30),
    "model7": rng.normal(loc=0.8, scale=0.1, size=30),
    "model8": rng.normal(loc=0.9, scale=0.1, size=30),
}

samples = np.column_stack(list(models.values()))
draw_cd_diagram(samples, labels=list(models.keys()), out_file="out.svg", title="Model comparison")

Non-significant results

If the Friedman test is not significant, the function issues a warning and returns None — no diagram is produced because the data does not support ranking the models.

API

draw_cd_diagram(
    samples,                   # 2D array-like (rows=datasets, columns=models)
    labels,                    # Sequence of model names (one per column)
    title=None,                # Optional diagram title
    out_file=None,             # Optional path to write SVG file
    fig_size=None,             # Optional (width, height) tuple in pixels
    posthoc="wilcoxon-holm",   # "wilcoxon-holm" (default) or "nemenyi"
) -> Element | None

Input formats: NumPy arrays, pandas DataFrames, or any object with a .to_numpy() / .values attribute.

Release Notes

0.0.8

  • Added posthoc parameter; default switched to Wilcoxon signed-rank with Holm correction to avoid Nemenyi's pool-dependency defect (Benavoli, Corani & Mangili, JMLR 2016). The original Demšar/Nemenyi behavior is available with posthoc="nemenyi".
  • The CD bar is rendered only when posthoc="nemenyi" (no single critical distance exists for Wilcoxon-Holm).

0.0.7

  • Optimized Nemenyi critical-value computation with a precomputed q_alpha lookup table for k=3..100 at alpha=0.05.
  • Kept a SciPy studentized_range fallback for values outside the lookup range (or different alpha), preserving behavior for all valid inputs.

0.0.6

  • Red clique bars now render on top of all other SVG elements (connectors, markers, axis).

0.0.5

  • Text labels no longer carry an SVG stroke, removing the bold/smudged appearance.
  • font-family="sans-serif" set globally for consistent cross-platform rendering.
  • Empty title no longer emits a stray <text/> node.
  • Non-maximal cliques filtered out — only strictly maximal non-significance groups are drawn, eliminating near-duplicate bars.
  • Classifier connectors use a single <polyline> with stroke-linejoin="miter", removing the corner notch produced by two separate lines.
  • Axis markers are taller than the axis stroke so they are visible.
  • Clique end-caps enlarged for legibility.
  • CD-bar tick length unified with ruler tick length.
  • Label-width heuristic bumped to better fit sans-serif glyphs.

0.0.4

  • Non-significant groups packed into the minimum number of rows (greedy interval scheduling).
  • Fixed vertical layout: title → CD bar → ruler → groups → labels (groups now drawn below the axis).

0.0.2

  • Replaced hardcoded Nemenyi critical-value lookup table with SciPy's studentized_range computation.
  • Updated CD diagram drawing to follow continuous rank-axis placement and first-anchor non-significant grouping.
  • Improved readability for larger numbers of algorithms with adaptive multi-row label layout.

License

MIT

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

cddiagram-0.0.8.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

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

cddiagram-0.0.8-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file cddiagram-0.0.8.tar.gz.

File metadata

  • Download URL: cddiagram-0.0.8.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cddiagram-0.0.8.tar.gz
Algorithm Hash digest
SHA256 c766d74ab300a6a72530b7969de7d688333280f95ee7fedfa26f99b8073d39df
MD5 384e4a83ab3c6b8c2f89497bf94be1e0
BLAKE2b-256 5f8876258ca464b758832d6c4b5b562cda293b356b36f430b154ab8df360e2df

See more details on using hashes here.

Provenance

The following attestation bundles were made for cddiagram-0.0.8.tar.gz:

Publisher: publish-pypi.yml on irazza/cddiagram

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

File details

Details for the file cddiagram-0.0.8-py3-none-any.whl.

File metadata

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

File hashes

Hashes for cddiagram-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e2a38fd49af793df51a6a77b2823799462e4720be2c7aff1e8abb26ff299a4e6
MD5 ddf5c95c97306bf0d66122e68c8ed3a4
BLAKE2b-256 7377bda73b9727dc46a28d195354f75fbcf89aa30ff319eed0a43accce333a5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for cddiagram-0.0.8-py3-none-any.whl:

Publisher: publish-pypi.yml on irazza/cddiagram

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