CUQI-DTU / CUQIpy

https://cuqi-dtu.github.io/CUQIpy/
Apache License 2.0
41 stars 7 forks source link

Documentation of the samples.plot_ci() method #443

Open MarkusTHolm opened 2 months ago

MarkusTHolm commented 2 months ago

The documentation is quite convoluted for which kwargs should be passed to the plot_ci().

For example, when trying to modify the colors of the credibility interval the keyword arguments are passed to the matplotlib.pyplot.collections. However, this is not immediately obvious from looking into the code of the plot_ci() function. So, maybe some more detailed documentation of the plot_ci() method could be considered?.

Example from CUQI book chapter 3: MH_samples_funvals.plot_ci(exact=x_true, plot_envelope_kwargs={'facecolor': 'b'}) CWMH_samples_funvals.plot_ci(exact=x_true, plot_envelope_kwargs={'facecolor': 'g'})

image