File tree Expand file tree Collapse file tree 1 file changed +15
-6
lines changed Expand file tree Collapse file tree 1 file changed +15
-6
lines changed Original file line number Diff line number Diff line change @@ -259,38 +259,47 @@ class Events(EventEnum):
259
259
- TERMINATE_SINGLE_EPOCH : triggered when the run is about to end the current epoch,
260
260
after receiving a :meth:`~ignite.engine.engine.Engine.terminate_epoch()` or
261
261
:meth:`~ignite.engine.engine.Engine.terminate()` call.
262
+ - EPOCH_COMPLETED : triggered when the epoch is ended. Note that this is triggered even
263
+ when :meth:`~ignite.engine.engine.Engine.terminate_epoch()` is called.
262
264
263
265
- TERMINATE : triggered when the run is about to end completely,
264
266
after receiving :meth:`~ignite.engine.engine.Engine.terminate()` call.
265
267
266
- - EPOCH_COMPLETED : triggered when the epoch is ended. Note that this is triggered even
267
- when :meth:`~ignite.engine.engine.Engine.terminate_epoch()` is called.
268
268
- COMPLETED : triggered when engine's run is completed or terminated with
269
269
:meth:`~ignite.engine.engine.Engine.terminate()`, unless the flag
270
270
`skip_completed` is set to True.
271
271
272
272
The table below illustrates which events are triggered when various termination methods are called.
273
273
274
274
.. list-table::
275
- :widths: 24 25 33 18
275
+ :widths: 38 33 28 20 20
276
276
:header-rows: 1
277
277
278
278
* - Method
279
- - EVENT_COMPLETED
280
279
- TERMINATE_SINGLE_EPOCH
280
+ - EPOCH_COMPLETED
281
281
- TERMINATE
282
+ - COMPLETED
282
283
* - no termination
283
- - ✔
284
284
- ✗
285
+ - ✔
285
286
- ✗
287
+ - ✔
286
288
* - :meth:`~ignite.engine.engine.Engine.terminate_epoch()`
287
289
- ✔
288
290
- ✔
289
291
- ✗
292
+ - ✔
290
293
* - :meth:`~ignite.engine.engine.Engine.terminate()`
291
- - (✔)
294
+ - ✗
292
295
- ✔
293
296
- ✔
297
+ - ✔
298
+ * - :meth:`~ignite.engine.engine.Engine.terminate(skip_completed=True)`
299
+ - ✗
300
+ - ✔
301
+ - ✔
302
+ - ✗
294
303
295
304
Since v0.3.0, Events become more flexible and allow to pass an event filter to the Engine:
296
305
You can’t perform that action at this time.
0 commit comments