Skip to content

ENH: array comparison utils show calculations and indices of max errors #29395

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.

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

danra
Copy link
Contributor

@danra danra commented Jul 19, 2025

Resolves #28827

  • Verbose assertion errors raised by testing.assert_allclose and testing.assert_array_XXX now show the calculation and the indices of the maximum absolute and relative differences among the violations.
  • Assertion errors raised by assert_array_almost_equal_nulp and assert_array_max_ulp, which have no verbose toggle, now show the indices of the maximum ULP difference.

The main complexity adding this feature was that one could not 'simply' replace max with argmax due to masking: the absolute differences is calculated after masking out infs and nans, and the relative differences are additionally calculated after masking out zero denominators.


Notes to reviewer:

  1. Based over MNT: Cleanup infs handling in np.testing assertion utilities #29321 which should be merged first.
  2. Best reviewed going over commits one-by-one. Main change is in the last commit, preceding commits lead up to it with minor preparations.

@danra
Copy link
Contributor Author

danra commented Jul 21, 2025

Is the failing test maybe an instance of #29262 ?

@ngoldbaum
Copy link
Member

ngoldbaum commented Jul 21, 2025

It looks like pypy segfaulted on your PR. I don't think it's the same issue you linked to. Definitely a real problem but probably unrelated to this PR and safe for you to ignore.

Unfortunately the NumPy CI is sufficiently complicated that along with several heisenbugs bits and pieces regularly start failing for lots of reasons. Unless you're interested in helping out with a fix, it's usually safe to ignore. If you're unsure, just ask, and a maintainer should catch it if an error is real and it was ignored.

danra added a commit to danra/numpy that referenced this pull request Jul 28, 2025
Copy link
Member

@ngoldbaum ngoldbaum left a comment

Choose a reason for hiding this comment

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

The pypy tests have segfaulted twice in the same spot now, so I think it's a real issue you're running into.

ping @mattip for pypy expertise.

violations.
- Assertion errors raised by `assert_array_almost_equal_nulp` and
`assert_array_max_ulp` (which have no verbose toggle) now show the indices of
the maximum ULP difference.
Copy link
Member

Choose a reason for hiding this comment

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

the doc build fails with an error:

source/release/notes-towncrier.rst:72: WARNING: Bullet list ends without a blank line; unexpected unindent. 

Maybe look at how the bullet lists are formatted in other release notes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

After looking at other examples and adding a newline I still got the same error 🤷 . I just removed the bullets.

danra added a commit to danra/numpy that referenced this pull request Jul 29, 2025
@danra danra force-pushed the max_errors_indices branch from 4c65fff to 74ef2ba Compare July 29, 2025 02:32
danra added a commit to danra/numpy that referenced this pull request Jul 29, 2025
@danra danra force-pushed the max_errors_indices branch from 74ef2ba to 60c73f9 Compare July 29, 2025 02:32
danra added 9 commits July 29, 2025 08:40
Noticed the extra dimension while adding the index of the max error to
assert_array_XXX_nulp output
Noticed these while attempting to append more content to the
expected message, upon which the partial values started
causing the regex to stop matching.
Resolves numpy#28827

- Verbose assertion errors raised by testing.assert_allclose and
  testing.assert_array_XXX now show the calculation and the indices of
  the maximum absolute and relative differences among the violations.
- Assertion errors raised by assert_array_almost_equal_nulp and
  assert_array_max_ulp, which have no verbose toggle, now show the
  indices of the maximum ULP difference.

The main complexity adding this feature was that one could not 'simply'
replace `max` with `argmax` due to masking: the absolute differences is
calculated after masking out infs and nans, and the relative differences
are additionally calculated after masking out zero denominators.
@danra danra force-pushed the max_errors_indices branch from 60c73f9 to c3ababe Compare July 29, 2025 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ENH: assert_allclose show indices and values of maximum differences on failure
2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy