Skip to content

Commit cf1cbcd

Browse files
committed
Update event table
1 parent 8ecf8f0 commit cf1cbcd

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

ignite/engine/events.py

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -259,38 +259,47 @@ class Events(EventEnum):
259259
- TERMINATE_SINGLE_EPOCH : triggered when the run is about to end the current epoch,
260260
after receiving a :meth:`~ignite.engine.engine.Engine.terminate_epoch()` or
261261
: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.
262264
263265
- TERMINATE : triggered when the run is about to end completely,
264266
after receiving :meth:`~ignite.engine.engine.Engine.terminate()` call.
265267
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.
268268
- COMPLETED : triggered when engine's run is completed or terminated with
269269
:meth:`~ignite.engine.engine.Engine.terminate()`, unless the flag
270270
`skip_completed` is set to True.
271271
272272
The table below illustrates which events are triggered when various termination methods are called.
273273
274274
.. list-table::
275-
:widths: 24 25 33 18
275+
:widths: 38 33 28 20 20
276276
:header-rows: 1
277277
278278
* - Method
279-
- EVENT_COMPLETED
280279
- TERMINATE_SINGLE_EPOCH
280+
- EPOCH_COMPLETED
281281
- TERMINATE
282+
- COMPLETED
282283
* - no termination
283-
- ✔
284284
- ✗
285+
- ✔
285286
- ✗
287+
- ✔
286288
* - :meth:`~ignite.engine.engine.Engine.terminate_epoch()`
287289
- ✔
288290
- ✔
289291
- ✗
292+
- ✔
290293
* - :meth:`~ignite.engine.engine.Engine.terminate()`
291-
- (✔)
294+
-
292295
- ✔
293296
- ✔
297+
- ✔
298+
* - :meth:`~ignite.engine.engine.Engine.terminate(skip_completed=True)`
299+
- ✗
300+
- ✔
301+
- ✔
302+
- ✗
294303
295304
Since v0.3.0, Events become more flexible and allow to pass an event filter to the Engine:
296305

0 commit comments

Comments
 (0)