changelog.md

Changelog

[Latest]

[v0.4.1] (2024/11/18)

• Update tools package version !296
• Adding functions to process truth hadron information and associate tracks to hadrons !285
• Adding new n_tracks_origin plots !294
• Adding missing unit tests !295
• Removing hardcoded kwargs from high-level plotting !293

[v0.4.0] (2024/10/24)

• Clean up the docs a bit !290
• Add autohide for ROC ratio y-axis labels !289
• Improve ROC cosmetics again, add rejection smoothing option !288
• Adding colour-blind-friendly colours as default colours for taggers !286
• Increased number of bins in plot_vertex_mass function and fixed use of kwargs !284
• Bump python, numpy and matplotlib versions. Improve ROC cosmetics !282
• Added functionality to plot secondary vertex mass histograms using a pion mass hypothesis !265
• Fixed error bars on stacked histograms to be a distinct pattern, rather than just the last colour plotted !281

[v0.3.6] (2024/08/27)

• Updated variable names for aux task outputs to be consistent with Salt !270
• Merged precision and recall in one single function !276
• Added functions for precision and recall scores !275
• Minor updates for aux task plots !273
• Added better support in yuma, allowing for tau rejection, tau tagging, and Xbb plots !272
• Redefined fake rate !268
• Removed padded tracks from consideration when generating track origin classification CM !267
• Confusion Matrix: added per-class fake rates plus minor appearance changes !266

[v0.3.5] (2024/04/23)

• Fixed a problem in the Confusion Matrix normalization, and adopted a more clear naming convention; removed decimals from the matrix plot if the entry is an integer (useful for raw counts confusion matrix) !262
• Added matrix plot API, confusion matrix function, and Track Origin confusion matrix plot !258
• Fix setting ymin_ratio (and ymax_ratio) in PlotBase if it is zero !261
• Fixed shuffling bug in aux_results and modified treatment of single-track vertices !259

[v0.3.4] (2024/02/26)

• Better filenames when using HLAPI !256
• Switch to MkDocs for documentation !254
• Fixed minor bug in HF vertex merging !255
• Fixed removal of reconstructed PVs and modified which vertexing plots are produced given a jet flavour !253
• Updated AuxResults class to more closely match Yuma implementation of Results class !252
• Moving plotting tutorials from main FTAG page here !249
• Cleanup of plot names for high-level plotting interface, and yuma refactor !244
• Update tables version from 3.7.0 to 3.8.0 !245
• Fix taggers selection configuration for yuma !247
• Allow yuma base path to work with tagger sample dir !246
• Fix marker resizing in VarVsVar !243

[v0.3.3] (2024/02/26)

• Load ptau in Results class !242
• Update ruff, improve coverage !241
• Extend ftau support and remove discriminant code !240
• Fix ROC x-range config for yuma !239
• Allow for base dir Yuma loading !238
• Improve and generalize vertexing performance tools !229
• More improvements to Yuma configuration !237
• Autoinstall deps and steamline yuma config !236

[v0.3.2] (2024/02/13)

• Minor fixes and improvements to yaml plotting interface !235
• Added ability to plot from yaml configs !204
• Add support for multiple perf_vars in HLAPI !233
• Remove scipy dependency !232
• Extended usable range for metrics.weighted_percentile with double precision !231
• Consistent fc scan colours !228
• Add tools for plotting vertexing performance. !216

[v0.3.1] (2023/11/27)

• Update versions and add vscode settings !226
• Update ratio uncertainty calculation !225
• Adding option for initialising histograms with pre-binned distributions. !221
• Add NaN filtering for HL plots. Bump atlas-ftag-tools version to 0.1.11. !220
• Making Under- and Overflow bins default in histograms !218

[v0.3.0] (2023/10/03)

• Fix publish workflow, update tools package
• Fix docs build !215
• Make fc plots configurable and default to logscale !214
• Various improvements for efficiency profile plots !208
• Adding documentation for Data/MC plots !211
• Update linters !210
• Fix tagger discriminant bug, add future imports !209
• Add weight support for efficiency calculation !206
• Add tagger specific cuts to results !205
• Generalise ROC curve ratio grouping !202

[v0.2.8] (2023/08/09)

• HL fraction scan plot bugfix !201
• Support for custom ROC ratio reference !200
• Fixes for older numpy version !198, !199
• Replace error hatching with filling for histograms !194
• Add efficiency string to fc plots !193
• Add option to deterime optimal fc !188

[v0.2.7] (2023/07/17)

