acerbilab / pyvbmc

PyVBMC: Variational Bayesian Monte Carlo algorithm for posterior and model inference in Python
https://acerbilab.github.io/pyvbmc/
BSD 3-Clause "New" or "Revised" License
114 stars 6 forks source link

Some possible mistakes in docstring for `VBMC` class #136

Closed matt-graham closed 1 year ago

matt-graham commented 1 year ago

Raising issue as part of JOSS review openjournals/joss-reviews/issues/5428

The docstring for the VBMC class specifies the key in the options dict for specifying to use a noisy log target density as specifytargetnoise

https://github.com/acerbilab/pyvbmc/blob/b7c6e381be75dd508ac9663825fd77ed8885816d/pyvbmc/vbmc/vbmc.py#L51

while elsewhere in the documentation specify_target_noise is used and this seem to correspond to what's assumed in the code

https://github.com/acerbilab/pyvbmc/blob/b7c6e381be75dd508ac9663825fd77ed8885816d/pyvbmc/vbmc/option_configs/basic_vbmc_options.ini#L19

There is also a note indicating PyVBMC does not currently support noisy target density evaluations which I think is no longer true (?) given there is a tutorial example for this case

https://github.com/acerbilab/pyvbmc/blob/b7c6e381be75dd508ac9663825fd77ed8885816d/pyvbmc/vbmc/vbmc.py#L114-L117

lacerbi commented 1 year ago

Thanks for spotting this!

@Bobby-Huggins can you please fix this when you have the time?

Bobby-Huggins commented 1 year ago

Fixed in pull #140.