|
| 1 | +|release v0.6.3|_ |
| 2 | +================= |
| 3 | + |
| 4 | +This is a patch release from ``v0.6.2`` → ``v0.6.3``. |
| 5 | + |
| 6 | +Important Notes |
| 7 | +--------------- |
| 8 | + |
| 9 | +* With the addition of writing ROOT files in |uproot v4.1.0 release|_ the |
| 10 | + ``xmlio`` extra no longer requires ``uproot3`` and all dependencies on |
| 11 | + ``uproot3`` and ``uproot3-methods`` have been dropped. |
| 12 | + (PR :pr:`1567`) |
| 13 | +* All backends are now fully compatible and tested with |
| 14 | + `Python 3.9 <https://www.python.org/dev/peps/pep-0596/>`_. |
| 15 | + (PR :pr:`1574`) |
| 16 | +* The TensorFlow backend now supports compatibility with TensorFlow ``v2.2.1`` |
| 17 | + and later and TensorFlow Probability ``v0.10.1`` and later. |
| 18 | + (PR :pr:`1001`) |
| 19 | +* The :func:`pyhf.workspace.Workspace.data` ``with_aux`` keyword arg has been |
| 20 | + renamed to ``include_auxdata`` to improve API consistency. |
| 21 | + (PR :pr:`1562`) |
| 22 | + |
| 23 | +.. |uproot v4.1.0 release| replace:: ``uproot`` ``v4.1.0`` |
| 24 | +.. _`uproot v4.1.0 release`: https://github.com/scikit-hep/uproot4/releases/tag/4.1.0 |
| 25 | + |
| 26 | +Fixes |
| 27 | +----- |
| 28 | + |
| 29 | +* The weakref bug with Click ``v8.0+`` was resolved. |
| 30 | + ``pyhf`` is now fully compatible with Click ``v7`` and ``v8`` releases. |
| 31 | + (PR :pr:`1530`) |
| 32 | + |
| 33 | +Features |
| 34 | +-------- |
| 35 | + |
| 36 | +Python API |
| 37 | +~~~~~~~~~~ |
| 38 | + |
| 39 | +* Model parameter names are now propagated to optimizers through addition of the |
| 40 | + :func:`pyhf.pdf._ModelConfig.par_names` API. |
| 41 | + :func:`pyhf.pdf._ModelConfig.par_names` also handles non-scalar modifiers with |
| 42 | + 1 parameter. |
| 43 | + (PRs :pr:`1536`, :pr:`1560`) |
| 44 | + |
| 45 | + .. code:: pycon |
| 46 | +
|
| 47 | + >>> import pyhf |
| 48 | + >>> model = pyhf.simplemodels.uncorrelated_background( |
| 49 | + ... signal=[12.0, 11.0], bkg=[50.0, 52.0], bkg_uncertainty=[3.0, 7.0] |
| 50 | + ... ) |
| 51 | + >>> model.config.parameters |
| 52 | + ['mu', 'uncorr_bkguncrt'] |
| 53 | + >>> model.config.npars |
| 54 | + 3 |
| 55 | + >>> model.config.par_names() |
| 56 | + ['mu', 'uncorr_bkguncrt[0]', 'uncorr_bkguncrt[1]'] |
| 57 | +
|
| 58 | +* The :class:`pyhf.pdf._ModelConfig` ``channel_nbins`` dict is now sorted by |
| 59 | + keys to match the order of the ``channels`` dict. |
| 60 | + (PR :pr:`1546`) |
| 61 | + |
| 62 | +* The :func:`pyhf.workspace.Workspace.data` ``with_aux`` keyword arg has been |
| 63 | + renamed to ``include_auxdata`` to improve API consistency. |
| 64 | + (PR :pr:`1562`) |
| 65 | + |
| 66 | +.. |release v0.6.3| replace:: ``v0.6.3`` |
| 67 | +.. _`release v0.6.3`: https://github.com/scikit-hep/pyhf/releases/tag/v0.6.3 |
0 commit comments