Ignite: Create notes about concepts in ignite

[alykhantejani]

These should be put in a sphinx compatible format like what is done in pytorch

[vfdev-5]

@alykhantejani what do you think to write in these notes? Today we have empty files :

    concepts.rst
    engines.rst
    exceptions.rst 
    handlers.rst 
    index.rst 
    metrics.rst
    quickstart.rst 

In pytorch similar notes cover some particular notions or best practices.

[alykhantejani]

I think we need to cover a few things:
1) An overview of the event system
2) Defining your own event handlers
3) An overview of the metrics API

These files were put in as a stub initially, but if you fancy making a start on this feel free to re-arrange/delete as you see fit.

cc @jasonkriss in case he had some thoughts around this

[jasonkriss]

Agreed with @alykhantejani. The way I had envisioned this and stubbed it out is to have a "Concepts" note that has the 3 things @alykhantejani mentioned. And then a "Quickstart" guide that just gives a barebones run through of getting a project up and running. The other .rst files will be filled in with autodoc but we certainly may want to add some additional context to each one at the top before the actual autodoc parts.

That being said, this can definitely change if you wanna get started on it and prefer a different arrangement.

[vfdev-5]

I see what you mean @alykhantejani @jasonkriss, I can start with "Quickstart".
What do we put in index.rst or it will be filled with autodoc ? The file engineS.rst probably become engine.rst ...

[jasonkriss]

engines.rst should still be engines because of how we have structured the code. You shouldn't have to put anything in index.rst unless you really want to. You can just add stuff to quickstart.rst. That would be awesome!

[vfdev-5]

@jasonkriss you can check the first version of quickstart here ;-)

[jasonkriss]

@vfdev-5 That looks like a great start!

[alykhantejani]

I think this is done now @vfdev-5 @jasonkriss? Let me know if you think this should still stay open

[vfdev-5]

@alykhantejani following your comment there is missing:

1. An overview of the metrics API

But I do not know where to put it : concepts.rst or metrics.rst (however metrics is at Package Reference)

[jasonkriss]

@vfdev-5 I think concepts.rst is a good place for high-level overview of how to to use metrics but i think metrics.rst is a good place to explain the Metric API and what methods need to be implemented to create your own metrics.

[alykhantejani]

ok I think this task is now done. I will open new ones for the metrics.rst, engines.rst and handlers.rst package references.

Once these are done I think we're ready to release 0.1

[vfdev-5]

@alykhantejani and exceptions.rst too or not ?
As there is a file ...