Benchmark Results

This directory contains benchmark results generated by BenchmarkDotNet.

Layout

Each checked-in benchmark run lives in its own platform directory:

windows-x64-amd-ryzen-5-7600x/ — Windows 11, AMD Ryzen 5 7600X
macos-arm64-apple-m4/ — macOS Tahoe, Apple M4

The platform identifier format is:

<os>-<architecture>-<cpu-slug>

Updating Benchmark Results

To update benchmark results after a local run:

Run the benchmarks using the helper script from the repository root:
```
.\scripts\run-benchmarks.ps1 -Project Threading
```

Execute the update script to publish results into docfx:

.\scripts\update-benchmark-docs.ps1 -Project Threading

If you need to override the derived folder name:

.\scripts\update-benchmark-docs.ps1 -Project Threading -PlatformId windows-x64-amd-ryzen-5-7600x

The script:

copies the latest benchmark markdown files from tests/Threading/BenchmarkDotNet.Artifacts/results/
extracts the machine specification into a platform-local machine-spec.md
strips the duplicated machine specification from the individual result files
publishes the stripped files under docfx/packages/threading/benchmarks/<platform-id>/

Important Notes

Benchmarks should be run on a local machine with minimal background load
Results are machine-specific and may vary between systems
The benchmark include paths in the docs now point at explicit platform folders
When adding a second published host, keep the old folder and add the new one instead of overwriting it

Edit this page