Skip to content

DOC: add TR-036 and TR-037 on phase space - #51

Open
redeboer wants to merge 10 commits into
mainfrom
adaptive-phsp-max-weight
Open

redeboer wants to merge 10 commits into
mainfrom
adaptive-phsp-max-weight

Conversation

@redeboer

@redeboer redeboer commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

📝 Documentation

  • Adds TR-036, which benchmarks the adaptive_max_weight option that tensorwaves#604 adds to TFPhaseSpaceGenerator. It shows how the acceptance of the hit-and-miss step drops with the number of pions for the default setting, times both settings for decays into three to six pions, and compares Dalitz plots, projections with pulls, and Kolmogorov–Smirnov tests for a three-body and a five-pion decay. The tensorwaves documentation keeps only a usage example and links to this report. The report installs tensorwaves from commit 20851d7 of that PR until the option is released, and pins phasespace~=1.10.4 because TFPhaseSpaceGenerator fails with phasespace 2.0 ("The random generator does not belong to the current backend").
  • Adds TR-037, which compares the NumPy, TensorFlow, and JAX backends that tensorwaves#599 enables for PhaseSpaceGenerator with phasespace 2.0. It times each backend for three-body and four-body decays and checks that all backends generate the same distributions. TensorFlow and JAX are several times faster than NumPy after compilation. The report installs tensorwaves from commit 623dc67 of that PR.
  • Both reports are frozen in docs/conf.py, so documentation builds do not execute them.

Squash commit messages

* DOC: freeze TR-036 and TR-037

@redeboer redeboer added 📝 Docs Improvements or additions to documentation 📖 Software About software development labels Nov 17, 2026
@redeboer
redeboer force-pushed the adaptive-phsp-max-weight branch from dad94f2 to b59dbed Compare November 17, 2026 21:07
@redeboer redeboer self-assigned this Nov 17, 2026
@redeboer redeboer added the 🖱️ DX Improvements to the Developer Experience label Nov 17, 2026
@redeboer
redeboer force-pushed the adaptive-phsp-max-weight branch from b0cc270 to fbc5b80 Compare November 18, 2026 11:04
@redeboer
redeboer changed the base branch from main to dependabot/lock-2fb387fa0b November 18, 2026 12:38
@redeboer
redeboer changed the base branch from dependabot/lock-2fb387fa0b to main November 18, 2026 12:38
@redeboer redeboer changed the title DOC: add TR-038 on adaptive phase space max weight DOC: add TR-036 and TR-037 on phase space Nov 18, 2026
@redeboer redeboer removed the 🖱️ DX Improvements to the Developer Experience label Nov 18, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝 Docs Improvements or additions to documentation 📖 Software About software development

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write a technical report on adaptive maximum weights in phase space generation

1 participant