Skip to content

Migrate tests/test_aampdist_snippets.py to npt.assert_allclose - #1185

Merged
seanlaw merged 1 commit into
stumpy-dev:mainfrom
viknesh-ai:fix/1175-migrate-test-aampdist-snippets
Aug 16, 2026
Merged

Migrate tests/test_aampdist_snippets.py to npt.assert_allclose#1185
seanlaw merged 1 commit into
stumpy-dev:mainfrom
viknesh-ai:fix/1175-migrate-test-aampdist-snippets

Conversation

@viknesh-ai

Copy link
Copy Markdown
Contributor

Related to #1175

Continuing the file-by-file split — this one covers tests/test_aampdist_snippets.py.

assert_almost_equal only checks a fixed absolute tolerance and NumPy's docs recommend assert_allclose instead. This file already used ref_/cmp_ naming, so the only changes needed:

  • Argument order was backwards everywhere (ref_x, cmp_x instead of cmp_x, ref_x) — flipped every active call.
  • Most calls explicitly pass decimal=config.STUMPY_TEST_PRECISION (a genuinely looser tolerance than the default, since config.STUMPY_TEST_PRECISION is 5, not 7) — kept these as atol=1.5 * 10**-config.STUMPY_TEST_PRECISION rather than flattening to the usual 1.5e-07 literal, since that would silently tighten the tolerance. Only the regimes comparison had no decimal= argument, so that one uses the default atol=1.5e-07.
  • Two comparisons (profiles, areas) are commented out in the original file — updated their syntax to match for consistency, but left them commented since re-enabling them wasn't part of this migration.

Checked the actual return dtypes from aampdist_snippets/naive.aampdist_snippets first — all plain float64/int64, no dtype=object casting needed.

Ran the full file twice locally (normal mode and JIT-disabled/CUDA-simulated, matching test.sh coverage) — 63/63 passing both times (there are some pre-existing RuntimeWarning: All-NaN slice encountered warnings from aampdist.py itself, unrelated to this change).

To Do List

Standing checklist from @seanlaw for this migration, applies to every file in the split - status below is for test_aampdist_snippets.py:

  • Each test file correctly replaces all uses of npt.assert_almost_equal with its equivalent npt.assert_allclose
  • When rtol=0 for npt.assert_allclose, simply omit this parameter and value since this is the default
  • Ensure that npt.assert_allclose(actual, desired) always has the stumpy computed value as actual and the naive computation as desired
  • Use atol=1.5e-07 rather than atol=1.5*10**-07 - only applies to the one call site that used the implicit default; the rest reference config.STUMPY_TEST_PRECISION directly since that's a genuinely different (looser) tolerance
  • Eventually, replace the ugly 1.5*10**-config.STUMPY_TEST_PRECISION with config.STUMPY_TEST_PRECISION = 1.5e-07 (in config.py) - tracked as a follow-up, not part of this per-file migration
  • Use cmp instead of comp - this file already used cmp_ naming, nothing to rename
  • Rename naive outputs to ref_ and stumpy-computed outputs to cmp_ (applies to npt.assert_array_equal too) - this file already used ref_/cmp_, no assert_array_equal calls present
  • Titles/bodies no longer use closing keywords (Fixed #N) so individual file PRs don't prematurely auto-close Migrate to npt.assert_allclose #1175 - cross-referenced with Related to #1175 instead

Pull Request Checklist

Below is a simple checklist but please do not hesitate to ask for assistance!

  • Read our Contributing Guide
  • Referenced a Github issue (or create one if one doesn't already exist)
  • Read and reviewed all of the comments in the Github issue that you've referenced (along with cross-referenced issues/pull requests) to ensure that the issue still requires a pull request
  • Checked that the issue has not already been assigned to anybody else or is already being addressed in another pull request
  • Left a meaningful comment on the original Github issue to discuss the detailed approach for your contribution and received confirmation from the maintainers before proceeding with this pull request
  • Forked, cloned, and checked out the newest version of the code
  • Created a new branch
  • Made necessary code changes
  • Installed black (i.e., python -m pip install black or conda install -c conda-forge black)
  • Installed flake8 (i.e., python -m pip install flake8 or conda install -c conda-forge flake8)
  • Installed pytest-cov (i.e., python -m pip install pytest-cov or conda install -c conda-forge pytest-cov)
  • Ran black --exclude=".*\.ipynb" --extend-exclude=".venv" --diff ./ in the root stumpy directory
  • Ran flake8 --extend-exclude=.venv ./ in the root stumpy directory
  • Ran ./setup.sh dev && ./test.sh in the root stumpy directory and ensured that all tests are passing locally
  • Check this box if AI code assistance was used to generate 15%+ of the code in this pull request

Please do not commit any code to avoid/circumvent a failing test and, instead, engage in a discussion (below) to determine the best course of action.

Only request a review after the checklist above is fully completed!

@viknesh-ai
viknesh-ai requested a review from seanlaw as a code owner August 16, 2026 15:14
@gitnotebooks

gitnotebooks Bot commented Aug 16, 2026

Copy link
Copy Markdown

Review these changes at https://app.gitnotebooks.com/stumpy-dev/stumpy/pull/1185

@viknesh-ai

Copy link
Copy Markdown
Contributor Author

@seanlaw next file in the split — same conventions as the previous PRs. Ready for review whenever you have time.

@seanlaw
seanlaw merged commit 858a12c into stumpy-dev:main Aug 16, 2026
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate to npt.assert_allclose

2 participants