Skip to content

Expose EventEnum in the docs and fix custom events example #1345

@vfdev-5

Description

@vfdev-5

🚀 Feature

Currently, EventEnum is absent in the docs and below there is no link in the docs:

Screen Shot 2020-10-03 at 23 34 44

https://pytorch.org/ignite/master/engine.html#ignite.engine.events.Events

Idea is to introduce it in the docs by adding a docstring here

class EventEnum(CallableEventWithFilter, Enum):
pass

and improve above and all other examples where EventEnum is mentioned (please, search for it in the whole repository) by adding

from ignite.engine import EventEnum

For Hacktoberfest contributors, feel free to ask questions for details if any and say that you would like to tackle the issue.
Please, take a look at CONTRIBUTING guide.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions