describe_families

rubin_sim.maf.run_comparison.describe_families(families, summary=None, table_metric_set=None, plot_metric_set=None, baseline_run=None, round_table=2)

Display (in a jupyter on IPython notebook) family descirptions

Parameters:

familiespandas.DataFrame

Data family descriptions as returned by get_family_descriptions.

summarypandas.DataFrame

Summary metrics for each run, as returned by get_metric_summaries.

table_metric_setpandas.DataFrame

Metadata on metrics to be included in the table, with columns and index as returned by get_metric_sets. None if no metrics should be included in the table.

plot_metric_setpandas.DataFrame

Metadata on metrics to be included in the plot, with columns and index as returned by get_metric_sets. None if no plot should be made.

baseline_runstr

The name of the run to use to normalize metrics in the plot. None if normalization should be skipped.

round_tableint, opt

Decimal places to which to round the table_metrics. Default 2.

Returns:

figmatplotlib.figure.Figure

The plot figure.

axmatplotilb.axes.Axes

The plot axes.