improve naming to make logic clearer#902
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies the meaning of params_only throughout the JAX/ONNX likelihood wrappers by updating documentation and renaming an internal flag to better reflect whether observed data is present.
Changes:
- Expanded
params_onlydocstrings to explicitly describe the expected callable signature (f(data, *params)vsf(*params)). - Renamed an internal Op state flag from
is_params_onlytohas_datato match the actual boolean meaning. - Removed leftover debug
print()statements.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/hssm/distribution_utils/onnx.py |
Clarifies params_only semantics for ONNX-derived JAX logp constructors. |
src/hssm/distribution_utils/jax.py |
Renames internal flag to has_data, aligns conditionals, and improves params_only documentation. |
src/hssm/distribution_utils/dist.py |
Updates make_likelihood_callable docs to explain params_only as signature control (and None treated as False). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
digicosmos86
approved these changes
Feb 25, 2026
Collaborator
digicosmos86
left a comment
digicosmos86
left a comment
There was a problem hiding this comment.
Great! I like this change!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The way params_only was used before was highly confusing as it propagated through the function calls. It had one meaning and then suddenly flipped it's meaning conceptually.
This rename should make it clearer what it is actually doing at the level of the jax function constructors.