pytorch / ignite

High-level library to help with training and evaluating neural networks in PyTorch flexibly and transparently.
https://pytorch-ignite.ai
BSD 3-Clause "New" or "Revised" License
4.51k stars 612 forks source link

Add some notebooks in examples #367

Closed vfdev-5 closed 5 years ago

vfdev-5 commented 5 years ago

Putting tutorials like the basic mnist into Jupyter notebooks would be helpful for new users to get started quicker

anmolsjoshi commented 5 years ago

Currently, working on an implementation of Neural Machine Translation. I can convert that to a jupyter notebook.

vfdev-5 commented 5 years ago

@anmolsjoshi I think the idea is to provide some basics of ignite in notebook such that user understands how to play with. If your implementation is not too heavy with translation part vs ignite part this can be interesting.

vfdev-5 commented 5 years ago

@NeelMishra yes please go ahead and send a PR. I think everybody can contribute on this issue.

Something like this can be a good start.

anmolsjoshi commented 5 years ago

@vfdev-5 this might be a dumb question. do we need smoke tests for jupyter notebooks?

vfdev-5 commented 5 years ago

@anmolsjoshi I think no. If we would like to do this more neat we could insert the notebooks into the doc as it is done for pytorch tutorials: https://github.com/pytorch/tutorials but it is necessary.

NeelMishra commented 5 years ago

I have started working on the issue, I will make a pull request soon. Currently, I am creating a notebook that teaches how to use ignite to classify FashionMNIST dataset.

vfdev-5 commented 5 years ago

@anmolsjoshi @NeelMishra any advances on this ?

anmolsjoshi commented 5 years ago

@vfdev-5 just finished two notebooks, working on one more, will push tonight.

vfdev-5 commented 5 years ago

@anmolsjoshi maybe we could split this into several PRs to simplify the review ?

anmolsjoshi commented 5 years ago

@vfdev-5 yes that was the plan, i'll send in a PR shortly.

NeelMishra commented 5 years ago

Hi, I have a similar approach, but it will be slower due to final exams next week. I am working on that fashion MNIST in ignite, and simpler stuffs like basic NN. I want to follow the trickle approach for pull request's, and I don't want to delay the development. So if urgent, please feel free to assign someone else as I will submit a PR after next week.

Also, I will be referring the above notebook created by Anmol for creation of notebooks.

vfdev-5 commented 5 years ago

@NeelMishra no hurry, you can advance at your speed. Even if we release 0.2.0 before your PRs we can merge them after. Good luck at your final exams :)

anmolsjoshi commented 5 years ago

@NeelMishra any updates on Fashion MNIST example?

chitralverma commented 5 years ago

@anmolsjoshi @NeelMishra I was doing my own learning using the FashionMNIST dataset and have a notebook mostly ready for the same.

If it's ok, maybe I can adopt the notebook template used for other examples and raise a PR for this?

vfdev-5 commented 5 years ago

@chitralverma you can take a look at the current notebooks: https://github.com/pytorch/ignite/tree/master/examples/notebooks. Actually no template or style to follow, juste it should explain everything for beginners. And yes, please send a PR for this.

anmolsjoshi commented 5 years ago

@chitralverma any updates on the FashionMNIST notebook?

ANUBHAVNATANI commented 5 years ago

@anmolsjoshi @vfdev-5 I am interested in working on FashionMNIST notebook or other such basic neural network notebooks. I want to contribute to open source. I think this would be a good start. Please suggest any other good first issues if this is not available.

anmolsjoshi commented 5 years ago

@ANUBHAVNATANI please go ahead and work on FashionMNIST, and send in a PR. Let us know if you have any questions

ANUBHAVNATANI commented 5 years ago

Thanks for the response, I have started working on the project.

ANUBHAVNATANI commented 5 years ago

@anmolsjoshi I had completed the notebook can I directly make a pull request to master or I have to do something else.

vfdev-5 commented 5 years ago

@ANUBHAVNATANI yes you can create a PR to master and we'll review it. Thanks

ANUBHAVNATANI commented 5 years ago

@vfdev-5 @anmolsjoshi I had made the pull request #549 for the Fashion MNIST dataset. Please review the same.

vfdev-5 commented 5 years ago

I'll close this issue as we have already 5 tutorial notebooks with Ignite usage. I think it is OK for this issue.