Ignite: Improve docs for common.setup_common_training_handlers

[vfdev-5]

🚀 Feature

Idea is to fix rendering (see below) and add an example of usage and a link where it is used.

What is wrong: gray frame with red vertical line should be absent for the text "Helper method to setup trainer with common handlers "

https://pytorch.org/ignite/contrib/engines.html#ignite.contrib.engines.common.setup_common_training_handlers

Same for other methods:

• common.setup_common_distrib_training_handlers
• common.setup_*_logging

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.

[rexdivakar]

Assign it to me I shall work on it.@vfdev-5

[vfdev-5]

@rexdivakar sure

[vfdev-5]

@rexdivakar any updates on this ?

[rexdivakar]

Working on this will raise a PR soon

[vfdev-5]

@rexdivakar sounds good. It would be nice to have the PR on tuesday. As you have 3 issues assigned we'd like to have some activity on these issues without blocking other users who'd like to help out.

[rexdivakar]

oh k will do it soon @vfdev-5

[vfdev-5]

@rexdivakar could you please send a PR for this issue within 2 days, otherwise unfortunately I'll have to unassign you.

[BanzaiTokyo]

I’d like to look into this

[BanzaiTokyo]

@vfdev-5 should the gray frame with red vertical line be present for "Parameters" title?

[vfdev-5]

@BanzaiTokyo yes, this is OK, see the docs for other correctly rendered methods, e.g. https://pytorch.org/ignite/contrib/engines.html#ignite.contrib.engines.tbptt.create_supervised_tbptt_trainer