Skip to content
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

improve Pareto k warning message #3224

Merged
merged 2 commits into from
Sep 2, 2023
Merged

improve Pareto k warning message #3224

merged 2 commits into from
Sep 2, 2023

Conversation

jgabry
Copy link
Member

@jgabry jgabry commented Sep 1, 2023

Submission Checklist

  • Run unit tests: ./runTests.py src/test/unit
  • Run cpplint: make cpplint
  • Declare copyright holder and open-source license: see below

Summary

Fixes #3223. Improves misleading Pareto k warning message. I didn't see any tests that check the text of this message so I didn't edit any tests.

The old message said "...which often indicates model misspecification", but this is somewhat misleading. More accurate is
"... which may indicate a poor approximation of the target distribution or model misspecification".

@avehtari What do you think of this message?

Intended Effect

Change text of warning message.

How to Verify

I suppose run a model that results in the warning message (are there any we know to definitely trigger the warning? Aki will probably know), but I think it’s sufficient to just look at the edited text.

Side Effects

Documentation

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company): Columbia University

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

@jgabry
Copy link
Member Author

jgabry commented Sep 1, 2023

I asked @avehtari for feedback but if anyone else has ideas for the content of the message that would be great too. Ideally in the next couple of days so this can be merged before the release.

@avehtari
Copy link
Collaborator

avehtari commented Sep 1, 2023

The model misspecification is not relevant here, and probably was mistakenly carried over from LOO-CV diagnostic.

I would write
"Pareto k diagnostic value is greater than 0.7 which may indicate a poor approximation and indicates that importance resampling is not able to improve the approximation."

@jgabry
Copy link
Member Author

jgabry commented Sep 1, 2023

"Pareto k diagnostic value is greater than 0.7 which may indicate a poor approximation and indicates that importance resampling is not able to improve the approximation."

Does this slightly edited version convey the right thing to the user?

“The Pareto k diagnostic value is greater than 0.7. Importance resampling was not able to improve the approximation, which may indicate that the approximation itself is poor.”

@avehtari
Copy link
Collaborator

avehtari commented Sep 1, 2023

ok

@jgabry
Copy link
Member Author

jgabry commented Sep 1, 2023

Ok, now updated

@jgabry
Copy link
Member Author

jgabry commented Sep 2, 2023

Will go ahead and merge since approved and everything is passing.

@jgabry jgabry merged commit 01c87bc into develop Sep 2, 2023
2 checks passed
@jgabry jgabry deleted the fix-pathfinder-warning branch September 2, 2023 00:14
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.

Pathfinder warning message is misleading
3 participants