Skip to content

Benchmarking data

BenchmarkRunResults dataclass

Benchmarking results for a run.

Attributes:

Name Type Description
ranks dict

Dictionary containing recorded ranks for samples.

rank_stats RankStats

Statistics related to benchmark.

results_dir Path

Path to the result directory. Defaults to None.

benchmark_name str

Name of the benchmark run. Defaults to None.

Source code in src/pheval/analyse/benchmarking_data.py
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@dataclass
class BenchmarkRunResults:
    """
    Benchmarking results for a run.

    Attributes:
        ranks (dict): Dictionary containing recorded ranks for samples.
        rank_stats (RankStats): Statistics related to benchmark.
        results_dir (Path, optional): Path to the result directory. Defaults to None.
        benchmark_name (str, optional): Name of the benchmark run. Defaults to None.
    """

    ranks: dict
    rank_stats: RankStats
    binary_classification_stats: BinaryClassificationStats
    results_dir: Path = None
    benchmark_name: str = None