Skip to content

Core

core

Flag Core Module: rule discovery and Z(X) construction (training data only).

FlagCoreModule 

FlagCoreModule(task: str, quantile_low: tuple[float, float] = (0.05, 0.45), quantile_high: tuple[float, float] = (0.55, 0.95), quantile_step: float = 0.05, min_support: int | str = 'auto', fdr_alpha: float = 0.05, effect_size: str = 'risk_difference', missing: str = 'no_evidence')

Discovers per-feature flag bases and assembles the sparse Z(X) matrix.

Source code in src/flaggam/core.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def __init__(
    self,
    task: str,
    quantile_low: tuple[float, float] = (0.05, 0.45),
    quantile_high: tuple[float, float] = (0.55, 0.95),
    quantile_step: float = 0.05,
    min_support: int | str = "auto",
    fdr_alpha: float = 0.05,
    effect_size: str = "risk_difference",
    missing: str = "no_evidence",
) -> None:
    self.task = task
    self.quantile_low = quantile_low
    self.quantile_high = quantile_high
    self.quantile_step = quantile_step
    self.min_support = min_support
    self.fdr_alpha = fdr_alpha
    self.effect_size = effect_size
    self.missing = missing