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

Confusing kwarg in Nested #74

Closed
ParadaCarleton opened this issue Dec 14, 2021 · 3 comments
Closed

Confusing kwarg in Nested #74

ParadaCarleton opened this issue Dec 14, 2021 · 3 comments

Comments

@ParadaCarleton
Copy link
Member

image
Is this the maximum or minimum?

@mileslucas
Copy link
Collaborator

Ah, it should read minimum. It could use a better description, too. Something like,

"Minimum efficiency (samples accepted / samples generated) before fitting the first bounding volume. This is to allow some burn-in of the sampler and avoid spuriously shrinking the bounds, which can decrease evidence estimate accuracy."

@ParadaCarleton
Copy link
Member Author

Ah, it should read minimum. It could use a better description, too. Something like,

"Minimum efficiency (samples accepted / samples generated) before fitting the first bounding volume. This is to allow some burn-in of the sampler and avoid spuriously shrinking the bounds, which can decrease evidence estimate accuracy."

Would you endorse these docstrings?

- `min_ncall`: The minimum number of iterations before fitting the first bound; used to 
avoid shrinking the bounds before burn-in is completed.
- `min_eff`: Minimum efficiency `(samples accepted / samples generated)` before fitting the 
first bound; used to avoid shrinking the bounds before burn-in is completed.

@mileslucas
Copy link
Collaborator

Yes those look great- feel free to PR!

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

No branches or pull requests

2 participants