Added Custom Events and Set Data How To's from FAQs

[Priyansi]

Fixes #1

cc @trsvchn @vfdev-5 @sdesrozis

[sdesrozis]

@Priyansi Thank you. I think there is a lack of explanations in the notebooks, I mean some context, and examples sound very basic, maybe too useless or without context. Could we improve the content by giving some more concrete illustration ?

[Priyansi]

@Priyansi Thank you. I think there is a lack of explanations in the notebooks, I mean some context, and examples sound very basic, maybe too useless or without context. Could we improve the content by giving some more concrete illustration ?

@sdesrozis I agree. What are your thoughts on dividing How-Tos in 2 parts -

• A TLDR at the top of the notebook that provides just the code without any context or dummy data
• We can set up a basic model, use MNIST data and other parameters to give these how-to's more context.

[sdesrozis]

Having just the code could be a bit hard to understand for a beginner. I would have liked something educational like what is done in the PyTorch examples and tutorials. Even if we are discussing a few basic features, maybe the code without explanation could not be sufficient.

Btw, having a concrete example at the end or not is a good idea.

As an inspiration, not on the content but in the explanatory approach, here is an interesting link

https://pytorch.org/tutorials/beginner/blitz/autograd_tutorial.html

What do you think ?

[Priyansi]

Yes, I understand. However, that would make the how-to guides section into tutorials. However, the purpose of How-To Guides is to solve a specific problem with a minimal explanation as mentioned here. How-To Guides aren't meant for complete beginners. We will have tutorials covering custom events and time profiling along with other Ignite concepts but if a user wanted a quick way to get the code for these concepts, they will turn to how-to guides. The autograd example you mentioned is definitely a tutorial (with a mix of explanations) and putting them in how-to guides would defeat this section's purpose.

If we want to an in-depth explanation of certain concepts, we can add them in pytorch-ignite/pytorch-ignite.github.io/explanations

What do you think?

[sdesrozis]

Ok, I didn't get that howto involves minimal explanation ! Now it's quite clear, thanks for the clarification ! Therefore I agree, no need to consider my remarks, sorry for my misunderstanding.

[Priyansi]

Hey @vfdev-5 I will remove the time-profiling how-to for now since we are breaking them into separate notebooks like in #6 . Will that be alright?

[vfdev-5]

Hey @vfdev-5 I will remove the time-profiling how-to for now since we are breaking them into separate notebooks like in #6 . Will that be alright?

@Priyansi the problem with the notebook from #6 is that it shows only 1 feature instead of 3 from this how-to guide

[Priyansi]

@Priyansi the problem with the notebook from #6 is that it shows only 1 feature instead of 3 from this how-to guide

Yes, I will open two new issues for the other types.

[vfdev-5]

@Priyansi what remains here to finalize this PR ?

[Priyansi]

@vfdev-5 I have updated both notebooks and the PR should be good to merge. Again, I apologize for the delay.

cc @trsvchn @sdesrozis