ceteris_paribus.plots package

Submodules

ceteris_paribus.plots.plots module

ceteris_paribus.plots.plots.plot(cp_profile, *args, destination='browser', show_profiles=True, show_observations=True, show_residuals=False, show_rugs=False, aggregate_profiles=None, selected_variables=None, color=None, size=2, alpha=0.4, color_pdps=None, size_pdps=None, alpha_pdps=None, color_points=None, size_points=None, alpha_points=None, color_residuals=None, size_residuals=None, alpha_residuals=None, height=500, width=600, plot_title='', yaxis_title='y', print_observations=True, **kwargs)

Plot ceteris paribus profile

Parameters:
  • cp_profile – ceteris paribus profile
  • args – next (optional) ceteris paribus profiles to be plotted along
  • destination – available browser - open plot in a new tab, notebook - embed a plot in jupyter notebook if possible
  • show_profiles – whether to show profiles
  • show_observations – whether to show individual observations
  • show_residuals – whether to plot residuals
  • show_rugs – whether to plot rugs
  • aggregate_profiles – if specified additional aggregated profile will be plotted, available values: mean, median
  • selected_variables – variables selected for the plots
  • color – color for profiles - either a color or a variable that should be used for coloring
  • size – size of lines to be plotted
  • alpha – opacity of lines (between 0 and 1)
  • color_pdps – color of pdps - aggregated profiles
  • size_pdps – size of pdps - aggregated profiles
  • alpha_pdps – opacity of pdps - aggregated profiles
  • color_points – color points to be plotted
  • size_points – size of points to be plotted
  • alpha_points – opacity of points
  • color_residuals – color of plotted residuals
  • size_residuals – size of plotted residuals
  • alpha_residuals – opacity of plotted residuals
  • height – height of the window containing plots
  • width – width of the window containing plots
  • plot_title – Title of the plot displayed above
  • yaxis_title – Label for the y axis
  • print_observations – whether to print the table with observations values
  • kwargs – other options passed to the plot
ceteris_paribus.plots.plots.plot_notebook(cp_profile, *args, **kwargs)

Wrapper for the plot function with option to embed in the notebook

Module contents