Skip to content

Commit

Permalink
docs: Add v0.6.2 release notes (#1495)
Browse files Browse the repository at this point in the history
* Add release notes for pyhf v0.6.2
   - c.f. https://github.com/scikit-hep/pyhf/releases/tag/v0.6.2
  • Loading branch information
matthewfeickert authored Jun 21, 2021
1 parent 07fa272 commit a244d65
Show file tree
Hide file tree
Showing 2 changed files with 103 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Release Notes
=============

.. include:: release-notes/v0.6.2.rst
.. include:: release-notes/v0.6.1.rst
.. include:: release-notes/v0.6.0.rst
.. include:: release-notes/v0.5.4.rst
Expand Down
102 changes: 102 additions & 0 deletions docs/release-notes/v0.6.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
|release v0.6.2|_
=================

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

Important Notes
---------------

* The :func:`pyhf.simplemodels.hepdata_like` API has been deprecated in favor of
:func:`pyhf.simplemodels.uncorrelated_background`.
The :func:`pyhf.simplemodels.hepdata_like` API will be removed in ``pyhf`` ``v0.7.0``.
(PR :pr:`1438`)
* There is a small breaking API change for :func:`pyhf.contrib.viz.brazil.plot_results`.
See the Python API changes section for more information.
* The :class:`pyhf.patchset.PatchSet` schema now allows string types for patch values in patchsets.
(PR :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
<https://hynek.me/articles/semver-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 :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 :pr:`1403`)
* Docker images of releases are now published to both `Docker Hub
<https://hub.docker.com/r/pyhf/pyhf/tags>`_ and to the `GitHub Container
Registry <https://github.com/scikit-hep/pyhf/pkgs/container/pyhf>`_.
(PR :pr:`1444`)
* CUDA enabled Docker images are now available for release ``v0.6.1`` and later
on `Docker Hub <https://hub.docker.com/r/pyhf/cuda>`__ and the `GitHub
Container Registry <https://github.com/pyhf/cuda-images/pkgs/container/cuda-images>`__.
Visit `github.com/pyhf/cuda-images <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 :func:`pyhf.set_backend`
``precision`` argument.
(PR :pr:`1369`)
* The default precision for all backends is now ``64b``.
(PR :pr:`1400`)
* Add check to ensure that POIs are not fixed during a fit.
(PR :pr:`1409`)
* Parameter name strings are now normalized to remove trailing spaces.
(PR :pr:`1436`)
* The logging level is now not automatically set in :class:`pyhf.contrib.utils`.
(PR :pr:`1460`)

Features
--------

Python API
~~~~~~~~~~

* The :func:`pyhf.simplemodels.hepdata_like` API has been deprecated in favor of
:func:`pyhf.simplemodels.uncorrelated_background`.
The :func:`pyhf.simplemodels.hepdata_like` API will be removed in ``pyhf`` ``v0.7.0``.
(PR :pr:`1438`)
* The :func:`pyhf.simplemodels.correlated_background` API has been added to
provide an example model with a single channel with a correlated background
uncertainty.
(PR :pr:`1435`)
* Add CLs component plotting kwargs to :func:`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,
:func:`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 :pr:`1377`)
* The ``pyhf.compat`` module has been added to aid in translating to and from ROOT
names.
(PR :pr:`1439`)

CLI API
~~~~~~~

* The CLI API now supports a ``patchset inspect`` API to list the individual
patches in a ``PatchSet``.
(PR :pr:`1412`)

.. code-block:: shell
pyhf patchset inspect [OPTIONS] [PATCHSET]
Contributors
------------

``v0.6.2`` benefited from contributions from:

* Alexander Held

.. |release v0.6.2| replace:: ``v0.6.2``
.. _`release v0.6.2`: https://github.com/scikit-hep/pyhf/releases/tag/v0.6.2

0 comments on commit a244d65

Please sign in to comment.