j ^dZddlmZddlmZmZddlmZddlm Z ddl m Z GddeZ y ) zCSpearman rank correlation between reference and predicted rankings.) annotations)AnySequence) BaseMetric) ScoreResult)MetricComputationErrorcReZdZdZ d dfd Z ddZxZS)SpearmanRankingaw Compute Spearman's rank correlation for two rankings of the same items. Scores are normalised to ``[0.0, 1.0]`` where `1.0` indicates perfect rank agreement and `0.0` indicates complete disagreement (``rho = -1``). References: - Spearman's rank correlation coefficient (Wikipedia overview) https://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient - SciPy documentation: ``scipy.stats.spearmanr`` https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.spearmanr.html Args: name: Display name for the metric result. Defaults to ``"spearman_ranking_metric"``. track: Whether to automatically track metric results. Defaults to ``True``. project_name: Optional tracking project name. Defaults to ``None``. Example: >>> from opik.evaluation.metrics import SpearmanRanking >>> metric = SpearmanRanking() >>> result = metric.score( ... output=["b", "a", "c"], ... reference=["a", "b", "c"], ... ) >>> round(result.metadata["rho"], 2) # doctest: +SKIP -0.5 c*t||||y)N)nametrack project_name)super__init__)selfr r r __class__s /Users/manta/Documents/Projects/TheRoad-I1/backend/.venv/lib/python3.12/site-packages/opik/evaluation/metrics/heuristics/spearman.pyrzSpearmanRanking.__init__*s d%lKc t|t|k7r tdt|dk(r tdt|Dcic]\}}|| }}}t|t|k7r tdd}t|D]\}}||}|||z dzz }t|} | dk(rd} ndd|z| | | zdz zz z } | dzdz } t | |j d | d d | i Scc}}w) Nz8output and reference rankings must have the same length.rz2Rankings cannot be empty for Spearman correlation.z%Rankings must contain the same items.g?z#Spearman correlation (normalized): z.4frho)valuer reasonmetadata)lenr enumeratesetrr ) routput referenceignored_kwargsidxitem ref_ranksdiffs_sqref_idxnr normalizeds rscorezSpearmanRanking.score2s- v;#i. ((J  v;! (D 1:)0DE0D93T3Y0D E v;#i. (()PQ Q"6*ICoG w1, ,H+ K 6Cq8|QUQY88CAg] 8C8HIS\   %Fs C/)spearman_ranking_metricTN)r strr boolrz str | NonereturnNone)r Sequence[Any]r!r0r"rr.r)__name__ __module__ __qualname____doc__rr* __classcell__)rs@rr r sn>.#' LLL! L  L& & !&  &  & rr N) r4 __future__rtypingrr#opik.evaluation.metrics.base_metricr$opik.evaluation.metrics.score_resultropik.exceptionsrr rrr<s%I" :<2L jL r