Skip to content

Trainer

automil.trainer.Trainer orchestrates training MIL models using Slideflow and FastAI. It provides automatic batch size adjustment based on GPU memory constraints, optional early stopping and k-fold cross-validation with the ability of providing additional callback.

Trainer

Orchestrates MIL model training and evaluation.

Source code in automil/trainer.py
 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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
class Trainer:
    """
    Orchestrates MIL model training and evaluation.

    Trainer wraps the entire training workflow and provides a couple of related functionalities:
        - Automatic batch size optimization based on VRAM usage
        - Early stopping (via FastAI callback `EarlyStoppingCallback`)
        - Optional k-fold cross-validation
    """

    def __init__(
        self,
        bags_path: Path,
        project: sf.Project,
        train_dataset: sf.Dataset,
        val_dataset: sf.Dataset,
        model: ModelType,
        model_outdir: Path | None = None,
        lr: float = LEARNING_RATE,
        epochs: int = EPOCHS,
        batch_size: int = BATCH_SIZE,
        k: int = 3,
        enable_early_stopping: bool = True,
        early_stop_patience: int = 10,
        early_stop_monitor: str = "valid_loss",
        attention_heatmaps: bool = True,
        additional_callbacks: list[Callback] | None = None,
        verbose: bool = True,
    ) -> None:
        """Initialize a Trainer Instance. Sets up training configuration and optimizes hyperparameters.

        Args:
            bags_path (Path): Path to feature bags directory
            project (sf.Project): Slideflow project instance
            train_dataset (sf.Dataset): Training dataset
            val_dataset (sf.Dataset): Validation dataset
            model (ModelType): Model to use
            model_outdir (Path | None, optional): Output directory for trained models. If none, will use `project_root / models`. Defaults to None.
            lr (float, optional): Learning rate. Defaults to LEARNING_RATE.
            epochs (int, optional): (Maximum number of) Epochs to train for. Defaults to EPOCHS.
            batch_size (int, optional): Batch size. Defaults to BATCH_SIZE.
            k (int, optional): Number of folds to train. Defaults to 3.
            enable_early_stopping (bool, optional): Whether to use early stopping. Adds an ealry stopping callback to the FastAI Learner. Defaults to True.
            early_stop_patience (int, optional): Number of epochs without performance improvement before early stopping kicks in. Defaults to 10.
            early_stop_monitor (str, optional): Metric to monitor for early stopping. Defaults to "valid_loss".
            attention_heatmaps (bool, optional): Whether to generate attention heatmaps. Defaults to True.
            verbose (bool, optional): Whether to print verbose messages. Defaults to True.
        """
        self.bags_path = bags_path
        self.project = project
        self.train_dataset = train_dataset
        self.val_dataset = val_dataset
        self.model = model
        self.model_outdir = model_outdir or Path(self.project.root) / "models"
        self.lr = lr
        self.epochs = epochs
        self.initial_batch_size = batch_size
        self.attention_heatmaps = attention_heatmaps
        self.additional_callbacks = additional_callbacks
        self.k = k
        self.enable_early_stopping = enable_early_stopping
        self.early_stop_patience = early_stop_patience
        self.early_stop_monitor = early_stop_monitor

        self.vlog = get_vlog(verbose)

        # Hyperparameter validation
        self.model_manager = ModelManager(self.model)
        suggestions = self.model_manager.validate_hyperparameters(
            self.lr,
            self.initial_batch_size,
            self.bag_avg
        )

        for suggestion, value in suggestions.items():
            self.vlog(
                f"[yellow]Warning:[/] {suggestion} value out of bounds for model "
                f"[cyan]{self.model_manager.model_class.__name__}[/]. "
                f"Suggested value: [cyan]{value}[/]"
            )
            setattr(self, suggestion, value)

    @cached_property
    def num_classes(self) -> int:
        """Number of target classes derived from dataset annotations"""
        if self.train_dataset.annotations is not None:
            return self.train_dataset.annotations["label"].nunique()
        elif self.val_dataset.annotations is not None:
            return self.val_dataset.annotations["label"].nunique()
        else:
            return 2  # Assume binary classification as fallback

    @cached_property
    def num_slides(self) -> int:
        """Number of slides in training and validation dataset"""
        return get_num_slides(self.train_dataset) + get_num_slides(self.val_dataset)

    @cached_property
    def bag_avg(self) -> int:
        """Average number of tiles per bag"""
        return get_bag_avg_and_num_features(self.bags_path)[0]

    @cached_property
    def num_features(self) -> int:
        """Average number of features per tile"""
        return get_bag_avg_and_num_features(self.bags_path)[1]

    @cached_property
    def adjusted_batch_size(self) -> int:
        """Optimal batch size adjusted for VRAM constraints"""
        return self._compute_optimal_batch_size()

    @cached_property
    def estimated_size_mb(self) -> float:
        """Estimated model size in MB"""
        return self._estimate_model_size()

    @cached_property
    def config(self) -> TrainerConfig:
        """FastAI trainer configuration"""
        return self._build_config()

    @cached_property
    def device(self) -> torch.device:
        """The device to use for training"""
        return torch.device("cuda" if torch.cuda.is_available() else "cpu")

    @cached_property
    def callbacks(self) -> list[Callback]:
        """List of FastAI Callbacks to use during training"""
        return self._setup_callbacks(self.additional_callbacks)

    # === Public Methods === #
    def train(
        self,
        model_label_override: str | None = None,
    ) -> Learner:
        """
        Trains a single MIL model.

        This method performs model training and validation.

        ??? Note
            This method closely mirrors Slideflow's internal training workflow (see `slideflow.mil._train_mil_mode`),
            but extends the routine with additional functionalities such as passing callbacks to enable early stopping,
            more type safety checks and additional logging, amongst others

        Args:
            model_label_override (str | None, optional):
                Custom directory name for the trained model. If ``None``, Slideflow's
                default naming scheme is used.

        Returns:
            Learner:
                Trained FastAI learner instance.
        """
        # Determine output directory
        if model_label_override:
            outdir = self.model_outdir / model_label_override
        else:
            outdir = Path(self.config.prepare_training("label", exp_label=None, outdir=str(self.model_outdir)))
        self.vlog(f"Output directory: [{INFO_CLR}]{outdir}[/]")

        # Prepare validation bags
        val_bags = self._prepare_validation_bags()

        # Build learner with shape information
        result = build_fastai_learner(
            self.config,
            self.train_dataset,
            self.val_dataset,
            outcomes="label",
            bags=str(self.bags_path),
            outdir=str(outdir),
            device=self.device,
            return_shape=True
        )

        # with return_shape=True, result is a tuple
        if isinstance(result, tuple):
            learner, (n_in, n_out) = result
        else:
            learner = result
            n_in, n_out = 0, 0  # Shape info not available

        # Save MIL parameters
        self._log_mil_params("label", learner, n_in, n_out, str(outdir))

        # Add custom callbacks if needed
        callbacks = self._setup_callbacks()
        for callback in callbacks:
            learner.add_cb(callback)

        # Train the model using fastai
        self.vlog(
            f"Starting training: {self.model.model_name} "
            f"(epochs={self.epochs}, batch_size={self.adjusted_batch_size})"
        )
        _fastai.train(learner, self.config)

        # Generate validation predictions with attention
        self.vlog("Generating validation predictions...")
        from slideflow.mil import predict_mil
        df, attention = predict_mil(
            learner.model,
            dataset=self.val_dataset,
            config=self.config,
            outcomes="label",
            bags=val_bags,
            attention=True
        )

        # Saving predictions, calculating metrics, exporting attention, and generating heatmaps
        # Really only feasible if we get a sensible return dataframe from `predict_mil`
        if isinstance(df, pd.DataFrame):
            # Save predictions
            pred_out = outdir / 'predictions.parquet'
            df.to_parquet(pred_out)
            self.vlog(f"Predictions saved to [{INFO_CLR}]{pred_out}[/]")

            # Calculate and display metrics
            self._run_metrics(df, "label", str(outdir))

            # Export attention arrays
            if attention and isinstance(attention, dict):
                self._export_attention(attention, val_bags, str(outdir))

            # Generate attention heatmaps
            if attention and isinstance(attention, dict) and self.attention_heatmaps:
                self._generate_heatmaps(val_bags, attention, str(outdir))
        else:
            self.vlog("Unable to generate predictions; skipping metrics and attention export.")

        # Get actual memory usage during inference
        dummy_input = self.model_manager.create_dummy_input(
            self.adjusted_batch_size,
            self.bag_avg,
            self.num_features
        )

        torch.cuda.reset_peak_memory_stats()
        with torch.no_grad():
            _ = learner.model(*dummy_input)
        self.actual_mem_mb = torch.cuda.max_memory_allocated() / (1024 ** 2)

        self.vlog(f"Training completed: [{INFO_CLR}]{self.model.model_name}[/]")
        return learner

    def train_k_fold(self, base_model_label_override: str | None = None) -> list[Learner]:
        """
        Performs k-fold cross-validation training.

        Trains ``k`` independent models and stores them in separate subdirectories.

        Args:
            base_model_label_override (str | None, optional):
                Base directory name for k-fold outputs.

        Returns:
            list[Learner]:
                Trained learners, one per fold.
        """
        outdir = self.model_outdir
        if base_model_label_override:
            outdir = outdir / base_model_label_override
        self.vlog(f"K-Fold output directory: [{INFO_CLR}]{outdir}[/]")

        learners = []
        for fold in range(self.k):
            self.vlog(f"=" * 50)
            self.vlog(f"Training fold [{INFO_CLR}]{fold + 1}[/]/[{INFO_CLR}]{self.k}[/]")
            self.vlog(f"=" * 50)

            # Create fold-specific paths and labels
            if base_model_label_override:
                fold_label = f"{base_model_label_override}_fold{fold}"
            else:
                fold_label = None

            # Train this fold
            learner = self.train(
                model_label_override=fold_label
            )
            learners.append(learner)

        self.vlog(f"Completed [{INFO_CLR}]{self.k}[/]-fold training")
        return learners

    def summary(self) -> None:
        """Print a summary of the trainer configuration"""
        # Safe way to handle actual memory attribute
        # Since it may not have been set yet (Only after training)
        actual_mem_mb = getattr(self, 'actual_mem_mb', None)
        if actual_mem_mb is not None:
            actual_mem_str = f"{actual_mem_mb:.2f} MB"
        else:
            actual_mem_str = "N/A"

        rows = [
            ("Model Type", self.model.model_name),
            ("Learning Rate", f"{self.lr:.0e}"),
            ("Epochs", self.epochs),
            ("Initial Batch Size", self.initial_batch_size),
            ("Adjusted Batch Size", self.adjusted_batch_size),
            ("Estimated Model Size", f"{self.estimated_size_mb:.2f} MB"),
            ("Actual Inference Memory", actual_mem_str),
            ("Number of Slides", self.num_slides),
            ("Average Bag Size", self.bag_avg),
            ("Feature Dimensions", self.num_features),
            ("K-Fold", self.k),
            ("Early Stopping", self.enable_early_stopping),
            ("Attention Heatmaps", self.attention_heatmaps),
            ("Device", str(self.device)),
        ]

        self.vlog("[bold underline]Trainer Summary:[/]")
        self.vlog(render_kv_table(rows))

    # === Internals === #
    def _debug_dataset_labels(self) -> None:
        """Debug helper to inspect dataset labels"""
        train_ann = self.train_dataset.annotations
        val_ann = self.val_dataset.annotations

        if train_ann is not None and val_ann is not None:
            self.vlog(f"Train labels: [{INFO_CLR}]{train_ann['label'].unique()}[/]")
            self.vlog(f"Train label types: [{INFO_CLR}]{[type(x) for x in train_ann['label'].unique()]}[/]")
            self.vlog(f"Val labels: [{INFO_CLR}]{val_ann['label'].unique()}[/]")  
            self.vlog(f"Val label types: [{INFO_CLR}]{[type(x) for x in val_ann['label'].unique()]}[/]")
        else:
            self.vlog("WARNING: One or both datasets have no annotations")


    def _prepare_validation_bags(self) -> list:
        """Simple helper method that emulates how slideflow generates validation feature bags.

        Note:
            See `slideflow.mil._train_mil` for reference.
        Returns:
            list: list of validation bag paths
        """
        val_bags = self.val_dataset.get_bags(str(self.bags_path))
        self.vlog(f"Found [{INFO_CLR}]{len(val_bags)}[/] validation bags")
        return val_bags.tolist()

    def _log_mil_params(
        self,
        outcomes: str,
        learner: Learner,
        n_in: int,
        n_out: int,
        outdir: str
    ) -> None:
        """Simple helper method that emulates how slideflow logs and saves MIL parameters

        Note:
            See `slideflow.mil._train_mil` for reference.
        Args:
            outcomes (str): Label column name
            learner (Learner): FastAI Learner object
            n_in (int): input feature dimensions
            n_out (int): output dimensions / number of classes
            outdir (str): Output directory
        """
        # Attempt to read unique categories from learner
        if hasattr(learner.dls.train_ds, 'encoder'):
            encoder = learner.dls.train_ds.encoder
            if encoder is not None:
                unique = encoder.categories_[0].tolist()
            else:
                unique = None
        else:
            unique = None

        # Use Slideflow's internal logging function
        _log_mil_params(self.config, outcomes, unique, str(self.bags_path), n_in, n_out, outdir)

    def _run_metrics(self, df: pd.DataFrame, outcomes: str, outdir: str) -> None:
        """Simple helper method that emulates how slideflow caculates and logs metrics.

        Note:
            See `slideflow.mil._train_mil` for reference.

        Args:
            df (pd.DataFrame): DataFrame containing predictions
            outcomes (str): Label column name
            outdir (str): Output directory
        """
        # Rename columns for metrics calculation
        utils.rename_df_cols(df, outcomes, categorical=self.config.is_classification(), inplace=True)

        # Run metrics using Slideflow's method
        self.config.run_metrics(df, level='slide', outdir=outdir)

    def _export_attention(self, attention: dict, val_bags: list, outdir: str) -> None:
        """Simple helper method that emulates how slideflow exports attention arrays.

        Note:
            See `slideflow.mil._train_mil` for reference.
        Args:
            attention (dict): Dictionary mapping bag paths to attention arrays
            val_bags (list): List of validation bag paths
            outdir (str): Output directory
        """
        attention_dir = join(outdir, 'attention')
        bag_names = [path_to_name(b) for b in val_bags]

        # Convert attention dict to list of arrays
        attention_arrays = list(attention.values())
        utils._export_attention(attention_dir, attention_arrays, bag_names)
        self.vlog(f"Attention arrays exported to [{INFO_CLR}]{attention_dir}[/]")

    def _generate_heatmaps(self, val_bags: list, attention: dict, outdir: str) -> None:
        """Generate a heatmap using slideflow

        Args:
            val_bags (list): List of validation bag paths
            attention (dict): Dictionary mapping bag paths to attention arrays
            outdir (str): Output directory
        """
        heatmap_dir = join(outdir, 'heatmaps')
        generate_attention_heatmaps(
            outdir=heatmap_dir,
            dataset=self.val_dataset,
            bags=val_bags,
            attention=list(attention.values()),
        )
        self.vlog(f"Attention heatmaps generated in [{INFO_CLR}]{heatmap_dir}[/]")

    def _compute_optimal_batch_size(self) -> int:
        """Compute VRAM-Optimal batch size based on estimated model memory usage and free memory

        Returns:
            int: adjusted batch size
        """
        adjusted_batch_size = adjust_batch_size(
            self.model,
            self.initial_batch_size,
            self.num_slides,
            self.num_features,
            self.bag_avg,
        )

        # Ensure we do not exceed model-specific maximum batch size
        adjusted_batch_size = min(
            self.model_manager.config.max_batch_size,
            adjusted_batch_size
        )

        self.vlog(
            f"Adjusted batch size to [{INFO_CLR}]{adjusted_batch_size}[/] "
            f"(tiles/bag={self.bag_avg}, dim={self.num_features})"
        )

        return adjusted_batch_size

    def _estimate_model_size(self) -> float:
        """Estimate model size (reserved memory) in MB

        Returns:
            float: Estimated model size in MB
        """
        return estimate_model_size(
            model_type=self.model,
            batch_size=self.adjusted_batch_size,
            bag_size=self.bag_avg,
            input_dim=self.num_features,
            num_classes=self.num_classes
        )

    def _build_config(self) -> TrainerConfig:
        """Builds a MIL model configuration using slideflow's `mil_config` method

        Returns:
            TrainerConfig: TrainerConfig object
        """
        cfg = mil_config(
            model=self.model.model_name,
            trainer="fastai",
            lr=self.lr,
            epochs=self.epochs,
            batch_size=self.adjusted_batch_size,
        )

        # Casting because mil_config should always return a TrainerConfig
        return cast(TrainerConfig, cfg)

    def _setup_callbacks(self, additional_callbacks: list[Callback] | None = None) -> list[Callback]:
        """Sets up callbacks for the FastAI Learner, including an EarlyStopping Callback

        Args:
            additional_callbacks (list[Callback]): A list of additional callbacks to include

        Returns:
            list: List of callbacks
        """
        callbacks = []

        # Early stopping
        if self.enable_early_stopping:
            callbacks.append(
                EarlyStoppingCallback(
                    monitor=self.early_stop_monitor,
                    patience=self.early_stop_patience,
                )
            )
        callbacks.extend(additional_callbacks if additional_callbacks else [])

        return callbacks

