Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added comparison function as histogram operation (with colorized + info based string return) #763

Draft
wants to merge 28 commits into
base: develop
Choose a base branch
from
Draft

Added comparison function as histogram operation (with colorized + info based string return) #763

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
e929fe2
Update BoostHistogramHandsOn.ipynb
gohil-jay Jun 23, 2022
4700409
Merge branch 'scikit-hep:develop' into develop
gohil-jay Jun 27, 2022
c26aa03
Merge branch 'scikit-hep:develop' into develop
gohil-jay Jun 27, 2022
7d8252a
Updated all numpy.testing asserts to pytest.approx
gohil-jay Jun 27, 2022
a063d37
Updated all numpy.testing asserts to pytest.approx
gohil-jay Jun 27, 2022
65f0a1c
Updated all numpy.testing asserts to pytest.approx
gohil-jay Jun 27, 2022
b877ee5
style: pre-commit fixes
pre-commit-ci[bot] Jun 29, 2022
190e6ce
Wrapping this assert to remove test failing
gohil-jay Jun 30, 2022
b69b165
Merge branch 'scikit-hep:develop' into issue157
gohil-jay Jul 1, 2022
b6b0003
Added histograms comparison function
gohil-jay Jul 1, 2022
ebe0cff
Added 'compare' operation
gohil-jay Jul 1, 2022
772104c
style: pre-commit fixes
pre-commit-ci[bot] Jul 1, 2022
220c1ca
Tweaked the comparison function
gohil-jay Jul 1, 2022
246cc2f
style: pre-commit fixes
pre-commit-ci[bot] Jul 1, 2022
8a61023
Added type annotation
gohil-jay Jul 1, 2022
c2994e2
Updated function return from bool to colorized str
gohil-jay Jul 1, 2022
d1f5797
Updated annotation type and syntax
gohil-jay Jul 1, 2022
fb5af1e
style: pre-commit fixes
pre-commit-ci[bot] Jul 1, 2022
bae1ecd
Updated function with linear checks & f"str return
gohil-jay Jul 1, 2022
e6a3a2a
style: pre-commit fixes
pre-commit-ci[bot] Jul 1, 2022
8a36fe8
Fixed a typo
gohil-jay Jul 1, 2022
e0c2f5a
Removed colorized return text
gohil-jay Jul 1, 2022
b7096bd
Solved few pylint issues
gohil-jay Jul 1, 2022
fd2bcec
style: pre-commit fixes
pre-commit-ci[bot] Jul 1, 2022
69ab6dc
Redefined storage check & removed variance check
gohil-jay Jul 3, 2022
8df3ff6
Added histogram storage type operation
gohil-jay Jul 3, 2022
e9c1bd8
Tiny changes for pylint
gohil-jay Jul 3, 2022
9e79f51
Merge branch 'scikit-hep:develop' into issue157-2
gohil-jay Jul 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ histograms can be plotted via any compatible library, such as [mplhep][].
* `.kind`: Either `bh.Kind.COUNT` or `bh.Kind.MEAN`, depending on storage
* `.sum(flow=False)`: The total count of all bins
* `.project(ax1, ax2, ...)`: Project down to listed axis (numbers). Can also reorder axes.
* `.compare(second_hist)`: Compare the histogram with another histogram
* `.to_numpy(flow=False, view=False)`: Convert to a NumPy style tuple (with or without under/overflow bins)
* `.view(flow=False)`: Get a view on the bin contents (with or without under/overflow bins)
* `.values(flow=False)`: Get a view on the values (counts or means, depending on storage)
Expand Down
19 changes: 19 additions & 0 deletions src/boost_histogram/_internal/hist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import collections.abc
import copy
import logging
import re
import threading
import typing
import warnings
Expand Down Expand Up @@ -337,6 +338,24 @@ def ndim(self) -> int:
"""
return self._hist.rank()

def compare(self, hist2: "Histogram") -> bool:
if (np.allclose(self.view().shape, hist2.view().shape)):
if (np.allclose(self.view(), hist2.view())):
if (np.allclose(self.variances(), hist2.variances())):
if (re.search("(?<=storage=).*", str(self.view))[0].split('(')[0] == re.search("(?<=storage=).*", str(hist2.view))[0].split('(')[0]):
if (list(self.axes)==list(hist2.axes)):
return ""
else:
return "The axes [" + "\033[91m" + str(list(self.axes)) + " and " + str(list(hist2.axes)) + "\033[0m" + "] are not equal."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return "The axes [" + "\033[91m" + str(list(self.axes)) + " and " + str(list(hist2.axes)) + "\033[0m" + "] are not equal."
return f"The axes [\033[91m{list(self.axes)} and {list(hist2.axes)}\033[0m] are not equal."

F-strings were made for this. :) Also I'd pull out the color formatting into a variable, like red and reset. Actually, there are lots of concerns with color formatting (needs to be disablable and such), at least rich can auto-format this, so probably leave the color formatting off for the moment.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I bet if you do import rich; rich.print(h.compare(h2)) this would still be colorful. ;)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I was going to do something similar (with termcolor), but then though I'd do it without importing a library..

else:
return "The storage types [" + "\033[91m" + str(re.search("(?<=storage=).*", str(self.view))[0].split('(')[0]) + " and " + str(re.search("(?<=storage=).*", str(hist2.view))[0].split('(')[0]) + "\033[0m" + "] are not equal."
else:
return "The histogram contents : \n" + "\033[91m" + str(self.variances()) + "\033[0m" + "\nand\n" + "\033[91m" + str(hist2.variances()) + "\033[0m" + "\nare not equal."
else:
return "The histogram contents : \n" + "\033[91m" + str(self.view()) + "\033[0m" + "\nand\n" + "\033[91m" + str(hist2.view()) + "\033[0m" + "\nare not equal."
else:
return "The histogram dimensions [" + "\033[91m" + str(self.view().shape) + " and " + str(hist2.view().shape) + "\033[0m" + "] are not equal."

def view(
self, flow: bool = False
) -> Union["np.typing.NDArray[Any]", WeightedSumView, WeightedMeanView, MeanView]:
Expand Down