Skip to content

BiorthBasis parameter 'subsamp' and 'samplesz' are duplicates!#222

Merged
The9Cat merged 11 commits into
develfrom
covarianceParameterConfusion
May 29, 2026
Merged

BiorthBasis parameter 'subsamp' and 'samplesz' are duplicates!#222
The9Cat merged 11 commits into
develfrom
covarianceParameterConfusion

Conversation

@The9Cat
Copy link
Copy Markdown
Member

@The9Cat The9Cat commented May 28, 2026

Summary

As identified by @jngaravitoc, we use both subsamp and samplesz, in pyEXP and EXP respectively, to indicate the number of bootstrap subsamples for covariance estimation.

Changes

These should be the same. This PR replaces subsamp by samplesz while still allowing subsamp and emits a deprecation warning if subsamp is used.

pyEXP docstrings updated for consistency with this change.

@The9Cat The9Cat added the invalid This doesn't seem right label May 28, 2026
@The9Cat The9Cat requested a review from Copilot May 28, 2026 21:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Aligns the configuration key used to set the number of bootstrap subsamples for coefficient covariance: pyEXP/expui BiorthBasis-derived classes (Spherical, Cylindrical, FlatDisk, Cube) now accept samplesz in addition to the legacy subsamp key, matching the convention already used in the EXP runtime (src/Cube.cc, src/Cylinder.cc, src/AxisymmetricBasis.cc). Use of subsamp still works but emits a deprecation warning, and the top-level pyEXP covariance documentation is updated to refer to samplesz.

Changes:

  • Parse samplesz (after subsamp, so it takes precedence) in Spherical, Cylindrical, FlatDisk, and Cube initializers.
  • Emit a deprecation warning when the legacy subsamp key is supplied; also relabel the existing eof_file warning prefix from Cylinder to Cylindrical.
  • Update the top-level covariance docstring in pyEXP/BasisWrappers.cc to describe samplesz (and rename subsamp to samplesz in the returned-array dimension description).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

File Description
expui/BiorthBasis.cc Adds samplesz parsing alongside subsamp plus deprecation warnings in four BiorthBasis classes; fixes one warning prefix.
pyEXP/BasisWrappers.cc Renames subsampsamplesz in the general covariance documentation block.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread expui/BiorthBasis.cc Outdated
Comment thread expui/BiorthBasis.cc Outdated
Comment thread expui/BiorthBasis.cc Outdated
Comment thread expui/BiorthBasis.cc Outdated
Comment thread expui/BiorthBasis.cc
Comment thread pyEXP/BasisWrappers.cc Outdated
The9Cat and others added 4 commits May 28, 2026 17:48
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@The9Cat The9Cat changed the title BiorthBasis parameter 'subsamp' by 'samplesz' are duplicates BiorthBasis parameter 'subsamp' and 'samplesz' are duplicates! May 28, 2026
@michael-petersen
Copy link
Copy Markdown
Member

Thanks, and I like the deprecation warning. I think we had loosely been trying to enforce a policy where we specify that the next minor release will deprecate the feature, so we could be explicit here (e.g. 7.11) , or just leave this vague.

@The9Cat
Copy link
Copy Markdown
Member Author

The9Cat commented May 29, 2026

Ah, you are right. I'll add 7.11 to the warning. To be helpful, we could convert these same deprecation warnings to exceptions at 7.11.

@The9Cat The9Cat merged commit cb83303 into devel May 29, 2026
8 checks passed
@The9Cat The9Cat deleted the covarianceParameterConfusion branch May 29, 2026 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

invalid This doesn't seem right

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants