compileml.runtime — primitives

format_reasons

def format_reasons(c2: collections.abc.Sequence[int], impact_int: collections.abc.Sequence[int], feature_names: collections.abc.Sequence[str], reasons_dict: dict, display_names: dict, top_k: int) -> tuple[list[dict], list[dict]]

from compileml.runtime import format_reasons

Adverse and favorable reason blocks (§7.6).

Positive contribution = risk-increasing = adverse. Suppressed features are excluded from reasons (their contribution still exists).

Parameters#

NameTypeDefaultKind
c2collections.abc.Sequence[int]requiredpositional
impact_intcollections.abc.Sequence[int]requiredpositional
feature_namescollections.abc.Sequence[str]requiredpositional
reasons_dictdictrequiredpositional
display_namesdictrequiredpositional
top_kintrequiredpositional

Returns#

tuple[list[dict], list[dict]]