• Updating ATLAS-FTAG-Tools package !190
• Adding Data/MC Plots capabilities to the histogram classes !187

[v0.2.6] (2023/06/01)

• Fixing issue in use_atlas_tag !184
• Add probability plots to HLAPI and support WP vlines !183

[v0.2.5] (2023/05/12)

• Update requirements to include atlas-ftag-tools v0.1.3 !180
• Use VarVsVar as a base class for VarVsEff !179
• Adding fraction scans to high level API !178
• Update pre-commit (using ruff) and store tagger scores as structured array !177
• Remove dev image !176
• Fix bug in ratio axis limits !175
• Add VarVsVar plot !172

[v0.2.4] (2023/04/06)

• Replace dijets category with QCD category !170

[v0.2.3] (2023/03/28)

• Integrate atlas-ftag-tools package !168
• HLAPI and CI Updates !165
• Extend format saving options !160

[v0.2.2] (2023/02/28)

• Cast scores to full precision !159
• Add Xbb Support !157
• Improvements to the high level API !155
• Fixate the python container version !153
• Improve ROC format #146
• Fix for CI !152

[v0.2.1] (2022/12/15)

• Change legend label of dijets #146

[v0.2.0] (2022/12/09)

• Adding new high level API #128

[v0.1.9] (2022/11/30)

• Adding boosted categories for Xbb to utils !138
• Running pylint also for tests #133
• Fix handling of nan values in histograms #125
• Adding support for under- and overflow bins in puma.HistogramPlot #124
• (Documentation) Adding copy-button to code cells in documentation #131

[v0.1.8] (2022/08/30)

• Fix set_ylim in puma.PlotBase such that y-limits are correctly modified in cases with a y-offset #119
• Adding example for puma.Line2DPlot to the docs #117
• Adding support for ROC plots without ratio panels (was not possible until now) #114
• Lines with label=None (which is the default) will not appear in the legend anymore #113
• Adding new function puma.utils.get_good_linestyles() for easier linestyle management #116
• Adding the method make_linestyle_legend() which allows to specify an additional legend for linestyles #113

[v0.1.7] (2022/08/10)

• Adding new option to place rejection label legend in ROC plots #109

[v0.1.6] (2022/07/26)

• Adding support for weighted histograms (puma.Histogram now has an optional argument weights) #86
• Fixing bug where code crashed when histograms with discrete values + ratio panel were drawn #99
• Adding h5py to the Docker images #97
• Adding transparent attribute to PlotObject class. This allows to specify transparent background when initialising the plot #96

[v0.1.5] (2022/07/05)

• Add linewidth and alpha to legend handles + set alpha=1 by default (in puma.Histogram) #92
• Decreased default figsize for plots with zero or one ratio panels #90

[v0.1.4] (2022/06/30)

• Renamed the puma.FractionScan and puma.FractionScanPlot classes to more general puma.Line2DPlot and pumal.Line2D #84
• Splitting force argument of set_log() method into force_x and force_y #83
• Adding puma.PiePlot class. Pie chart plots with puma.HistogramPlot are no longer possible #70
• Change default labels of singlebjets and singlecjets #82
• Support linestyles for variable vs. efficiency plots #78

[v0.1.3] (2022/06/23)

• Adding more flavours to the global config #73
• ratio_group in puma.Histogram objects can no longer be set via flavour argument #74
• Adding example for plt.show replacement + adding theme switcher button to docs #72
• Adding atlas_tag_outside and change default for atlas_second_tag #71
• Change default bb-jets colour to dark red and vlines to black #69
• Adding more general ratio_group argument to puma.Histogram #67
• Adding calc_separation() to puma.metrics, which allows to calculate the separation between two distributions #27
• Adding Zenodo link

[v0.1.2] (2022/06/02/02)

• Adding automated coverage comment for pull request #58
• Fix that colour and legend label can be individually modified in case of flavoured histogram #57

[v0.1.1] (2022/05/30)

• Adding documentation for updating the version switcher in the docs #49
• Adding version support in docs #42#45
• Adding development guidelines to the docs #41
• Adding logx #40
• Adding example page for the fraction scan plots #38
• Add warning for plotting normalised histograms without saying to in the ylabel #34
• Adding Docker images #33
• Remove warning when adding more than one reference histogram is case is allowed #32
• Update documentation #24

[v0.1.0] (2022/05/16)

• Set default number of ratio panels to 0 #17
• Adding uncertainties to Roc main plots and improving dummy data generator #14
• Fixing all PEP8 related variable namings #13
• Adding FractionScan to puma #8