-
-
Notifications
You must be signed in to change notification settings - Fork 396
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add warning for log scale default in compare/loo/waic functions #1150
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I personally like the space before the colon, and it looks like it is common formatting (see pandas.read_csv
), but I would not oppose to changing the format
Yeah, but weirdly it also take the argument's type when double-clicking it. When you remove the white space, it just selects the parameter, as it should -- don't know why 🤷 Thanks for the review Oriol, I updated in light of your comments. |
Ohh, true, I hadn't noticed, and it looks like it happens with any documentation with space before the colon 🤔 |
Yeah that's weird 😅 Do we still need |
I think we don't need it. What is it now? |
Now it includes the warning I introduced in this PR:
when default,
when pointwise. |
It can be removed, black is also complaining, make sure to run black right before commiting |
Done! Thanks guys 👌 |
Codecov Report
@@ Coverage Diff @@
## master #1150 +/- ##
==========================================
+ Coverage 92.99% 93.12% +0.13%
==========================================
Files 94 94
Lines 9242 9286 +44
==========================================
+ Hits 8595 8648 +53
+ Misses 647 638 -9
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
very minor comments. it should also be added to the changelog and will be ready to merge
Thanks Oriol! It's now updated -- and I had already added it to the changelog 👌 |
* added groups * update tests and changelog * lint changes * update from_dict and tests * update changelog * modify io_dict * minor fixes * update changelog again Add warning for log scale default in compare/loo/waic functions (arviz-devs#1150) * Added scale warning to ELPDData * Added scale warning to compare function * Added changes to Changelog * Moved warning to end of string in loo function * Removed last test for loo_print * Ran Black * Integrated Oriol's comments add local to docstring, and use lowercase for ess (arviz-devs#1152) hardcode show=False in plot_posterior subplots (arviz-devs#1151) * hardcode show=False in plot_posterior subplots * update changelog Fix documentation and deprecation warning in pair plot (arviz-devs#1156) The "kind" argument is not described correctly. * Fix pairplot warning. Previously, because of incorrect argument checking, pairplot would mistakenly warn the caller not to use the "contour" argument when that argument was NOT supplied. Changed default value to None and did the defaulting by hand to fix this issue. Also added some type declarations. * Clarified docstring for contour argument. Co-authored-by: Robert P. Goldman <[email protected]> add viridis as default cmap (arviz-devs#1160) add examples to customize 2D KDE (arviz-devs#1158) * add examples to customize 2D KDE * blackify gallery example * update changelog * briefly explain contour_kwargs and contourf_kwargs
Description
This PR adds a reminder about log scale default and how it should be interpreted (higher is better) for
az.waic
andaz.loo
. This merely mirrors what we already say in the doc.For
az.compare
I added aUserWarning
following the change to log scale in 0.7.0. This adresses this issue, and the warning will be temporary, as discussed in the issue.In passing, I trailed all the white spaces before colons in the docstrings of
stats.py
. This messes up the formatting on the website.I'm here for any change, and thanks in advance for the review 🖖