past.Evaluation.cluster_metrics

past.Evaluation.cluster_metrics(adata, target, pred)

clustering metrics including ARI, AMI, HOMO and NMI

Parameters:

  • adata – target dataset of anndata format with target key and pred key

  • target – key stored in adata.obs implying ground truth

  • pred – key stored in adata.obs implying clustering result

Returns:

  • ari – adjusted rand index

  • ami – adjusted mutual information score

  • nmi – normalized mutual information score

  • fmi – fowlkes–mallows index

  • comp – completeness score

  • homo – homogeneity score