feat: Add pyhf.workspace.build

[lukasheinrich]

Description

model = pyhf.simplemodels.hepdata_like(
        signal_data=[12.0, 11.0], bkg_data=[50.0, 52.0], bkg_uncerts=[3.0, 7.0]
)
data = [51, 48] + model.config.auxdata
workspace = pyhf.workspace.build(model, data)

this is the inverse of

w = pyf.Workspace(foo)
model = w.model()
data = w.data(model)

maybe interesting for @alexander-held, too

ReadTheDocs build: https://pyhf.readthedocs.io/en/workspace_maker/_generated/pyhf.workspace.Workspace.html

Checklist Before Requesting Reviewer

• Tests are passing
• "WIP" removed from the title of the pull request
• Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

• Summarize commit messages into a comprehensive review of the PR

* Add workspace class method to build workspaces from a model and data
* Add test to validate build behavior

[lukasheinrich]

this ignores fixed parameters. @kratsg maybe we add it in a follow-up PR?

[matthewfeickert]

@lukasheinrich I haven't looked at this much yet, but how much work would it take to get this all in one?

[kratsg]

something like this

param_configs = [{'name': param_name, 'inits': model.config.suggested_init()[model.config.param_set(param_name)['slice']], 'bounds': model.config.suggested_bounds()[model.config.param_set(param_name)['slice']), 'fixed': True} for param_name in model.config.parameters if model.config.suggested_fixed()[.....]]

[lukasheinrich]

done

[codecov]

Codecov Report

Merging #1101 into master will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1101      +/-   ##
==========================================
+ Coverage   96.87%   96.89%   +0.01%     
==========================================
  Files          62       62              
  Lines        3556     3570      +14     
  Branches      510      513       +3     
==========================================
+ Hits         3445     3459      +14     
  Misses         68       68              
  Partials       43       43              

Flag	Coverage Δ
#unittests	96.89% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/pyhf/exceptions/__init__.py	100.00% <100.00%> (ø)
src/pyhf/mixins.py	100.00% <100.00%> (ø)
src/pyhf/utils.py	96.15% <100.00%> (ø)
src/pyhf/workspace.py	98.09% <100.00%> (+0.06%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c1727ce...ac5e2a4. Read the comment docs.

[lukasheinrich]

black seems happy on my machine, but not in CI, @matthewfeickert any idea?

[matthewfeickert]

black seems happy on my machine, but not in CI, @matthewfeickert any idea?

Where is black unhappy? It isn't complaining in the CI as the Lint workflow is passing.

[matthewfeickert]

This is looking good @lukasheinrich. 👍 I rebased it and fixed a few small things that got dropped in the merges and added in some things missing to the docstring.

This is basically done, but I agree with @kratsg thought that

but we should check a "roundtrip" of sorts with simpler workspaces

[matthewfeickert]

I just have a formatting suggestion and then I agree with @kratsg's suggestion to only add in non-default settings.

[matthewfeickert]

Thanks for this @lukasheinrich. 👍