Skip to content

Summarise

summarise

The summarise command.

Functions:

  • summarise_cmd –

    Summarise numerical metrics across experiments.

summarise_cmd

summarise_cmd(
    metrics: Tuple[str, ...],
    input_files: Tuple[str, ...],
    output: str,
    filter_expr: Optional[str],
    headers: Tuple[str, ...],
    formats: Tuple[str, ...],
    footer: Tuple[str, ...],
) -> None

Summarise numerical metrics across experiments.

Computes summary statistics (mean, SD, count) for numerical metrics extracted from JSON files or workflow cache (.db) entries. Produces publication-ready tabular output in CSV format.

Metric specifications use the format .: - f1.mean - compute mean of 'f1' values - shd.sd - compute standard deviation of 'shd' values - precision.count - count non-null 'precision' values

The field name follows a dotted path convention for nested metadata. For workflow caches, metrics are extracted from entry metadata (e.g., 'causaliq-analysis.evaluate_graph.f1' becomes 'f1').

Example

causaliq-analysis summarise -m f1.mean -m f1.sd -m shd.mean \ -i results.json -o summary.csv

causaliq-analysis summarise -m precision.mean -m recall.mean \ -i cache.db -o metrics_summary.csv

causaliq-analysis summarise -m f1.mean -i cache.db \ -f "network == 'asia'" -o asia_summary.csv

causaliq-analysis summarise -m f1.mean -m f1.sd -i cache.db -o -