larch.model.troubleshooting.low_variance_data_co#

low_variance_data_co(model: NumbaModel, repair: Literal['?', '!'] = '?', verbose: int = 3)[source]#

Check if any data_co columns have very low variance.

Parameters:

model (larch.Model) – The model to check.
repair ({"?", "!"}) – No repairs are available for this check. The question mark simply emits a warning if there are issues found, while the exclamation mark will raise an error.
verbose (int, default 3) – The number of example columns to list if there is a problem.

Returns:

model (larch.Model) – The model with revised dataset attached.
diagnosis (pd.DataFrame) – The number of bad instances, and some example rows.

Raises:

ValueError – If the repair is set to ‘!’ and there are any low variance columns found.