threshold

Thresholding Metrics API

This module provides utility functions to threshold model predictions.

Functions

Name	Description
get_predicted_threshold_indices	Get prediction indices that are above threshold (confidence level)
threshold_predictions	Get thresholded predictions

Machine-readable model

• get_predicted_threshold_indicesfunctionGet prediction indices that are above threshold (confidence level).
• threshold_predictionsfunctionGet prediction indices that are above threshold (confidence level).

function

get_predicted_threshold_indices

Python

Get prediction indices that are above threshold (confidence level).

helia_edge/metrics/threshold.py:16

get_predicted_threshold_indices(y_prob: npt.NDArray, y_pred: npt.NDArray, threshold: float = 0.5) -> npt.NDArray

Get prediction indices that are above threshold (confidence level). This is useful to remove weak predictions that can happen due to noisy data or poor model performance.

Parameters

Parameters of get_predicted_threshold_indices

Name	Type	Default	Description
y_prob	npt.NDArray	Required	Model output as probabilities
y_pred	npt.NDArray	Required	Model predictions. Defaults to None.
threshold	float	0.5	Confidence level

Returns

Returns of get_predicted_threshold_indices

Type	Description
npt.NDArray	npt.NDArray: Indices of y_prob that satisfy threshold

function

threshold_predictions

Python

Get prediction indices that are above threshold (confidence level).

helia_edge/metrics/threshold.py:40

threshold_predictions(
    y_prob: npt.NDArray,
    y_pred: npt.NDArray,
    y_true: npt.NDArray,
    threshold: float = 0.5,
) -> tuple[npt.NDArray, npt.NDArray, npt.NDArray]

Get prediction indices that are above threshold (confidence level). This is useful to remove weak predictions that can happen due to noisy data or poor model performance.

Parameters

Parameters of threshold_predictions

Name	Type	Default	Description
y_prob	npt.NDArray	Required	Model output as probabilities
y_pred	npt.NDArray	Required	Model predictions. Defaults to None.
y_true	npt.NDArray	Required	True labels
threshold	float	0.5	Confidence level. Defaults to 0.5.

Returns

Returns of threshold_predictions

Type	Description
tuple[npt.NDArray, npt.NDArray, npt.NDArray]	tuple[npt.NDArray, npt.NDArray, npt.NDArray]: Thresholded predictions