deepecgkit¶
Top-level exports from the DeepECG-Kit package.
deepecgkit
¶
DeepECG-Kit: Deep learning library for ECG analysis and arrhythmia classification.
ECGDataModule
¶
Data module for ECG datasets.
Handles dataset creation, train/val/test splitting, and DataLoader construction.
Source code in deepecgkit/datasets/modules.py
15 16 17 18 19 20 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 | |
setup
¶
Set up the datasets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
stage
|
Optional[str]
|
Current stage ('fit', 'validate', 'test', or 'predict') |
None
|
Source code in deepecgkit/datasets/modules.py
train_dataloader
¶
Get the training data loader.
Source code in deepecgkit/datasets/modules.py
val_dataloader
¶
Get the validation data loader.
Source code in deepecgkit/datasets/modules.py
test_dataloader
¶
Get the test data loader.
Source code in deepecgkit/datasets/modules.py
get_metadata
¶
Get metadata about the dataset.
Returns:
| Type | Description |
|---|---|
Dict
|
Dictionary containing dataset metadata |
Source code in deepecgkit/datasets/modules.py
ECGTrainer
¶
Trainer for ECG signal classification and regression models.
Wraps a plain nn.Module and provides fit/test methods with built-in early stopping, checkpointing, LR scheduling, and CSV metric logging.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
The ECG model to train (any nn.Module) |
required | |
train_config
|
Dictionary containing training configuration: - learning_rate: Learning rate for optimizer - scheduler: Dict with 'factor' and 'patience' for ReduceLROnPlateau - binary_classification: Bool, if True uses BCE loss for binary tasks - multi_label: Bool, if True uses BCE loss for multi-label tasks - task_type: 'classification' or 'regression' - pos_weight: Optional list of positive class weights for BCE loss |
required | |
device
|
Device to train on ('auto', 'cpu', 'cuda', 'mps') |
'auto'
|
|
use_plateau_scheduler
|
If True, uses ReduceLROnPlateau, else StepLR |
True
|
Example
model = KanResWideX(input_channels=1, output_size=4) config = { ... "learning_rate": 0.001, ... "scheduler": {"factor": 0.5, "patience": 10}, ... "binary_classification": False, ... } trainer = ECGTrainer(model=model, train_config=config) trainer.fit(data_module, epochs=50)
Source code in deepecgkit/training/train.py
15 16 17 18 19 20 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 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 | |
fit
¶
fit(
data_module,
epochs=50,
early_stopping_patience=10,
checkpoint_dir=None,
log_dir=None,
progress_bar=True,
gradient_clip_val=None,
save_top_k=3,
)
Train the model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_module
|
ECGDataModule (or any object with train_dataloader/val_dataloader) |
required | |
epochs
|
Maximum number of training epochs |
50
|
|
early_stopping_patience
|
Stop after this many epochs without val_loss improvement |
10
|
|
checkpoint_dir
|
Directory to save checkpoints (None to disable) |
None
|
|
log_dir
|
Directory to save CSV metrics log (None to disable) |
None
|
|
progress_bar
|
Whether to show a tqdm progress bar |
True
|
|
gradient_clip_val
|
Max gradient norm for clipping (None to disable) |
None
|
|
save_top_k
|
Number of best checkpoints to keep |
3
|
Source code in deepecgkit/training/train.py
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 | |
test
¶
Evaluate the model on the test set.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_module
|
ECGDataModule (or any object with test_dataloader) |
required |
Returns:
| Type | Description |
|---|---|
|
Dict with test_loss and test_acc (if classification) |
Source code in deepecgkit/training/train.py
validate
¶
Evaluate the model on the validation set.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_module
|
ECGDataModule (or any object with val_dataloader) |
required |
Returns:
| Type | Description |
|---|---|
|
Dict with val_loss and val_acc (if classification) |
Source code in deepecgkit/training/train.py
get_test_results
¶
Get test predictions, targets, and probabilities as numpy arrays.
Returns:
| Type | Description |
|---|---|
|
Tuple of (predictions, targets, probabilities) as numpy arrays, |
|
|
or (None, None, None) if no test results available. |
Source code in deepecgkit/training/train.py
save_checkpoint
¶
Save a checkpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
File path to save to |
required | |
epoch
|
Current epoch number (optional) |
None
|
Source code in deepecgkit/training/train.py
load_checkpoint
classmethod
¶
Load a trainer from a checkpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
Path to checkpoint file |
required | |
model
|
Model instance to load weights into. Required. |
None
|
|
device
|
Device to load onto |
'auto'
|
Returns:
| Type | Description |
|---|---|
|
ECGTrainer instance with loaded weights |
Source code in deepecgkit/training/train.py
seed_everything
staticmethod
¶
Set random seeds for reproducibility.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
seed
|
Random seed value |
required |
Source code in deepecgkit/training/train.py
KanResWideX
¶
Bases: Module
KanRes-Wide-X model for ECG signal classification.
A convolutional neural network architecture designed for ECG signal analysis with residual connections and wide blocks for improved feature extraction.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_channels
|
int
|
Number of input channels (default: 1 for single-lead ECG) |
1
|
output_size
|
int
|
Number of output classes or regression targets |
4
|
base_channels
|
int
|
Base number of channels for the first layer (default: 64) |
64
|
Example
model = KanResWideX(input_channels=1, output_size=4) x = torch.randn(32, 1, 3000) output = model(x) print(output.shape) # [32, 4]
features = model.extract_features(x) print(features.shape) # (32, 64)
Source code in deepecgkit/models/kanres_x.py
from_pretrained
classmethod
¶
from_pretrained(
weights: str,
map_location: Optional[Union[str, device]] = None,
force_download: bool = False,
**kwargs,
) -> KanResWideX
Load a pretrained KanResWideX model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
weights
|
str
|
Name of pretrained weights (e.g., "kanres-af-30s") or path to weights file |
required |
map_location
|
Optional[Union[str, device]]
|
Device to map weights to (e.g., "cpu", "cuda") |
None
|
force_download
|
bool
|
If True, re-download weights even if cached |
False
|
**kwargs
|
Override default model parameters from the weight registry |
{}
|
Returns:
| Type | Description |
|---|---|
KanResWideX
|
Model with pretrained weights loaded |
Example
model = KanResWideX.from_pretrained("kanres-af-30s") model = KanResWideX.from_pretrained("kanres-af-30s", map_location="cuda") model = KanResWideX.from_pretrained("/path/to/weights.pt", output_size=2)
Source code in deepecgkit/models/kanres_x.py
read_csv
¶
read_csv(
csv_file: str,
delimiter: str = ",",
transpose: bool = False,
skip_header: bool = True,
dtype: Optional[type] = None,
) -> Tuple[np.ndarray, Dict[str, int]]
Read CSV file and return data array and header mapping.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
csv_file
|
str
|
Path to the CSV file |
required |
delimiter
|
str
|
Column delimiter (default: ',') |
','
|
transpose
|
bool
|
Whether to transpose the data array |
False
|
skip_header
|
bool
|
Whether to skip the first row as header |
True
|
dtype
|
Optional[type]
|
Data type for the numpy array |
None
|
Returns:
| Type | Description |
|---|---|
Tuple[ndarray, Dict[str, int]]
|
Tuple of (data_array, header_mapping) |