File size: 3,051 Bytes
b4d7ac8 |
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 |
# Copyright (c) MONAI Consortium
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from typing import TYPE_CHECKING
from monai.config import IgniteInfo
from monai.data import SmartCacheDataset
from monai.utils import min_version, optional_import
Events, _ = optional_import("ignite.engine", IgniteInfo.OPT_IMPORT_VERSION, min_version, "Events")
if TYPE_CHECKING:
from ignite.engine import Engine
else:
Engine, _ = optional_import("ignite.engine", IgniteInfo.OPT_IMPORT_VERSION, min_version, "Engine")
class SmartCacheHandler:
"""
Attach SmartCache logic to the engine in Ignite.
Mainly include the `start`, `update_cache`, and `shutdown` functions of SmartCacheDataset.
"""
def __init__(self, smartcacher: SmartCacheDataset) -> None:
"""
Args:
smartcacher: predefined SmartCacheDataset, will attach it to the engine.
Raises:
TypeError: When ``smartcacher`` is not a ``monai.data.SmartCacheDataset``.
"""
if not isinstance(smartcacher, SmartCacheDataset):
raise TypeError("smartcacher must be a monai.data.SmartCacheDataset.")
self.smartcacher = smartcacher
def attach(self, engine: Engine) -> None:
"""
Args:
engine: Ignite Engine, it can be a trainer, validator or evaluator.
"""
engine.add_event_handler(Events.STARTED, self.started)
engine.add_event_handler(Events.EPOCH_COMPLETED, self.epoch_completed)
engine.add_event_handler(Events.COMPLETED, self.completed)
def started(self, engine: Engine) -> None:
"""Callback for train or validation/evaluation started Event.
Start the replacement thread of SmartCacheDataset.
Args:
engine: Ignite Engine, it can be a trainer, validator or evaluator.
"""
self.smartcacher.start()
def epoch_completed(self, engine: Engine) -> None:
"""Callback for train or validation/evaluation epoch completed Event.
Update cache content with replacement data.
Args:
engine: Ignite Engine, it can be a trainer, validator or evaluator.
"""
self.smartcacher.update_cache()
def completed(self, engine: Engine) -> None:
"""Callback for train or validation/evaluation completed Event.
Stop the replacement thread of SmartCacheDataset.
Args:
engine: Ignite Engine, it can be a trainer, validator or evaluator.
"""
self.smartcacher.shutdown()
|