API Reference

The cz-benchmarks package consists of several core modules, each designed to work independently while contributing to a cohesive benchmarking workflow. Below is an overview of these modules, along with links to their detailed documentation.

Core Modules

• Datasets (czbenchmarks.datasets):

  Contains classes for loading and validating datasets (e.g., SingleCellDataset), with support for AnnData and custom metadata. See the full documentation: czbenchmarks.datasets.

• Tasks (czbenchmarks.tasks):

  Provides evaluation tasks (e.g., clustering, embedding, perturbation prediction) by extending the Task class. See the full documentation: czbenchmarks.tasks.

• Metrics (czbenchmarks.metrics):

  Maintains a registry of metric functions through the MetricRegistry interface and organizes metrics into categories (clustering, embedding, etc.). See the full documentation: czbenchmarks.metrics.

Additional Utilities

• Utils (czbenchmarks.utils):

  Contains utility functions and helpers used across the package. See the full documentation: czbenchmarks.utils.

• File Utils (czbenchmarks.file_utils):

  Provides file handling utilities, such as loading datasets from various formats. See the full documentation: czbenchmarks.file_utils.