Benchmark | Bioverse documentation

Skip to content

# Benchmark

Explanation

class bioverse.benchmark.Benchmark(root: Path | str = PosixPath('/fs/pool/pool-kucera/.bioverse/benchmarks'), version: int = 0, partition: str = 'main', n_jobs: int | None = None)

  Bases: `ABC`

  __init__(root: Path | str = PosixPath('/fs/pool/pool-kucera/.bioverse/benchmarks'), version: int = 0, partition: str = 'main', n_jobs: int | None = None) → None
    Parameters:

      - root (Path or str, optional) – Root directory for benchmark data storage, defaults to config.benchmarks_path

      - version (int, optional) – Version number of the benchmark, defaults to 0

      - partition (str, optional) – Partition name for the benchmark data, defaults to “main”

      - n_jobs (int or None, optional) – Number of parallel jobs to run. If None, uses all available cores

    Notes

    The benchmark class requires the following class attributes to be defined: - dataset: Dataset class, instance, or (class, kwargs) tuple - sampler: Sampler class, instance, or (class, kwargs) tuple - task: Task class, instance, or (class, kwargs) tuple - metric: Metric class, instance, or (class, kwargs) tuple