create_vbmc_animation

pyvbmc.vbmc.create_vbmc_animation(vbmc: VBMC, path: str, as_frames: bool = False, suptitle='full', **kwargs: dict)

Create and save a gif animation of a VBMC optimization run.

Parameters:

vbmcVBMC

The optimized VBMC.

pathstr

The path where the gif should be saved to.

as_frames: bool, optional

If True, saves the animation as individual frames. The filename will be appended with the frame number. Default False.

suptitle: str, optional

What kind of supertitle to print. “full” (the default) means include the logging action. “iteration” means print only the iteration. “none” means do not supertitle the figures.

**kwargsdict, optional

Keyword arguments, passed to vp.plot().

Raises:

ValueError

If the suptitle option is not one of the three supported values.