plot_scatter()#
- liesel.goose.summary_viz.plot_scatter(results, params, param_indices, chain_indices=None, max_chains=5, alpha=0.2, title=None, title_spacing=0.9, style='whitegrid', color_list=None, figure_size=(9, 6), legend_position='best', save_path=None, include_warmup=False)[source]#
Produces a scatterplot of two parameters.
- Parameters:
results (
SamplingResults
) – Result object of the sampling process. Must have a methodget_posterior_samples()
which extracts all samples from the posterior distribution.params (
list
[str
]) – Names of the model parameters that are contained in the plot. Must coincide with the dictionary keys of thePosition
with the posterior samples.param_indices (
tuple
[int
,int
]) – Indices of each model parameter that are contained in the plot. Selects e.g.beta[0]
out of abeta
parameter vector. If only one string is supplied as the value ofparams
,param_indices
must contain two indices. If a sequence of two strings is supplied toparams
, you can supply either a single integer or a tuple of two integers. A single integer will be used as the index for both parameters. If you use a tuple of two integers, the first element will be used as the index for the first parameter, and the second element will be used as the index for the second parameter.chain_indices (
Union
[int
,Sequence
[int
],None
]) – Indices of chains for each model subparameter that are contained in the plot. (default:None
) Selects e.g. chain 0 and chain 2 out of multiple chains. A single index can be specified as an integer or a sequence containing one integer. IfNone
, all chains are included.max_chains (
Optional
[int
]) – Upper bound how many chains are included within each subplot/facet. Avoids (default:5
) overplotting. IfNone
, all chains contained in theresults
input are plotted. Always starts chain selection from the lowest chain index upwards. For selecting specific chains use the argumentchain_indices
.alpha (
float
) – Amount of transparency; a float between 0 and 1. (default:0.2
)title_spacing (
float
) – Determines the margin/whitespace between the plot title (set with (default:0.9
)fig.suptitle()
) and the first row of subplots/facets. Passed to thetop
argument offig.subplots_adjust()
.style (
str
) – Passed to thestyle
argument ofsns.set_theme()
. Valid options are (default:'whitegrid'
)darkgrid
,whitegrid
,dark
,white
, andticks
.color_list (
Optional
[list
[str
]]) – Determines the chain colors for all three subplots. Custom colors can be passed (default:None
) with a list of color strings. The length of the list must match the number of chains. IfNone
, the defaulttab10
matplotlib colormap is chosen.figure_size (
tuple
[int
|float
,int
|float
]) – Size of the entire plot grid. Passed to thefigsize
argument of (default:(9, 6)
)plt.figure()
. When changing the figure size consider changing thelegend_position
as well. Generally, a ratio of 3legend_position (
tuple
[float
,float
] |str
) – Determines the color legend position. Coordinates are relative to the upper (default:'best'
) panel within the plot grid. The first coordinate specifies the horizontal, the second coordinate the vertical position. Might require an adjustment when changing thefigure_size
values or the number of chains.save_path (
Optional
[str
]) – File path where the plot is saved. (default:None
)