adjusted_batch_size cached property

adjusted_batch_size: int

Optimal batch size adjusted for VRAM constraints

bag_avg cached property

bag_avg: int

Average number of tiles per bag

callbacks cached property

callbacks: list[Callback]

List of FastAI Callbacks to use during training

config cached property

config: TrainerConfig

FastAI trainer configuration

device cached property

device: device

The device to use for training

estimated_size_mb cached property

estimated_size_mb: float

Estimated model size in MB

num_classes cached property

num_classes: int

Number of target classes derived from dataset annotations

num_features cached property

num_features: int

Average number of features per tile

num_slides cached property

num_slides: int

Number of slides in training and validation dataset

summary

summary() -> None

Print a summary of the trainer configuration

Source code in automil/trainer.py
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
def summary(self) -> None:
    """Print a summary of the trainer configuration"""
    # Safe way to handle actual memory attribute
    # Since it may not have been set yet (Only after training)
    actual_mem_mb = getattr(self, 'actual_mem_mb', None)
    if actual_mem_mb is not None:
        actual_mem_str = f"{actual_mem_mb:.2f} MB"
    else:
        actual_mem_str = "N/A"

    rows = [
        ("Model Type", self.model.model_name),
        ("Learning Rate", f"{self.lr:.0e}"),
        ("Epochs", self.epochs),
        ("Initial Batch Size", self.initial_batch_size),
        ("Adjusted Batch Size", self.adjusted_batch_size),
        ("Estimated Model Size", f"{self.estimated_size_mb:.2f} MB"),
        ("Actual Inference Memory", actual_mem_str),
        ("Number of Slides", self.num_slides),
        ("Average Bag Size", self.bag_avg),
        ("Feature Dimensions", self.num_features),
        ("K-Fold", self.k),
        ("Early Stopping", self.enable_early_stopping),
        ("Attention Heatmaps", self.attention_heatmaps),
        ("Device", str(self.device)),
    ]

    self.vlog("[bold underline]Trainer Summary:[/]")
    self.vlog(render_kv_table(rows))

