Metrics & utilities

Native ground-truth agreement metrics between two partition dicts — computed over shared nodes, with exact AMI — plus runtime helpers.

pymocd.gt_metrics

gt_metrics(
    partition: dict, gt: dict
) -> tuple[builtins.float, builtins.float, builtins.float, builtins.float]

(NMI, AMI, ARI, F1) of a partition against ground truth (gt).

pymocd.nmi

nmi(partition: dict, gt: dict) -> builtins.float

Normalised mutual information between two {node:community} dicts.

pymocd.ami

ami(partition: dict, gt: dict) -> builtins.float

Adjusted mutual information between two {node:community} dicts.

pymocd.ari

ari(partition: dict, gt: dict) -> builtins.float

Adjusted Rand index between two {node:community} dicts.

pymocd.f1

f1(partition: dict, gt: dict) -> builtins.float

Pairwise F1 between two {node:community} dicts.

pymocd.max_cores

max_cores(num_threads: int) -> None