Skip to content

profile()#

profile #

profile(config: ProfileConfig, *, progress_sink: ProgressSink | None = None) -> ProfileResult

Run a full profiling session.

This is the main programmatic entry point. It builds the default pipeline, executes all stages, and returns a typed :class:ProfileResult.

Raises :class:HpxError (or a subclass) on failure.

ProgressUpdate dataclass #

ProgressUpdate(message: str, kind: Literal['status', 'checkpoint'] = 'status', completed: int | None = None, total: int | None = None, unit: str | None = None, eta_s: float | None = None, min_verbosity: int = 0)

User-meaningful progress within a pipeline stage.