Update docstring and args #823
Merged
Conversation
This file contains 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
tomicapretto
reviewed
Jul 6, 2024
tomicapretto
reviewed
Jul 6, 2024
tomicapretto
reviewed
Jul 6, 2024
bambi/models.py
Outdated
| ``posterior_predictive`` group to ``idata``. If any of these already exist, it will be | ||
| overwritten. | ||
| ``idata`` with the predictions added. If ``kind="response_params"``, a new variable | ||
| with the name of the parent parameter, e.g. ``"mu"`` or ``"p"``is added to the |
There was a problem hiding this comment.
Here it can be multiple parameters (e.g. both mu and sigma)
There was a problem hiding this comment.
Good point. I updated it to include 2 minimal examples (Gaussian and Bernoulli) so the user can reason what parameters to expect in the posterior group.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #823 +/- ##
==========================================
- Coverage 90.01% 89.94% -0.08%
==========================================
Files 47 47
Lines 3967 3969 +2
==========================================
- Hits 3571 3570 -1
- Misses 396 399 +3 ☔ View full report in Codecov by Sentry. |
tomicapretto
approved these changes
Jul 8, 2024
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.
This PR changes the docstring of
kindinmodel.predictto reflect the changes in #804.Additionally, in the
interpretfunctionpredictions, we allow the user to compute posterior predictive samples. I updated the argument passed tomodel.predictfromkind="pps"tokind="response"to reflect the changes in the merged PR above.