train

train(model_label_override: str | None = None) -> Learner

Trains a single MIL model.

This method performs model training and validation.

Note

This method closely mirrors Slideflow's internal training workflow (see slideflow.mil._train_mil_mode), but extends the routine with additional functionalities such as passing callbacks to enable early stopping, more type safety checks and additional logging, amongst others

Parameters:

Name Type Description Default
model_label_override str | None

Custom directory name for the trained model. If None, Slideflow's default naming scheme is used.

None

Returns:

Name Type Description
Learner Learner

Trained FastAI learner instance.

Source code in automil/trainer.py
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
def train(
    self,
    model_label_override: str | None = None,
) -> Learner:
    """
    Trains a single MIL model.

    This method performs model training and validation.

    ??? Note
        This method closely mirrors Slideflow's internal training workflow (see `slideflow.mil._train_mil_mode`),
        but extends the routine with additional functionalities such as passing callbacks to enable early stopping,
        more type safety checks and additional logging, amongst others

    Args:
        model_label_override (str | None, optional):
            Custom directory name for the trained model. If ``None``, Slideflow's
            default naming scheme is used.

    Returns:
        Learner:
            Trained FastAI learner instance.
    """
    # Determine output directory
    if model_label_override:
        outdir = self.model_outdir / model_label_override
    else:
        outdir = Path(self.config.prepare_training("label", exp_label=None, outdir=str(self.model_outdir)))
    self.vlog(f"Output directory: [{INFO_CLR}]{outdir}[/]")

    # Prepare validation bags
    val_bags = self._prepare_validation_bags()

    # Build learner with shape information
    result = build_fastai_learner(
        self.config,
        self.train_dataset,
        self.val_dataset,
        outcomes="label",
        bags=str(self.bags_path),
        outdir=str(outdir),
        device=self.device,
        return_shape=True
    )

    # with return_shape=True, result is a tuple
    if isinstance(result, tuple):
        learner, (n_in, n_out) = result
    else:
        learner = result
        n_in, n_out = 0, 0  # Shape info not available

    # Save MIL parameters
    self._log_mil_params("label", learner, n_in, n_out, str(outdir))

    # Add custom callbacks if needed
    callbacks = self._setup_callbacks()
    for callback in callbacks:
        learner.add_cb(callback)

    # Train the model using fastai
    self.vlog(
        f"Starting training: {self.model.model_name} "
        f"(epochs={self.epochs}, batch_size={self.adjusted_batch_size})"
    )
    _fastai.train(learner, self.config)

    # Generate validation predictions with attention
    self.vlog("Generating validation predictions...")
    from slideflow.mil import predict_mil
    df, attention = predict_mil(
        learner.model,
        dataset=self.val_dataset,
        config=self.config,
        outcomes="label",
        bags=val_bags,
        attention=True
    )

    # Saving predictions, calculating metrics, exporting attention, and generating heatmaps
    # Really only feasible if we get a sensible return dataframe from `predict_mil`
    if isinstance(df, pd.DataFrame):
        # Save predictions
        pred_out = outdir / 'predictions.parquet'
        df.to_parquet(pred_out)
        self.vlog(f"Predictions saved to [{INFO_CLR}]{pred_out}[/]")

        # Calculate and display metrics
        self._run_metrics(df, "label", str(outdir))

        # Export attention arrays
        if attention and isinstance(attention, dict):
            self._export_attention(attention, val_bags, str(outdir))

        # Generate attention heatmaps
        if attention and isinstance(attention, dict) and self.attention_heatmaps:
            self._generate_heatmaps(val_bags, attention, str(outdir))
    else:
        self.vlog("Unable to generate predictions; skipping metrics and attention export.")

    # Get actual memory usage during inference
    dummy_input = self.model_manager.create_dummy_input(
        self.adjusted_batch_size,
        self.bag_avg,
        self.num_features
    )

    torch.cuda.reset_peak_memory_stats()
    with torch.no_grad():
        _ = learner.model(*dummy_input)
    self.actual_mem_mb = torch.cuda.max_memory_allocated() / (1024 ** 2)

    self.vlog(f"Training completed: [{INFO_CLR}]{self.model.model_name}[/]")
    return learner

