v0.6.2

This is a patch release from v0.6.1 → v0.6.2.

Important Notes

• The pyhf.simplemodels.hepdata_like() API has been deprecated in favor of pyhf.simplemodels.uncorrelated_background(). The pyhf.simplemodels.hepdata_like() API will be removed in pyhf v0.7.0. (PR #1438)
• There is a small breaking API change for pyhf.contrib.viz.brazil.plot_results(). See the Python API changes section for more information.
• The pyhf.patchset.PatchSet schema now allows string types for patch values in patchsets. (PR #1488)
• Only lower bounds on core dependencies are now set. This allows for greater developer freedom and reduces the risk of breaking user’s applications by unnecessarily constraining libraries. This also means that users will be responsible for ensuring that their installed dependencies do not conflict with or break pyhf. c.f. Hynek Schlawack’s blog post Semantic Versioning Will Not Save You for more in-depth coverage on this topic. For most users nothing should change. This mainly affects developers of other libraries in which pyhf is a dependency. (PR #1382)
• Calling dir() on any pyhf module or trying to tab complete an API will now provide a more helpfully restricted view of the available APIs. This should help provide better exploration of the pyhf API. (PR #1403)

>>> import pyhf
>>> pyhf.  # Tab complete 
pyhf.Model(         pyhf.Workspace(     pyhf.exceptions     pyhf.infer          pyhf.modifiers      pyhf.parameters     pyhf.pdf            pyhf.set_backend(   pyhf.tensor         pyhf.utils
pyhf.PatchSet(      pyhf.compat         pyhf.get_backend(   pyhf.interpolators  pyhf.optimizer      pyhf.patchset       pyhf.probability    pyhf.simplemodels   pyhf.tensorlib      pyhf.workspace

• Docker images of releases are now published to both Docker Hub and to the GitHub Container Registry. (PR #1444)
• CUDA enabled Docker images are now available for release v0.6.1 and later on Docker Hub and the GitHub Container Registry. Visit https://github.com/pyhf/cuda-images for more information.

Fixes

• Allow for precision to be properly set for the tensorlib ones and zeros methods through a dtype argument. This allows for precision to be properly set through the pyhf.set_backend() precision argument. (PR #1369)
• The default precision for all backends is now 64b. (PR #1400)
• Add check to ensure that POIs are not fixed during a fit. (PR #1409)
• Parameter name strings are now normalized to remove trailing spaces. (PR #1436)
• The logging level is now not automatically set in pyhf.contrib.utils. (PR #1460)

Features

Python API

• The pyhf.simplemodels.hepdata_like() API has been deprecated in favor of pyhf.simplemodels.uncorrelated_background(). The pyhf.simplemodels.hepdata_like() API will be removed in pyhf v0.7.0. (PR #1438)
• The pyhf.simplemodels.correlated_background() API has been added to provide an example model with a single channel with a correlated background uncertainty. (PR #1435)
• Add CLs component plotting kwargs to pyhf.contrib.viz.brazil.plot_results(). This allows CLs+b and CLb components of the CLs ratio to be plotted as well. To be more consistent with the matplotlib API, pyhf.contrib.viz.brazil.plot_results() now returns a lists of the artists drawn on the axis and moves the ax arguments to the to the last argument. (PR #1377)

• The pyhf.compat module has been added to aid in translating to and from ROOT names. (PR #1439)

CLI API

• The CLI API now supports a patchset inspect API to list the individual patches in a PatchSet. (PR #1412)

pyhf patchset inspect [OPTIONS] [PATCHSET]

Contributors

v0.6.2 benefited from contributions from:

• Alexander Held (@alexander-held)

Changes:

• chore: Update codemeta softwareRequirements to match setup.cfg (#1498)
• docs: Add v0.6.2 release notes (#1495)
• docs: Add developer release checklist Issue template (#1493)
• docs: Improve badge layout and fix broken Docker badge (#1497)
• docs: Add squarks and gluinos search statistical model record (#1496)
• ci: Remove distribution options to enable default build v0.5.0 behavior (#1492)
• chore: Update pre-commit hooks versions and run order (#1490)
• feat: Allow strings in patch values for patchset (#1488)
• chore: Use tmpdir fixture over datadir in pyhf contrib download tests (#1487)
• docs: Add use citation from ATLAS SUSY 3L+compressed combination paper (#1483)
• chore: Add default virtual environment on PATH for Docker image (#1484)
• chore: Use _version.py to follow setuptools_scm recommendations (#1480)
• feat: Add 'contrib' extra to Docker images (#1479)
• docs: Add use citation from Belle II in Moriond EW 2021 contribution (#1475)
• chore: Use newer setuptools_scm for versioning (#1450)
• fix: Do not configure logging in contrib.utils (#1460)
• ci: Don't login to Docker container registries on PRs (#1463)
• chore: Trial pip in-tree-build before release in pip 21.3 (#1453)
• fix: Update to mathjax3_config to support math rendering in Sphinx v4.x+ (#1457)
• build: Revise MANIFEST.in strategy to properly use prune (#1449)
• feat: ROOT parameter name compatibility module (#1439)
• ci: Publish Docker images to GitHub Container Registry (#1444)
• ci: Set pre-commit.ci autoupdate schedule to monthly (#1440)
• chore: [pre-commit.ci] pre-commit autoupdate (#1445)
• refactor: Deprecate simplemodels.hepdata_like API for uncorrelated_background (#1438)
• fix: Remove load option from Docker workflow publish steps (#1442)
• ci: Update Docker workflow to build-push-action v2 (#1441)
• fix: Remove trailing spaces in parameter names (#1436)
• feat: Add correlated_background API to simplemodels (#1435)
• ci: Add custom commit message for pre-commit.ci autoupdate (#1432)
• docs: Add CERN Courier article to media listing (#1429)
• chore: [pre-commit.ci] pre-commit autoupdate (#1428)
• chore: Use module level dir to restrict public API views (#1403)
• docs: Add docstrings to _ModelConfig methods (#1420)
• docs: Update software citation URL to Zenodo DOI (#1424)
• docs: Add utils.citation to Python API docs (#1419)
• docs: Add use citation from Belle II B⁺→ K⁺νν̅ decays search paper (#1421)
• feat: Add CLs component plotting kwargs to contrib.viz.brazil.plot_results (#1377)
• chore: Update Black to release v21.4b1 (#1418)
• chore: Update Black to release v21.4b0 (#1417)
• docs: Add use citation from single leptoquark B-physics anomalies paper (#1416)
• feat: pyhf patchset inspect (#1412)
• chore: Update flake8 and nbQA in pre-commit (#1411)
• fix: check POIs floating (#1409)
• chore: Update to pyupgrade v2.12.0 in pre-commit (#1404)
• refactor: Set default precision to 64b (#1400)
• fix: Ensure tensorlib precision used throughout TensorFlow backend (#1399)
• fix: Stricter schema definitions for histosys and normsys (#1388)
• chore: Update to nbQA v0.6.0 in pre-commit (#1395)
• fix: Loosen iminuit tolerances for optimization tests (#1306)
• feat: Use PyYAML's safe_load for better security (#1383)
• build: Set only lower bounds on core dependencies (#1382)
• ci: Simplify CodeQL scan setup (#1384)
• chore: Ignore JAX tensor type in doctest (#1379)
• ci: Upload coverage to Codecov in flagged stages for complete coverage report (#1380)
• fix: Correct JAX tensor type in docstring (#1375)
• fix: Set precision for ones and zeros through dtype arg (#1369)
• chore: Update to pyupgrade 2.11.0 in pre-commit (#1370)
• fix: Adjust sbottom region A regression test tolerance for GHA runner change (#1364)
• chore: Update to flake8 3.9.0 in pre-commit (#1363)