feat: model prediction API and yield table changes

[alexander-held]

This changes the visualization.data_mc API. Previously, this function took an optional fit_results argument to steer which model prediction is included in plots. The generation of the model prediction is now factored out into a separate function: model_utils.prediction.

old:

cabinetry.visualize.data_mc(model, data, fit_results=fit_results)

new:

model_pred = cabinetry.model_utils.prediction(model, fit_results=fit_results)
cabinetry.visualize.data_mc(model_pred, data)

If the optional fit_results is not passed, the pre-fit prediction is generated instead. The new approach allows for more control over the model prediction, and users can customize it as needed. Model predictions have also a label attribute that shows up on plots and be used to construct paths to save figures.

The yield table generation is split out from visualize.data_mc into a new function: tabulate.yields. It uses the same API, also taking a model prediction and data as arguments.

Both visualize.data_mc and tabulate.yields have new optional channels arguments, taking either a string specifying a channel or a list of strings. If provided, only channels matching the values are included in the plots and tables.

A few new internal functions are added to model_utils to collect functionality used in multiple places.

Breaking changes:

• visualize.data_mc now requires a model prediction instead of a model

* breaking change: visualize.data_mc now requires model prediction argument
* new function model_utils.prediction to generate model predictions
* yield tables removed from visualize.data_mc, now available via new function tabulate.yields
* visualize.data_mc and tabulate.yields support a new optional channels argument
* refactored fit module, result containers split out into submodule

[codecov]

Codecov Report

Merging #267 (405d86d) into master (726f92c) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #267   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           18        19    +1     
  Lines         1764      1798   +34     
  Branches       270       278    +8     
=========================================
+ Hits          1764      1798   +34     

Impacted Files	Coverage Δ
src/cabinetry/cli/__init__.py	100.00% <100.00%> (ø)
src/cabinetry/fit/__init__.py	100.00% <100.00%> (ø)
src/cabinetry/fit/results_containers.py	100.00% <100.00%> (ø)
src/cabinetry/model_utils.py	100.00% <100.00%> (ø)
src/cabinetry/tabulate.py	100.00% <100.00%> (ø)
src/cabinetry/visualize/__init__.py	100.00% <100.00%> (ø)

---

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 726f92c...405d86d. Read the comment docs.