deepecgkit.evaluation¶
Model evaluation, metrics computation, and visualization tools.
Evaluator¶
ECGEvaluator
¶
Comprehensive evaluator for ECG models.
This class provides a unified interface for evaluating ECG models with various metrics and analysis tools.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metrics
|
Optional[List[str]]
|
List of metrics to compute |
None
|
task_type
|
str
|
Type of task ("classification", "regression", "auto") |
'auto'
|
device
|
str
|
Device for model evaluation |
'auto'
|
Examples:
>>> evaluator = ECGEvaluator(metrics=["accuracy", "auc", "f1"])
>>> results = evaluator.evaluate(model, test_data)
Source code in deepecgkit/evaluation/evaluator.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | |
evaluate
¶
evaluate(
model: Optional[Union[Module, ndarray]] = None,
test_data: Optional[
Union[DataLoader, ndarray, tuple]
] = None,
return_predictions: bool = False,
y_scores: Optional[ndarray] = None,
) -> Dict[str, float]
Evaluate model performance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Optional[Union[Module, ndarray]]
|
PyTorch model or numpy array of predictions |
None
|
test_data
|
Optional[Union[DataLoader, ndarray, tuple]]
|
Test data loader or (predictions, targets) tuple |
None
|
return_predictions
|
bool
|
Whether to return predictions along with metrics |
False
|
y_scores
|
Optional[ndarray]
|
Scores/probabilities for AUC calculation (optional) |
None
|
Returns:
| Type | Description |
|---|---|
Dict[str, float]
|
Dictionary of metric values |
Source code in deepecgkit/evaluation/evaluator.py
cross_validate
¶
cross_validate(
model_class: type,
data: Any,
k_folds: int = 5,
**model_kwargs,
) -> Dict[str, List[float]]
Perform k-fold cross-validation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_class
|
type
|
Class of model to evaluate |
required |
data
|
Any
|
Dataset for cross-validation |
required |
k_folds
|
int
|
Number of folds |
5
|
**model_kwargs
|
Keyword arguments for model initialization |
{}
|
Returns:
| Type | Description |
|---|---|
Dict[str, List[float]]
|
Dictionary of metric scores across folds |
Source code in deepecgkit/evaluation/evaluator.py
bootstrap_evaluate
¶
bootstrap_evaluate(
model: Any,
test_data: Any,
n_bootstrap: int = 1000,
confidence_level: float = 0.95,
) -> Dict[str, Dict[str, float]]
Bootstrap evaluation for confidence intervals.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Any
|
Trained model |
required |
test_data
|
Any
|
Test dataset |
required |
n_bootstrap
|
int
|
Number of bootstrap samples |
1000
|
confidence_level
|
float
|
Confidence level for intervals |
0.95
|
Returns:
| Type | Description |
|---|---|
Dict[str, Dict[str, float]]
|
Dictionary with mean, std, and confidence intervals for each metric |
Source code in deepecgkit/evaluation/evaluator.py
generate_report
¶
generate_report(
model: Any,
test_data: Any,
save_path: Optional[str] = None,
y_scores: Optional[ndarray] = None,
) -> pd.DataFrame
Generate comprehensive evaluation report.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Any
|
Trained model |
required |
test_data
|
Any
|
Test dataset |
required |
save_path
|
Optional[str]
|
Path to save report (optional) |
None
|
y_scores
|
Optional[ndarray]
|
Scores/probabilities for AUC calculation (optional) |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with evaluation results |
Source code in deepecgkit/evaluation/evaluator.py
Metrics¶
calculate_classification_metrics
¶
calculate_classification_metrics(
y_true: ndarray,
y_pred: ndarray,
metrics: Optional[List[str]] = None,
) -> Dict[str, float]
Calculate classification metrics.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
y_true
|
ndarray
|
True labels |
required |
y_pred
|
ndarray
|
Predicted labels or probabilities |
required |
metrics
|
Optional[List[str]]
|
List of metrics to compute |
None
|
Returns:
| Type | Description |
|---|---|
Dict[str, float]
|
Dictionary of computed metrics |
Source code in deepecgkit/evaluation/metrics.py
calculate_regression_metrics
¶
calculate_regression_metrics(
y_true: ndarray,
y_pred: ndarray,
metrics: Optional[List[str]] = None,
) -> Dict[str, float]
Calculate regression metrics.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
y_true
|
ndarray
|
True values |
required |
y_pred
|
ndarray
|
Predicted values |
required |
metrics
|
Optional[List[str]]
|
List of metrics to compute |
None
|
Returns:
| Type | Description |
|---|---|
Dict[str, float]
|
Dictionary of computed metrics |
Source code in deepecgkit/evaluation/metrics.py
confusion_matrix_analysis
¶
Detailed confusion matrix analysis.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
y_true
|
ndarray
|
True labels |
required |
y_pred
|
ndarray
|
Predicted labels |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dictionary with confusion matrix and derived metrics |
Source code in deepecgkit/evaluation/metrics.py
Visualization¶
plot_confusion_matrix
¶
plot_confusion_matrix(
y_true: ndarray,
y_pred: ndarray,
class_names: Optional[List[str]] = None,
title: str = "Confusion Matrix",
save_path: Optional[str] = None,
)
Plot confusion matrix.
Source code in deepecgkit/evaluation/visualization.py
plot_roc_curve
¶
plot_roc_curve(
y_true: ndarray,
y_scores: ndarray,
title: str = "ROC Curve",
save_path: Optional[str] = None,
)
Plot ROC curve.
Source code in deepecgkit/evaluation/visualization.py
plot_training_curves
¶
plot_training_curves(
metrics_path: str,
save_dir: Optional[str] = None,
save_path: Optional[str] = None,
)
Plot training and validation loss and accuracy as separate figures.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metrics_path
|
str
|
Path to CSVLogger metrics.csv file. |
required |
save_dir
|
Optional[str]
|
Directory to save separate loss.png and accuracy.png files. |
None
|
save_path
|
Optional[str]
|
Deprecated combined path; if provided and save_dir is not, saves loss plot to this path for backward compatibility. |
None
|
Source code in deepecgkit/evaluation/visualization.py
plot_ecg_signals
¶
plot_ecg_signals(
data: ndarray,
sampling_rate: float = 500.0,
leads: Optional[List[str]] = None,
title: str = "ECG Signals",
save_path: Optional[str] = None,
)
Plot ECG signals.
Source code in deepecgkit/evaluation/visualization.py
plot_predictions
¶
plot_predictions(
y_true: ndarray,
y_pred: ndarray,
title: str = "Predictions vs True Values",
save_path: Optional[str] = None,
)
Plot predictions vs true values.
Source code in deepecgkit/evaluation/visualization.py
plot_calibration_curve
¶
plot_calibration_curve(
y_true: ndarray,
y_prob: ndarray,
class_names: Optional[List[str]] = None,
n_bins: int = 10,
title: str = "Calibration Plot",
save_dir: Optional[str] = None,
save_path: Optional[str] = None,
)
Plot reliability diagram and prediction distribution as separate figures.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
y_true
|
ndarray
|
True labels. |
required |
y_prob
|
ndarray
|
Predicted probabilities (n_samples, n_classes). |
required |
class_names
|
Optional[List[str]]
|
Optional list of class names. |
None
|
n_bins
|
int
|
Number of bins for calibration curve. |
10
|
title
|
str
|
Title for the calibration curve plot. |
'Calibration Plot'
|
save_dir
|
Optional[str]
|
Directory to save calibration_curve.png and prediction_distribution.png. |
None
|
save_path
|
Optional[str]
|
Deprecated combined path; if provided and save_dir is not, uses its parent directory for backward compatibility. |
None
|