docs(benchmarks): add v0 starting-point design spec#115
Open
lsetiawan wants to merge 2 commits into
Open
Conversation
Scopes a minimal, trustworthy starting point for the benchmarking and profiling subsystem: rewrites existing benchmarks against an authoring contract, adds shared fixtures, a profile CMake preset, NumPy/pure-Python/ concurrent.futures baselines, and a free-threading smoke benchmark. Defers pyperf, asv, CI integration, and macro/memory suites to the companion SDD as the forward roadmap.
Adds the long-form design document referenced by the v0 starting-point spec as its forward roadmap. Covers the full benchmarking subsystem vision — pyperf, asv, CI integration, macro/memory suites, dedicated runner, and numeric targets — scoped as Phase 1+ work to follow once v0 lands.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
benchmarking_profiling_sdd.md, which remains the long-term roadmap. This spec explicitly deferspyperf,asv, CI jobs, macro/memory suites, and numeric targets to that companion doc.Changes
docs/design-docs/2026-04-24-benchmarking-v0-design.mdconcurrent.futuresbaselines in the same group, explicit group names, minimize incidental Python overhead, thread-scaling parametrization, free-threading gating).benchmarks/conftest.pyfixtures (pin_cpu,seed_rng,no_gc,hpx_runtime,hpx_threads,requires_free_threading,env_sanity_check) with an explicit resolution for the session-runtime vs. thread-count conflict.profileCMake preset (RelWithDebInfo +-fno-omit-frame-pointer, LTO off, default visibility) sopy-spy --native,perf, andmemray --nativecan resolve C++ frames.scripts/run_bench_local.shsubcommands and a one-page contributorbenchmarks/README.md.bench/→benchmarks/, elevate Python 3.13 free-threading to a first-class axis, prepend "Phase 0" to the rollout plan).Test plan
hpx_runtimefixture + dedicated file for thread-count-varying benchmarks (Section 6.1).concurrent.futures.ThreadPoolExecutoris the right third baseline alongside NumPy + pure Python.pyperf/asv/CI/macro/memory/TARGETS.mdto the existing SDD (Section 12).