Skip to content

Commit

Permalink
feat: Update to pyhf v0.7.3 (#58)
Browse files Browse the repository at this point in the history
* Update to pyhf v0.7.3.
   - Update URLs to point to v0.7.3.
* Update requirements.txt and upgrade lock file.
   - Using 'pip-compile --generate-hashes --upgrade-package pyhf'
  • Loading branch information
matthewfeickert authored Aug 18, 2023
1 parent 602808f commit f913d9d
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `pyhf` Tutorial

**The tutorial is based off of [`pyhf` `v0.7.2`](https://pypi.org/project/pyhf/0.7.2/)**
**The tutorial is based off of [`pyhf` `v0.7.3`](https://pypi.org/project/pyhf/0.7.3/)**

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyhf/pyhf-tutorial/main?urlpath=lab)
[![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://pyhf.github.io/pyhf-tutorial/live/lab/index.html?path=jupyterlite.ipynb)
Expand Down
2 changes: 1 addition & 1 deletion binder/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pyhf[xmlio,minuit,contrib]==0.7.2
pyhf[xmlio,minuit,contrib]==0.7.3
# visualization
ipywidgets~=8.0.7
ipympl~=0.9.3
Expand Down
8 changes: 4 additions & 4 deletions book/HelloWorld.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"What did we just make? This returns a [`pyhf.pdf.Model`](https://pyhf.readthedocs.io/en/v0.7.2/_generated/pyhf.pdf.Model.html#pyhf.pdf.Model) object. Let's check out the specification."
"What did we just make? This returns a [`pyhf.pdf.Model`](https://pyhf.readthedocs.io/en/v0.7.3/_generated/pyhf.pdf.Model.html#pyhf.pdf.Model) object. Let's check out the specification."
]
},
{
Expand Down Expand Up @@ -144,7 +144,7 @@
"\n",
"where $n = \\{n_1, n_2\\}$ for a 2-bin model (we're being slightly fast and loose with our mathematical notation here), and similarly for $s$, $b$, and $\\gamma$.\n",
"\n",
"The 'shapesys' is defined in the [HistFactory paper](https://cds.cern.ch/record/1456844)... however, it can be a little hard to extract out the necessary information. We've provided a nice table of [Modifiers and Constraints](https://pyhf.readthedocs.io/en/v0.7.2/intro.html#id24) in the introduction of our pyhf documentation to use as reference.\n",
"The 'shapesys' is defined in the [HistFactory paper](https://cds.cern.ch/record/1456844)... however, it can be a little hard to extract out the necessary information. We've provided a nice table of [Modifiers and Constraints](https://pyhf.readthedocs.io/en/v0.7.3/intro.html#id24) in the introduction of our pyhf documentation to use as reference.\n",
"\n",
"![modifiers and constraints](assets/modifiers_and_constraints.png)"
]
Expand Down Expand Up @@ -515,7 +515,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We're not performing inference just yet. We're simply computing the 'logpdf' of the model specified by the parameters $\\theta$ against the provided data. To perform a fit, we use the [inference API](https://pyhf.readthedocs.io/en/v0.7.2/api.html#inference) via `pyhf.infer`.\n",
"We're not performing inference just yet. We're simply computing the 'logpdf' of the model specified by the parameters $\\theta$ against the provided data. To perform a fit, we use the [inference API](https://pyhf.readthedocs.io/en/v0.7.3/api.html#inference) via `pyhf.infer`.\n",
"\n",
"When fitting a model to data, we usually want to find the $\\hat{\\theta}$ which refers to the \"Maximum Likelihood Estimate\" of the model parameters. This is often referred to mathematically by\n",
"\n",
Expand Down Expand Up @@ -675,7 +675,7 @@
"source": [
"## Simple Upper Limit\n",
"\n",
"To get upper limits, we just need to run multiple hypothesis tests for a lot of different null hypotheses of BSM with $\\mu \\in [0, \\ldots, 5.0]$ and then find the value of $\\mu$ for which the null hypothesis is rejected (a 95% $\\text{CL}_\\text{s}$). We can do all of this very easily just using the [`upper_limits.upper_limit` API](https://pyhf.readthedocs.io/en/v0.7.2/_generated/pyhf.infer.intervals.upper_limits.upper_limit.html#pyhf.infer.intervals.upper_limits.upper_limit), which also can calculate the upper limit by interpolating"
"To get upper limits, we just need to run multiple hypothesis tests for a lot of different null hypotheses of BSM with $\\mu \\in [0, \\ldots, 5.0]$ and then find the value of $\\mu$ for which the null hypothesis is rejected (a 95% $\\text{CL}_\\text{s}$). We can do all of this very easily just using the [`upper_limits.upper_limit` API](https://pyhf.readthedocs.io/en/v0.7.3/_generated/pyhf.infer.intervals.upper_limits.upper_limit.html#pyhf.infer.intervals.upper_limits.upper_limit), which also can calculate the upper limit by interpolating"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions book/Modifiers.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
"source": [
"# Modifiers\n",
"\n",
"In our simple examples so far, we've only used two types of modifiers, but HistFactory allows for a handful of modifiers that have proven to be sufficient to model a wide range of uncertainties. Each of the modifiers is further described in the [Modifiers section](https://pyhf.readthedocs.io/en/v0.7.2/likelihood.html#modifiers) of the pyhf docs on model specification.\n",
"In our simple examples so far, we've only used two types of modifiers, but HistFactory allows for a handful of modifiers that have proven to be sufficient to model a wide range of uncertainties. Each of the modifiers is further described in the [Modifiers section](https://pyhf.readthedocs.io/en/v0.7.3/likelihood.html#modifiers) of the pyhf docs on model specification.\n",
"\n",
"There is an addtional table of [Modifiers and Constraints](https://pyhf.readthedocs.io/en/v0.7.2/intro.html#id24) in the introduction of the pyhf documentation to use as reference.\n",
"There is an addtional table of [Modifiers and Constraints](https://pyhf.readthedocs.io/en/v0.7.3/intro.html#id24) in the introduction of the pyhf documentation to use as reference.\n",
"\n",
"![modifiers and constraints](assets/modifiers_and_constraints.png)\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion book/SerializationAndPatching.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
"source": [
"## Patching in Signals\n",
"\n",
"Let's look at this [`pyhf.PatchSet`](https://pyhf.readthedocs.io/en/v0.7.2/_generated/pyhf.patchset.PatchSet.html#pyhf.patchset.PatchSet) object which provides a user-friendly way to interact with many signal patches at once.\n",
"Let's look at this [`pyhf.PatchSet`](https://pyhf.readthedocs.io/en/v0.7.3/_generated/pyhf.patchset.PatchSet.html#pyhf.patchset.PatchSet) object which provides a user-friendly way to interact with many signal patches at once.\n",
"\n",
"### PatchSet"
]
Expand Down
4 changes: 2 additions & 2 deletions book/SimpleWorkspace.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"What did we just make? This returns a [`pyhf.Workspace`](https://pyhf.readthedocs.io/en/v0.7.2/_generated/pyhf.workspace.Workspace.html#pyhf.workspace.Workspace) object. Let's check out the specification."
"What did we just make? This returns a [`pyhf.Workspace`](https://pyhf.readthedocs.io/en/v0.7.3/_generated/pyhf.workspace.Workspace.html#pyhf.workspace.Workspace) object. Let's check out the specification."
]
},
{
Expand Down Expand Up @@ -142,7 +142,7 @@
"source": [
"What does this mean for us though? Well, when we ask for a model, we specify the measurement that we want to use with it. Each of these measurements above have no additional parameter configurations on top of the existing model specification. Additionally, they all declare that the parameter of interest is `mu`.\n",
"\n",
"See the [documentation](https://pyhf.readthedocs.io/en/v0.7.2/_generated/pyhf.workspace.Workspace.html#pyhf.workspace.Workspace.model) for more information. In this case, let's build the model for the default measurement."
"See the [documentation](https://pyhf.readthedocs.io/en/v0.7.3/_generated/pyhf.workspace.Workspace.html#pyhf.workspace.Workspace.model) for more information. In this case, let's build the model for the default measurement."
]
},
{
Expand Down
8 changes: 4 additions & 4 deletions book/WorkspaceManipulations.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@
"\n",
"### via the command line\n",
"\n",
"So pyhf comes with a lot of nifty utilities you can access. The documentation for the command line can be found via `pyhf --help` or [online](https://pyhf.readthedocs.io/en/v0.7.2/cli.html)."
"So pyhf comes with a lot of nifty utilities you can access. The documentation for the command line can be found via `pyhf --help` or [online](https://pyhf.readthedocs.io/en/v0.7.3/cli.html)."
]
},
{
Expand All @@ -229,7 +229,7 @@
"python -m pip install pyhf[xmlio]\n",
"```\n",
"\n",
"Again, the online documentation for this option is found [here](https://pyhf.readthedocs.io/en/v0.7.2/cli.html#pyhf-xml2json)."
"Again, the online documentation for this option is found [here](https://pyhf.readthedocs.io/en/v0.7.3/cli.html#pyhf-xml2json)."
]
},
{
Expand Down Expand Up @@ -292,7 +292,7 @@
"\n",
"Nearly at the end, the next part of this specification is for the `observations` (observed data) on line 113. Each observation corresponds with the channel, where `channel1` has two bins, and `channel2` also has two bins.\n",
"\n",
"Finally, we have a `version` which specifies the version of the schema used for the JSON HistFactory. In this case, we're using `1.0.0` which has the [https://pyhf.readthedocs.io/en/v0.7.2/schemas/1.0.0/workspace.json](https://pyhf.readthedocs.io/en/v0.7.2/schemas/1.0.0/workspace.json) definition which refers to the [https://pyhf.readthedocs.io/en/v0.7.2/schemas/1.0.0/defs.json](https://pyhf.readthedocs.io/en/v0.7.2/schemas/1.0.0/defs.json).\n",
"Finally, we have a `version` which specifies the version of the schema used for the JSON HistFactory. In this case, we're using `1.0.0` which has the [https://pyhf.readthedocs.io/en/v0.7.3/schemas/1.0.0/workspace.json](https://pyhf.readthedocs.io/en/v0.7.3/schemas/1.0.0/workspace.json) definition which refers to the [https://pyhf.readthedocs.io/en/v0.7.3/schemas/1.0.0/defs.json](https://pyhf.readthedocs.io/en/v0.7.3/schemas/1.0.0/defs.json).\n",
"\n",
"What's really nice about the schema definition is that it allows anyone to write their own tooling/scripting to build up the workspace and quickly check if it matches the schema. This will get you 90% of the way there in having a valid workspace to work with.\n",
"\n",
Expand Down Expand Up @@ -330,7 +330,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"So we're not going to dump this out. We already did that above. Let's just quickly go ahead and load it into a [`pyhf.Workspace`](https://pyhf.readthedocs.io/en/v0.7.2/_generated/pyhf.workspace.Workspace.html#pyhf.workspace.Workspace) object because we can."
"So we're not going to dump this out. We already did that above. Let's just quickly go ahead and load it into a [`pyhf.Workspace`](https://pyhf.readthedocs.io/en/v0.7.3/_generated/pyhf.workspace.Workspace.html#pyhf.workspace.Workspace) object because we can."
]
},
{
Expand Down
10 changes: 5 additions & 5 deletions book/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ The 'minuit' extra installs [`iminuit`](https://iminuit.readthedocs.io/).

::::

See our [installation docs](https://pyhf.readthedocs.io/en/v0.7.2/installation.html) for more information about installation options.
See our [installation docs](https://pyhf.readthedocs.io/en/v0.7.3/installation.html) for more information about installation options.

### Dependencies for this tutorial

Expand Down Expand Up @@ -161,11 +161,11 @@ If you want to also get the dependencies to build and explore the Jupyter Book f
(pyhf-tutorial) $ pyhf --citation
@software{pyhf,
author = {Lukas Heinrich and Matthew Feickert and Giordon Stark},
title = "{pyhf: v0.7.2}",
version = {0.7.2},
title = "{pyhf: v0.7.3}",
version = {0.7.3},
doi = {10.5281/zenodo.1169739},
url = {https://doi.org/10.5281/zenodo.1169739},
note = {https://github.com/scikit-hep/pyhf/releases/tag/v0.7.2}
note = {https://github.com/scikit-hep/pyhf/releases/tag/v0.7.3}
}
@article{pyhf_joss,
Expand All @@ -182,7 +182,7 @@ If you want to also get the dependencies to build and explore the Jupyter Book f
}
```

Alternatively, [check the website](https://pyhf.readthedocs.io/en/v0.7.2/citations.html).
Alternatively, [check the website](https://pyhf.readthedocs.io/en/v0.7.3/citations.html).

### Statistics References

Expand Down
6 changes: 3 additions & 3 deletions book/requirements.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1138,9 +1138,9 @@ pygments==2.15.1 \
# nbconvert
# pydata-sphinx-theme
# sphinx
pyhf[contrib,minuit,xmlio]==0.7.2 \
--hash=sha256:0f6398f29c6045cb554f95e3e7ec56d31644b6421b93dfce625d3092a58412bd \
--hash=sha256:b769662580129fc14a7d779ee913808fb398ed2bc16b0a1ae666fc098ba6d37a
pyhf[contrib,minuit,xmlio]==0.7.3 \
--hash=sha256:11647c79a515be65c061780fb9e06a885195fba2774c5d4ccce6da1a30781064 \
--hash=sha256:175d5e69b0c73d161b7601c1ae158d4ddb3745c0eaea4c0d295f10cdac9ef9b4
# via -r /home/feickert/Code/GitHub/pyhf-org/pyhf-tutorial/requirements.txt
pyparsing==3.0.9 \
--hash=sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb \
Expand Down
4 changes: 2 additions & 2 deletions lite/jupyterlite.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import micropip

# Install pyhf in the browser
await micropip.install(["pyhf==0.7.2", "matplotlib>=3.0.0"])
await micropip.install(["pyhf==0.7.3", "matplotlib>=3.0.0"])
# %matplotlib inline
import pyhf

Expand All @@ -30,4 +30,4 @@
import micropip

# Install pyhf in the browser
await micropip.install(["pyhf==0.7.2", "matplotlib>=3.0.0"])
await micropip.install(["pyhf==0.7.3", "matplotlib>=3.0.0"])

0 comments on commit f913d9d

Please sign in to comment.