initial engine update

Author: leej3

ignite/engine/engine.py

@@ -332,6 +332,16 @@ def execute_something():
 
         return RemovableEventHandle(event_name, handler, self)
 
+    @staticmethod
+    def _assert_non_filtered_event(event_name: Any) -> None:
+        if (
+            isinstance(event_name, CallableEventWithFilter)
+            and event_name.filter != CallableEventWithFilter.default_event_filter
+        ):
+            raise TypeError(
+                "Argument event_name should not be a filtered event, " "please use event without any event filtering"
+            )
+
     def has_event_handler(self, handler: Callable, event_name: Optional[Any] = None) -> bool:
         """Check if the specified event has the specified handler.
 
@@ -932,6 +942,53 @@ def _setup_dataloader_iter(self) -> None:
         else:
             self._dataloader_iter = iter(self.state.dataloader)
 
+    def _check_and_set_max_epochs(self, max_epochs: Optional[int] = None) -> None:
+        if max_epochs is not None:
+            if max_epochs < 1:
+                raise ValueError("Argument max_epochs is invalid. Please, set a correct max_epochs positive value")
+            if self.state.max_epochs is not None and max_epochs <= self.state.epoch:
+                raise ValueError(
+                    "Argument max_epochs should be larger than the current epoch "
+                    f"defined in the state: {max_epochs} vs {self.state.epoch}. "
+                    "Please, set engine.state.max_epochs = None "
+                    "before calling engine.run() in order to restart the training from the beginning."
+                )
+            self.state.max_epochs = max_epochs
+
+    def _check_and_set_max_iters(self, max_iters: Optional[int] = None) -> None:
+        if max_iters is not None:
+            if max_iters < 1:
+                raise ValueError("Argument max_iters is invalid. Please, set a correct max_iters positive value")
+            if (self.state.max_iters is not None) and max_iters <= self.state.iteration:
+                raise ValueError(
+                    "Argument max_iters should be larger than the current iteration "
+                    f"defined in the state: {max_iters} vs {self.state.iteration}. "
+                    "Please, set engine.state.max_iters = None "
+                    "before calling engine.run() in order to restart the training from the beginning."
+                )
+            self.state.max_iters = max_iters
+
+    def _check_and_set_epoch_length(self, data: Iterable, epoch_length: Optional[int] = None) -> None:
+        # Can't we accept a redefinition ?
+        if self.state.epoch_length is not None:
+            if epoch_length is not None:
+                if epoch_length != self.state.epoch_length:
+                    raise ValueError(
+                        "Argument epoch_length should be same as in the state, "
+                        f"but given {epoch_length} vs {self.state.epoch_length}"
+                    )
+        else:
+            if epoch_length is None:
+                epoch_length = self._get_data_length(data)
+
+            if epoch_length is not None and epoch_length < 1:
+                raise ValueError(
+                    "Argument epoch_length is invalid. Please, either set a correct epoch_length value or "
+                    "check if input data has non-zero size."
+                )
+
+            self.state.epoch_length = epoch_length
+
     def _setup_engine(self) -> None:
         self._setup_dataloader_iter()
 
@@ -1291,6 +1348,16 @@ def _run_once_on_dataset_legacy(self) -> float:
 
         return time.time() - start_time
 
+    def debug(self, enabled: bool = True) -> None:
+        """Enables/disables engine's logging debug mode"""
+        from ignite.utils import setup_logger
+
+        if enabled:
+            setattr(self, "_stored_logger", self.logger)
+            self.logger = setup_logger(level=logging.DEBUG)
+        elif hasattr(self, "_stored_logger"):
+            self.logger = getattr(self, "_stored_logger")
+
 
 def _get_none_data_iter(size: int) -> Iterator:
     # Sized iterator for data as None