Function write_report

benchmarks/rust/benchmark_report.py:281–383

(system_info, results, sizes, output_dir, plot_prefix)

def write_report(system_info, results, sizes, output_dir, plot_prefix):
    report = [
        "# Rust Benchmark Performance Report\n\n",
        f"_Generated on {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}_\n\n",
        "## How to Generate This Report\n\n",
        "```bash\n",
        "cd benchmarks/rust\n",
        "cargo bench --bench serialization_bench 2>&1 | tee results/cargo_bench.log\n",
        "cargo run --release --bin fory_profiler -- --print-all-serialized-sizes | tee results/serialized_sizes.txt\n",
        "python benchmark_report.py --log-file results/cargo_bench.log --size-file results/serialized_sizes.txt --output-dir results\n",
        "```\n\n",
        "## Benchmark Plot\n\n",
        "The plot shows throughput (ops/sec); higher is better.\n\n",
        f"![Throughput]({plot_prefix}throughput.png)\n\n",
        "## Hardware & OS Info\n\n",
        "| Key | Value |\n",
        "|-----|-------|\n",
    ]

    for key, value in system_info.items():
        report.append(f"| {key} | {value} |\n")

    report.append("\n## Benchmark Results\n\n")
    report.append("### Timing Results (nanoseconds)\n\n")
    report.append(
        "| Datatype | Operation | fory (ns) | protobuf (ns) | msgpack (ns) | Fastest |\n"
    )
    report.append(
        "|----------|-----------|-----------|---------------|--------------|---------|\n"
    )

    for datatype in DATATYPE_ORDER:
        if datatype not in results:
            continue
        for operation in OPERATIONS:
            times = {
                serializer: results[datatype][operation].get(serializer, 0)
                for serializer in SERIALIZER_ORDER
            }
            positive = {name: value for name, value in times.items() if value > 0}
            fastest = min(positive, key=positive.get) if positive else "N/A"
            report.append(
                "| "
                + f"{datatype_title(datatype)} | {operation.capitalize()} | "
                + " | ".join(
                    f"{times[serializer]:.1f}" if times[serializer] > 0 else "N/A"
                    for serializer in SERIALIZER_ORDER
                )
                + f" | {fastest} |\n"
            )

    report.append("\n### Throughput Results (ops/sec)\n\n")
    report.append(
        "| Datatype | Operation | fory TPS | protobuf TPS | msgpack TPS | Fastest |\n"
    )
    report.append(
        "|----------|-----------|----------|--------------|-------------|---------|\n"
    )