-
-
Notifications
You must be signed in to change notification settings - Fork 385
/
runner.py
828 lines (676 loc) · 28.4 KB
/
runner.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
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
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
from typing import Any, Dict, Iterable, Mapping, Optional, Tuple
from abc import ABC, abstractmethod
from collections import defaultdict, OrderedDict
from functools import lru_cache
import logging
import torch
import torch.distributed
import torch.multiprocessing
from torch.utils.data import DataLoader, Dataset, DistributedSampler
from catalyst.core.callback import Callback, ICallback
from catalyst.core.engine import IEngine
from catalyst.core.logger import ILogger
from catalyst.core.misc import filter_callbacks_by_node, sort_callbacks_by_order, validate_loaders
from catalyst.core.trial import ITrial
from catalyst.typing import (
Criterion,
Device,
Model,
Optimizer,
RunnerCriterion,
RunnerModel,
RunnerOptimizer,
RunnerScheduler,
Sampler,
Scheduler,
)
from catalyst.utils.distributed import ddp_sync_run
from catalyst.utils.misc import maybe_recursive_call, set_global_seed
LOGGER = logging.getLogger(__name__)
BATCH_METRICS = Dict[str, float]
LOADER_METRICS = Dict[str, BATCH_METRICS]
EPOCH_METRICS = Dict[str, LOADER_METRICS]
@lru_cache(maxsize=42)
def _has_str_intersections(origin_string: str, strings: Tuple):
return any(x in origin_string for x in strings)
class RunnerException(Exception):
"""Exception class for all runner errors."""
pass
class IRunner(ICallback, ILogger, ABC):
"""
An abstraction that contains all the logic of how to run the experiment,
stages, epochs, loaders and batches.
IRunner supports the logic for deep learning pipeline configuration with pure python code.
Please check the examples for intuition.
Args:
model: Torch model object
engine: IEngine instance
Abstraction, please check out implementations for more details:
- :py:mod:`catalyst.runners.runner.Runner`
- :py:mod:`catalyst.runners.config.ConfigRunner`
- :py:mod:`catalyst.runners.hydra.HydraRunner`
.. note::
To learn more about Catalyst Core concepts, please check out
- :py:mod:`catalyst.core.runner.IRunner`
- :py:mod:`catalyst.core.engine.IEngine`
- :py:mod:`catalyst.core.callback.Callback`
.. note::
Please follow the `minimal examples`_ sections for use cases.
.. _`minimal examples`: https://github.com/catalyst-team/catalyst#minimal-examples
Examples:
.. code-block:: python
import os
from torch import nn, optim
from torch.utils.data import DataLoader
from catalyst import dl, utils
from catalyst.contrib.datasets import MNIST
from catalyst.data import ToTensor
class CustomRunner(dl.IRunner):
def __init__(self, logdir, device):
super().__init__()
self._logdir = logdir
self._device = device
def get_engine(self):
return dl.DeviceEngine(self._device)
def get_loggers(self):
return {
"console": dl.ConsoleLogger(),
"csv": dl.CSVLogger(logdir=self._logdir),
"tensorboard": dl.TensorboardLogger(logdir=self._logdir),
}
@property
def stages(self):
return ["train_freezed", "train_unfreezed"]
def get_stage_len(self, stage: str) -> int:
return 3
def get_loaders(self, stage: str):
loaders = {
"train": DataLoader(
MNIST(os.getcwd(), train=True, download=True, transform=ToTensor()),
batch_size=32
),
"valid": DataLoader(
MNIST(os.getcwd(), train=False, download=True, transform=ToTensor()),
batch_size=32
),
}
return loaders
def get_model(self, stage: str):
model = (
self.model
if self.model is not None
else nn.Sequential(
nn.Flatten(), nn.Linear(784, 128), nn.ReLU(), nn.Linear(128, 10)
)
)
if stage == "train_freezed":
# freeze layer
utils.set_requires_grad(model[1], False)
else:
utils.set_requires_grad(model, True)
return model
def get_criterion(self, stage: str):
return nn.CrossEntropyLoss()
def get_optimizer(self, stage: str, model):
if stage == "train_freezed":
return optim.Adam(model.parameters(), lr=1e-3)
else:
return optim.SGD(model.parameters(), lr=1e-1)
def get_scheduler(self, stage: str, optimizer):
return None
def get_callbacks(self, stage: str):
return {
"criterion": dl.CriterionCallback(
metric_key="loss", input_key="logits", target_key="targets"
),
"optimizer": dl.OptimizerCallback(metric_key="loss"),
"accuracy": dl.AccuracyCallback(
input_key="logits", target_key="targets", topk_args=(1, 3, 5)
),
"classification": dl.PrecisionRecallF1SupportCallback(
input_key="logits", target_key="targets", num_classes=10
),
"checkpoint": dl.CheckpointCallback(
self._logdir,
loader_key="valid",
metric_key="loss",
minimize=True,
save_n_best=3,
),
}
def handle_batch(self, batch):
x, y = batch
logits = self.model(x)
self.batch = {
"features": x,
"targets": y,
"logits": logits,
}
runner = CustomRunner("./logs", "cpu")
runner.run()
"""
def __init__(
self, model: RunnerModel = None, engine: IEngine = None,
):
"""Init."""
# the core
self.model: RunnerModel = model
self.engine: IEngine = engine
self.trial: ITrial = None
# the data
self.loaders: Dict[str, DataLoader] = None
# the components
self.criterion: RunnerCriterion = None
self.optimizer: RunnerOptimizer = None
self.scheduler: RunnerScheduler = None
# the callbacks
self.callbacks: Dict[str, Callback] = {}
# the loggers
self.loggers: Dict[str, ILogger] = {}
# the dataflow - model input/output and other batch tensors
self.batch: [Dict, torch.Tensor] = None
# metrics flow - batch, loader and epoch metrics
self.batch_metrics: BATCH_METRICS = defaultdict(None)
self.loader_metrics: LOADER_METRICS = defaultdict(None)
self.epoch_metrics: EPOCH_METRICS = defaultdict(None)
# experiment info
self.run_key: str = None
self.global_epoch_step: int = 0
self.global_batch_step: int = 0
self.global_sample_step: int = 0
# stage info
self.stage_key: str = "infer"
self.is_infer_stage: bool = self.stage_key.startswith("infer")
self.stage_epoch_len: int = 0
self.stage_epoch_step: int = 0
self.stage_batch_step: int = 0
self.stage_sample_step: int = 0
# loader info
self.loader: DataLoader = None
self.loader_key: str = None
self.is_train_loader: bool = False
self.is_valid_loader: bool = False
self.is_infer_loader: bool = True
self.loader_batch_size: int = 0
self.loader_batch_len: int = 0
self.loader_sample_len: int = 0
self.loader_batch_step: int = 0
self.loader_sample_step: int = 0
# batch info
self.batch_size: int = 0
# extra
self.exception: Exception = None
self.need_early_stop: bool = False
self._stage_rank: int = -1
self._stage_world_size: int = -1
# @TODO: remove hotfix
@property
def device(self) -> Device:
"""Returns the runner's device instance."""
return self.engine.device
@property
def seed(self) -> int:
"""Experiment's seed for reproducibility."""
return 42
@property
def name(self) -> str:
"""Returns run name for monitoring tools."""
return "IRunner"
@property
def hparams(self) -> OrderedDict:
"""
Returns hyper-parameters for current run.
Example::
>>> runner.hparams
OrderedDict([('optimizer', 'Adam'),
('lr', 0.02),
('betas', (0.9, 0.999)),
('eps', 1e-08),
('weight_decay', 0),
('amsgrad', False),
('train_batch_size', 32)])
Returns:
dictionary with hyperparameters
"""
return {}
@property
def _log_defaults(self) -> Dict:
return {
# experiment info
"run_key": self.run_key,
"global_sample_step": self.global_sample_step,
"global_batch_step": self.global_batch_step,
"global_epoch_step": self.global_epoch_step,
# stage info
"stage_key": self.stage_key,
"stage_epoch_len": self.stage_epoch_len,
"stage_epoch_step": self.stage_epoch_step,
"stage_batch_step": self.stage_batch_step,
"stage_sample_step": self.stage_sample_step,
# loader info
"loader_key": self.loader_key,
"loader_batch_len": self.loader_batch_len,
"loader_sample_len": self.loader_sample_len,
"loader_batch_step": self.loader_batch_step,
"loader_sample_step": self.loader_sample_step,
}
@property
@abstractmethod
def stages(self) -> Iterable[str]:
"""Run's stage names.
Example::
>>> runner.stages
["pretraining", "finetuning"]
"""
pass
def get_stage_len(self, stage: str) -> int:
"""Returns number of epochs for the selected stage.
Args:
stage: current stage
Returns:
number of epochs in stage
Example::
>>> runner.get_stage_len("pretraining")
3
"""
return 1
def get_trial(self) -> Optional[ITrial]:
"""Returns the trial for the run."""
return None # noqa: WPS324
@abstractmethod
def get_engine(self) -> IEngine:
"""Returns the engine for the run."""
return None # noqa: WPS324
def get_loggers(self) -> Dict[str, ILogger]:
"""Returns the loggers for the run."""
return {}
def get_datasets(self, stage: str) -> "OrderedDict[str, Dataset]":
"""Returns the datasets for a given stage and epoch. # noqa: DAR401
.. note::
For Deep Learning cases you have the same dataset
during whole stage.
For Reinforcement Learning it's common to change the dataset
(experiment) every training epoch.
Args:
stage: stage name of interest, like "pretrain" / "train" / "finetune" / etc
Returns: # noqa: DAR202
OrderedDict[str, Dataset]: Ordered dictionary
with datasets for current stage and epoch.
.. note::
We need ordered dictionary to guarantee the correct dataflow
and order of our training datasets.
For example, to run train loader before validation one :)
Example::
>>> runner.get_datasets(stage="training")
OrderedDict({
"train": CsvDataset(in_csv=in_csv_train, ...),
"valid": CsvDataset(in_csv=in_csv_valid, ...),
})
"""
raise NotImplementedError
def get_samplers(self, stage: str = None) -> "OrderedDict[str, Sampler]":
"""Returns samplers for a given stage. # noqa: DAR401
Args:
stage: stage name of interest, like "pretrain" / "train" / "finetune" / etc
Returns: # noqa: DAR201, DAR202
OrderedDict[str, Sampler]: Ordered dictionary
with samplers for current stage and epoch.
"""
raise NotImplementedError
# def get_transforms(self, stage: str = None):
# """Returns the data transforms for a given stage and dataset.
#
# Args:
# stage: stage name of interest,
# like "pretrain" / "train" / "finetune" / etc
# dataset: dataset name of interest,
# like "train" / "valid" / "infer"
#
# .. note::
# For datasets/loaders naming please follow
# :py:mod:`catalyst.core.runner` documentation.
#
# Returns: # noqa: DAR202
# Data transformations to use for specified dataset.
#
# """
# raise NotImplementedError
@abstractmethod # noqa: WPS463
def get_loaders(self, stage: str) -> "OrderedDict[str, DataLoader]":
"""Returns the loaders for a given stage. # noqa: DAR401
.. note::
Wrapper for
:py:mod:`catalyst.core.experiment.IExperiment.get_datasets`.
For most of your experiments you need to rewrite `get_datasets`
method only.
Args:
stage: stage name of interest,
like "pretrain" / "train" / "finetune" / etc
Returns: # noqa: DAR201, DAR202
OrderedDict[str, DataLoader]: Ordered dictionary
with loaders for current stage and epoch.
"""
pass
@abstractmethod # noqa: WPS463
def get_model(self, stage: str) -> Model:
"""Returns the model for a given stage and epoch.
Example::
# suppose we have typical MNIST model, like
# nn.Sequential(nn.Linear(28*28, 128), nn.Linear(128, 10))
>>> runner.get_model(stage="train")
Sequential(
: Linear(in_features=784, out_features=128, bias=True)
: Linear(in_features=128, out_features=10, bias=True)
)
Args:
stage: stage name of interest
like "pretrain" / "train" / "finetune" / etc
Returns: # noqa: DAR201, DAR202
Model: model for a given stage.
"""
pass
def get_criterion(self, stage: str) -> Optional[Criterion]:
"""Returns the criterion for a given stage and epoch.
Example::
# for typical classification task
>>> runner.get_criterion(stage="train")
nn.CrossEntropyLoss()
Args:
stage: stage name of interest
like "pretrain" / "train" / "finetune" / etc
Returns: # noqa: DAR201, DAR202
Criterion: criterion for a given stage.
"""
return None # noqa: WPS324
def get_optimizer(self, stage: str, model: Model) -> Optional[Optimizer]:
"""Returns the optimizer for a given stage and model.
Example::
>>> runner.get_optimizer(model=model, stage="train")
torch.optim.Adam(model.parameters())
Args:
stage: stage name of interest
like "pretrain" / "train" / "finetune" / etc
model: model to optimize with stage optimizer
Returns: # noqa: DAR201, DAR202
Optimizer: optimizer for a given stage and model.
"""
return None # noqa: WPS324
def get_scheduler(self, stage: str, optimizer: Optimizer) -> Optional[Scheduler]:
"""Returns the scheduler for a given stage and optimizer.
Example::
>>> runner.get_scheduler(stage="training", optimizer=optimizer)
torch.optim.lr_scheduler.StepLR(optimizer)
Args:
stage: stage name of interest
like "pretrain" / "train" / "finetune" / etc
optimizer: optimizer to schedule with stage scheduler
Returns: # noqa: DAR201, DAR202
Scheduler: scheduler for a given stage and optimizer.
"""
return None # noqa: WPS324
def _get_model(self) -> Model:
self.model = self.get_model(stage=self.stage_key)
return self.model
def _get_criterion(self) -> Criterion:
self.criterion = self.get_criterion(stage=self.stage_key)
return self.criterion
def _get_optimizer(self, model: Model = None) -> Optimizer:
if model is not None:
self.model = model
# assert self.model is not None, "You need to setup model first"
self.optimizer = self.get_optimizer(stage=self.stage_key, model=self.model)
return self.optimizer
def _get_scheduler(self, optimizer: Optimizer = None) -> Scheduler:
if optimizer is not None:
self.optimizer = optimizer
# assert self.optimizer is not None, "You need to setup optimizer first"
self.scheduler = self.get_scheduler(stage=self.stage_key, optimizer=self.optimizer)
return self.scheduler
def get_callbacks(self, stage: str) -> "OrderedDict[str, ICallback]":
"""Returns callbacks for a given stage.
Args:
stage: stage name of interest like "pretrain" / "train" / "finetune" / etc
Returns:
OrderedDict[str, Callback]: Ordered dictionary # noqa: DAR202
with callbacks for current stage.
"""
return {}
def log_hparams(self, *args, **kwargs) -> None:
"""Logs hyperparameters to available loggers."""
for logger in self.loggers.values():
logger.log_hparams(
*args,
**kwargs,
# experiment info
run_key=self.run_key,
stage_key=self.stage_key,
)
def log_metrics(self, *args, **kwargs) -> None:
"""Logs batch, loader and epoch metrics to available loggers."""
for logger in self.loggers.values():
logger.log_metrics(*args, **kwargs, **self._log_defaults)
def log_image(self, *args, **kwargs) -> None:
"""Logs image to available loggers."""
for logger in self.loggers.values():
logger.log_image(*args, **kwargs, **self._log_defaults)
def log_artifact(self, *args, **kwargs) -> None:
"""Logs artifact (file like audio, video, csv, etc.) to available loggers."""
for logger in self.loggers.values():
logger.log_artifact(*args, **kwargs, **self._log_defaults)
def flush_log(self) -> None:
"""Flushes the loggers."""
for logger in self.loggers.values():
logger.flush_log()
def close_log(self, *args, **kwargs) -> None:
"""Closes the loggers."""
for logger in self.loggers.values():
logger.close_log(*args, **kwargs)
def _setup_loaders(self) -> None:
set_global_seed(self.seed + self.engine.rank + self.global_epoch_step)
loaders = self.get_loaders(stage=self.stage_key)
loaders = validate_loaders(loaders)
self.loaders = loaders
def _setup_components(self) -> None:
set_global_seed(self.seed + self.engine.rank + self.global_epoch_step)
self.model, self.criterion, self.optimizer, self.scheduler = self.engine.init_components(
model_fn=self._get_model,
criterion_fn=self._get_criterion,
optimizer_fn=self._get_optimizer,
scheduler_fn=self._get_scheduler,
)
def _setup_callbacks(self):
set_global_seed(self.seed + self.engine.rank + self.global_epoch_step)
callbacks = self.get_callbacks(self.stage_key)
callbacks = filter_callbacks_by_node(callbacks)
callbacks = sort_callbacks_by_order(callbacks)
self.callbacks = callbacks
def on_experiment_start(self, runner: "IRunner"):
"""Event handler."""
self.run_key = self.name
self.global_epoch_step: int = 0
self.global_batch_step: int = 0
self.global_sample_step: int = 0
self.exception: Exception = None
self.need_early_stop: bool = False
self.trial = self.get_trial()
self.engine = self.get_engine()
self.loggers = self.get_loggers()
self.log_hparams(hparams=self.hparams, scope="experiment")
def on_stage_start(self, runner: "IRunner"):
"""Event handler."""
assert self.stage_key is not None
self.is_infer_stage: bool = self.stage_key.startswith("infer")
self.stage_epoch_len = self.get_stage_len(stage=self.stage_key)
self.stage_epoch_step: int = 0
self.stage_batch_step: int = 0
self.stage_sample_step: int = 0
if self.engine.is_ddp:
self.engine.setup_process(rank=self._stage_rank, world_size=self._stage_world_size)
if not self.engine.is_master_process:
del self.loggers
self.loggers = {}
ddp_sync_run(self._setup_loaders)
self._setup_components()
self._setup_callbacks()
self.log_hparams(hparams=self.hparams, scope="stage")
def on_epoch_start(self, runner: "IRunner"):
"""Event handler."""
self.global_epoch_step += 1
self.stage_epoch_step += 1
self.epoch_metrics: Dict = defaultdict(None)
# storage for pure epoch-based metrics, like lr/momentum
self.epoch_metrics["_epoch_"] = {}
assert self.loaders is not None
for loader_key, loader in self.loaders.items():
if len(loader) == 0:
raise RunnerException(f"DataLoader with name {loader_key} is empty.")
set_global_seed(self.seed + self.engine.rank + self.global_epoch_step)
def on_loader_start(self, runner: "IRunner"):
"""Event handler."""
assert self.loader is not None
self.is_train_loader: bool = self.loader_key.startswith("train")
self.is_valid_loader: bool = self.loader_key.startswith("valid")
self.is_infer_loader: bool = self.loader_key.startswith("infer")
assert self.is_train_loader or self.is_valid_loader or self.is_infer_loader
self.loader_batch_size: int = self.loader.batch_size
self.loader_batch_len: int = len(self.loader)
self.loader_sample_len: int = len(self.loader.dataset)
self.loader_batch_step: int = 0
self.loader_sample_step: int = 0
self.loader_metrics: Dict = defaultdict(None)
if self.loader_batch_len == 0:
raise NotImplementedError(f"DataLoader with name {self.loader_key} is empty.")
set_global_seed(self.seed + self.engine.rank + self.global_epoch_step)
maybe_recursive_call(self.model, "train", mode=self.is_train_loader)
if isinstance(self.loader.sampler, DistributedSampler):
self.loader.sampler.set_epoch(self.stage_epoch_step)
def on_batch_start(self, runner: "IRunner"):
"""Event handler."""
self.batch = self.engine.sync_device(tensor_or_module=self.batch)
if isinstance(self.batch, dict):
self.batch_size = len(next(iter(self.batch.values())))
else:
self.batch_size = len(self.batch[0])
# we have an batch per each worker...
self.global_batch_step += self.engine.world_size
self.stage_batch_step += self.engine.world_size
self.loader_batch_step += self.engine.world_size
self.global_sample_step += self.batch_size * self.engine.world_size
self.stage_sample_step += self.batch_size * self.engine.world_size
self.loader_sample_step += self.batch_size * self.engine.world_size
self.batch_metrics: Dict = defaultdict(None)
def on_batch_end(self, runner: "IRunner"):
"""Event handler."""
# as far as we could `backward` anything from `batch_metrics` on the nodes during training,
# they could not be synced before, so we have to sync them in the end of the batch
# @TODO: could be done better
if self.engine.is_ddp:
self.batch_metrics = {
k: runner.engine.sync_tensor(torch.tensor(v, device=runner.device), "mean")
for k, v in self.batch_metrics.items()
}
self.log_metrics(metrics=self.batch_metrics, scope="batch")
def on_loader_end(self, runner: "IRunner"):
"""Event handler."""
self.log_metrics(metrics=self.loader_metrics, scope="loader")
self.epoch_metrics[self.loader_key] = {
key: float(value) for key, value in self.loader_metrics.items()
}
def on_epoch_end(self, runner: "IRunner"):
"""Event handler."""
self.log_metrics(metrics=self.epoch_metrics, scope="epoch")
self.flush_log()
def on_stage_end(self, runner: "IRunner"):
"""Event handler."""
del self.callbacks
self.callbacks = {}
del self.loaders
self.loaders = {}
self.engine.deinit_components(runner=self)
self.close_log(scope="stage")
# due to multiprocessing setup we have to close current loggers
# to prevent EOF-like errors
if self.engine.is_ddp:
self.flush_log()
self.close_log()
self.engine.cleanup_process()
def on_experiment_end(self, runner: "IRunner"):
"""Event handler."""
self.flush_log()
self.close_log(scope="experiment")
def on_exception(self, runner: "IRunner"):
"""Event handler."""
raise self.exception
def _run_event(self, event: str) -> None:
if _has_str_intersections(event, ("_start",)):
getattr(self, event)(self)
for callback in self.callbacks.values():
getattr(callback, event)(self)
if _has_str_intersections(event, ("_end", "_exception")):
getattr(self, event)(self)
@abstractmethod
def handle_batch(self, batch: Mapping[str, Any]) -> None:
"""
Inner method to handle specified data batch.
Used to make a train/valid/infer stage during Experiment run.
Args:
batch (Mapping[str, Any]): dictionary with data batches from DataLoader.
"""
pass
def _run_batch(self) -> None:
self._run_event("on_batch_start")
self.handle_batch(batch=self.batch)
self.batch = self.engine.sync_device(self.batch)
self._run_event("on_batch_end")
def _run_loader(self) -> None:
# NOTE: wrapped forward because need to scale forward propagation
# as it was noted in docs:
# https://pytorch.org/docs/stable/notes/amp_examples.html#typical-mixed-precision-training
self._run_event("on_loader_start")
with torch.set_grad_enabled(self.is_train_loader):
for self.loader_batch_step, self.batch in enumerate(self.loader):
with self.engine.autocast():
self._run_batch()
if self.need_early_stop:
self.need_early_stop = False
break
self._run_event("on_loader_end")
def _run_epoch(self) -> None:
self._run_event("on_epoch_start")
for self.loader_key, self.loader in self.loaders.items():
self._run_loader()
self._run_event("on_epoch_end")
def _run_stage(self, rank: int = -1, world_size: int = 1) -> None:
self._stage_rank, self._stage_world_size = rank, world_size
self._run_event("on_stage_start")
while self.stage_epoch_step < self.stage_epoch_len:
self._run_epoch()
if self.need_early_stop:
self.need_early_stop = False
break
self._run_event("on_stage_end")
def _run_experiment(self) -> None:
self._run_event("on_experiment_start")
for self.stage_key in self.stages:
if self.engine.is_ddp:
# ddp-device branch
world_size = self.engine.world_size
torch.multiprocessing.spawn(
self._run_stage, args=(world_size,), nprocs=world_size, join=True,
)
else:
# single-device branch (cpu, gpu, dp)
self._run_stage()
self._run_event("on_experiment_end")
def run(self) -> "IRunner":
"""Runs the experiment.
Returns:
self, `IRunner` instance after the experiment
"""
try:
self._run_experiment()
except (Exception, KeyboardInterrupt) as ex:
self.exception = ex
self._run_event("on_exception")
return self
__all__ = ["IRunner", "RunnerException"]