meridian.analysis.review.configs.ChannelCheckConfig

Base configuration class for channel-level health checks.

Inherits From: BaseConfig

meridian.analysis.review.configs.ChannelCheckConfig(
    failing_channels_threshold: (int | None) = None,
    failing_channels_ratio_threshold: (float | None) = None
)

If both failing_channels_threshold and failing_channels_ratio_threshold are set, the check passes if EITHER condition is satisfied (or both).

failing_channels_threshold Absolute threshold for the number of failing channels allowed before triggering a review status. If None, absolute count tolerance is not applied. If both failing_channels_threshold and failing_channels_ratio_threshold are specified, the check passes if EITHER condition is satisfied (or both).
failing_channels_ratio_threshold The maximum ratio (between 0.0 and 1.0) of failing channels allowed before triggering a review status. If None, ratio tolerance is not applied. If both failing_channels_threshold and failing_channels_ratio_threshold are specified, the check passes if EITHER condition is satisfied (or both).

Methods

is_failing_channels_within_threshold

View source

is_failing_channels_within_threshold(
    n_failing: int, n_total: int
) -> bool

Checks if the number and ratio of failing channels are within threshold.

If both thresholds are specified, the check passes if EITHER condition is satisfied (or both). If no threshold is set, returns True only when n_failing == 0.

Args
n_failing The number of failing channels.
n_total The total number of channels evaluated.

Returns
True if the failing channels are within the tolerance threshold(s), False otherwise.

__eq__

__eq__(
    other
)

Return self==value.

failing_channels_ratio_threshold None
failing_channels_threshold None