plot_segmented_adverse_impact_ratio#

solas_disparity.plots.plot_segmented_adverse_impact_ratio(...)#

Generate a plot for a segmented AIR result object.

Parameters

  • disparity (Disparity) – Disparity result.

  • column (str, optional) – Column to plot. Defaults to const.AIR_VALUES.

  • segment (Optional[str], optional) – Segment slice of the summary table to plot. If None, plot all segments. Defaults to None.

  • separate (bool, optional) – Whether to generate a separate figure for each segment. Defaults to False.

  • group (Optional[str], optional) – Group slice of the summary table to plot. If None, plot all groups. Defaults to None.

Returns

A figure or list of interactive plotly figures if separate is set to True.

Return type

Union[Figure, List[Figure]]