describe_solution_columns

site.SiteSolutionSet.describe_solution_columns(return_dict=False)
    Print (or return) `solution_df`'s columns grouped by what they
    mean, for a first look at a table that can otherwise run to
    30-40 columns (`show_solutions_colnames()` lists them, but flatly,
    with no indication of which ones are related or why they're there).

Groups whose columns are genuinely absent from solution_df (e.g. “Change vs a baseline” without solve(baseline= ...)) are omitted, as are “Coverage” and “Equity” when their columns are present but hold nothing but placeholder NaN/None/ “N/A …” values (those two are always part of solution_df’s schema, unlike the others, so column presence alone can’t be used to decide whether to show them). Within a group, columns are listed in solution_df’s own column order. A group named “Other” is printed last if any column doesn’t match a known category (e.g. a metric added after this method was last updated) – see return_solution_metrics()’s docstring for what every column actually means.

Parameters

    return_dict : bool, default False
        If True, return `{group_name: [column_name, ...]}` instead of
        printing it.

Returns

    dict or None
        The grouped columns if `return_dict=True`; otherwise None (the
        grouping is printed instead).
Back to top