train_k_fold

train_k_fold(
    base_model_label_override: str | None = None,
) -> list[Learner]

Performs k-fold cross-validation training.

Trains k independent models and stores them in separate subdirectories.

Parameters:

Name Type Description Default
base_model_label_override str | None

Base directory name for k-fold outputs.

None

Returns:

Type Description
list[Learner]

list[Learner]: Trained learners, one per fold.

Source code in automil/trainer.py
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
def train_k_fold(self, base_model_label_override: str | None = None) -> list[Learner]:
    """
    Performs k-fold cross-validation training.

    Trains ``k`` independent models and stores them in separate subdirectories.

    Args:
        base_model_label_override (str | None, optional):
            Base directory name for k-fold outputs.

    Returns:
        list[Learner]:
            Trained learners, one per fold.
    """
    outdir = self.model_outdir
    if base_model_label_override:
        outdir = outdir / base_model_label_override
    self.vlog(f"K-Fold output directory: [{INFO_CLR}]{outdir}[/]")

    learners = []
    for fold in range(self.k):
        self.vlog(f"=" * 50)
        self.vlog(f"Training fold [{INFO_CLR}]{fold + 1}[/]/[{INFO_CLR}]{self.k}[/]")
        self.vlog(f"=" * 50)

        # Create fold-specific paths and labels
        if base_model_label_override:
            fold_label = f"{base_model_label_override}_fold{fold}"
        else:
            fold_label = None

        # Train this fold
        learner = self.train(
            model_label_override=fold_label
        )
        learners.append(learner)

    self.vlog(f"Completed [{INFO_CLR}]{self.k}[/]-fold training")
    return learners