Suddenly failing tests with a NotImplementedError

[pseeth]

🐛 Bug description

Getting a strange bug in recent commits to nussl with the latest ignite version. They look like this:

tests/separation/test_deep.py:62: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
nussl/ml/train/trainer.py:300: in add_stdout_handler
    pause=ValidationEvents.VALIDATION_COMPLETED
/opt/hostedtoolcache/Python/3.6.10/x64/lib/python3.6/site-packages/ignite/handlers/timing.py:115: in attach
    engine.add_event_handler(pause, self.pause)
/opt/hostedtoolcache/Python/3.6.10/x64/lib/python3.6/site-packages/ignite/engine/engine.py:269: in add_event_handler
    if event_name not in self._allowed_events:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

self = <Events.EPOCH_STARTED: 'epoch_started'>
other = <ValidationEvents.VALIDATION_COMPLETED: 'validation_completed'>

    def __eq__(self, other):
        if isinstance(other, CallableEventWithFilter):
            return self.name == other.name
        elif isinstance(other, str):
            return self.name == other
        else:
>           raise NotImplementedError
E           NotImplementedError

The full log is here:

https://github.com/nussl/nussl/runs/827399639

Did something in the Events API change? This worked in ignite 0.3 no problem.

Thanks!

[sdesrozis]

@pseeth Thank you for this report. We will have a look on that!!

[vfdev-5]

@pseeth the issue is about that all events and custom ones should inherit from EventEnum.
As ValidationEvents is an extension of Enum, that's why it fails, I think. @pseeth could you please check it ?

We need to update :

• Migration note
• Documentation

to clearly state this in Events class description.

The only place where it is stated is https://pytorch.org/ignite/engine.html#ignite.engine.engine.Engine.register_events

[sdesrozis]

@pseeth

Your custom events are defined inheriting Enum. For now, you have to inherit from EventEnum (seen here https://github.com/nussl/nussl/blob/2c45df2ca4ba38db643f9f3903cee229b9ac301c/nussl/ml/train/trainer.py#L19).

Have a look here https://github.com/pytorch/ignite#custom-events-to-go-beyond-standard-events

HTH

EDIT : @vfdev-5 too fast 😂

[vfdev-5]

@sdesrozis you can be faster in doc fix :) Migration note is done.

[sdesrozis]

I plan to update the doc this weekend 😉