API Reference¶

The API reference is generated automatically from the source code docstrings. Modules are organized by functionality.

Core Components¶

`roastcoffea.collector`	Metrics collector context manager.
`roastcoffea.decorator`	Decorator for chunk-level metrics tracking.
`roastcoffea.instrumentation`	Instrumentation context managers for fine-grained tracking.

Backends¶

`roastcoffea.backends.base`	Abstract base class for metrics backends.
`roastcoffea.backends.dask`	Dask backend for metrics collection.

Aggregation¶

`roastcoffea.aggregation.core`	Core metrics aggregator combining all aggregation modules.
`roastcoffea.aggregation.workflow`	Workflow-level metrics aggregation.
`roastcoffea.aggregation.chunk`	Chunk-level metrics aggregation.
`roastcoffea.aggregation.efficiency`	Efficiency metrics calculation.
`roastcoffea.aggregation.fine_metrics`	Parse Dask Spans fine-grained performance metrics.
`roastcoffea.aggregation.backends.base`	Abstract base class for tracking data parsers.
`roastcoffea.aggregation.backends.dask`	Dask-specific aggregation parsers.

Export and Reporting¶

`roastcoffea.export.reporter`	Rich table formatting for metrics reporting.
`roastcoffea.export.measurements`	Save and load benchmark measurements for later reanalysis.

Visualization¶

`roastcoffea.visualization.plots.workers`	Worker count timeline plotting.
`roastcoffea.visualization.plots.memory`	Memory utilization timeline plotting.
`roastcoffea.visualization.plots.cpu`	CPU utilization plots.
`roastcoffea.visualization.plots.throughput`	Throughput and data rate plots.
`roastcoffea.visualization.plots.scaling`	Scaling efficiency plots.

Utilities¶

roastcoffea.utils

Common utility functions.