Skip to content

Fixed #1175 Migrate tests/test_aampdist.py to npt.assert_allclose - #1184

Open
viknesh-ai wants to merge 1 commit into
stumpy-dev:mainfrom
viknesh-ai:fix/1175-migrate-test-aampdist
Open

Fixed #1175 Migrate tests/test_aampdist.py to npt.assert_allclose#1184
viknesh-ai wants to merge 1 commit into
stumpy-dev:mainfrom
viknesh-ai:fix/1175-migrate-test-aampdist

Conversation

@viknesh-ai

Copy link
Copy Markdown
Contributor

Fixed #1175

Continuing the file-by-file split from #1178/#1181/#1182/#1183 — this one covers tests/test_aampdist.py. Will open the next file's PR once this one merges.

assert_almost_equal only checks a fixed absolute tolerance and NumPy's docs recommend assert_allclose instead. 7 call sites, same two fixes as the earlier files:

  • Renamed comp_aampdist_vect/comp_mpdist to cmp_aampdist_vect/cmp_mpdist per the standing convention.
  • Argument order was backwards everywhere (ref_X, comp_X instead of cmp_X, ref_X) — flipped all 7.

Checked the return dtypes from _aampdist_vect and aampdist before touching anything — both come back plain float64, so no .astype() casting was needed here (unlike test_aamp.py/test_aamp_motifs.py/test_aamp_stimp.py, where the naive helper's mixed float/int output forced a cast). None of the original calls specified decimal=, so every site uses the default atol=1.5e-07.

Ran the full file twice locally (normal mode and JIT-disabled/CUDA-simulated, matching test.sh coverage) — 38/38 passing both times.

To Do List

Standing checklist from @seanlaw for this migration, applies to every file in the split - status below is for test_aampdist.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
  • 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 used comp_aampdist_vect/comp_mpdist, both renamed
  • Rename naive outputs to ref_ and stumpy-computed outputs to cmp_ (applies to npt.assert_array_equal too) - this file already used ref_, no assert_array_equal calls present

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 04:59
@gitnotebooks

gitnotebooks Bot commented Aug 16, 2026

Copy link
Copy Markdown

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

@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 commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

@viknesh-ai From this point forward, we should stop using "Fixed #number" as all of the PRs will reference the original issue and auto-close the issue. Simply leave the issue number out of the title and cross reference the issue in the initial comment.

For this PR, please update the title to omit the "Fixed #1175" part

@seanlaw seanlaw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Everything looks good on my end @viknesh-ai. Ready to merge?

Also, feel free to submit 2-3 PRs at a time now (again, please omit the title cross reference to the original issue).

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