pytorch-ignite / examples

Examples, tutorials, and how-to guides
BSD 3-Clause "New" or "Revised" License
11 stars 12 forks source link

Added how-to guide: Loggers #58

Closed anirudhb11 closed 2 years ago

anirudhb11 commented 3 years ago

Resolves #44, A how-to guide for loggers in Ignite. Demonstrates the usage with one logger (ClearML) and how the usage can be extended to other loggers

Priyansi commented 3 years ago

Thank you for this amazing PR @anirudhb11 . Just a few structural changes and we should be good to merge.

Also, I was thinking if we could move the comments inside the code in the notebook as a text cell above that and add the comments as steps there (1, 2, 3, ...). It will render better on the website.

anirudhb11 commented 3 years ago

Thank you for this amazing PR @anirudhb11 . Just a few structural changes and we should be good to merge.

Also, I was thinking if we could move the comments inside the code in the notebook as a text cell above that and add the comments as steps there (1, 2, 3, ...). It will render better on the website.

Thanks @Priyansi, have made some changes to address comments raised by you

Priyansi commented 3 years ago

Hey @anirudhb11 , the code looks good now however my concern was not to remove the comments altogether rather add them in the text cell above so that we have a little more explanation rather than just code. For example - Where to initialize the ClearMLLogger, what are the other handlers like WeightScaler, WeightHist, etc that we can attach and why. You don't need to explain the part before and after (setting up trainer, checkpoint, etc). Hope this is clear. Feel free to ask any more questions!

anirudhb11 commented 3 years ago

Hey @anirudhb11 , the code looks good now however my concern was not to remove the comments altogether rather add them in the text cell above so that we have a little more explanation rather than just code. For example - Where to initialize the ClearMLLogger, what are the other handlers like WeightScaler, WeightHist, etc that we can attach and why. You don't need to explain the part before and after (setting up trainer, checkpoint, etc). Hope this is clear. Feel free to ask any more questions!

Thanks for the clarification, will add a description on these lines.

vfdev-5 commented 2 years ago

@anirudhb11 could you please update the PR and we could land it. Thanks a lot !

anirudhb11 commented 2 years ago

@anirudhb11 could you please update the PR and we could land it. Thanks a lot !

@vfdev-5 thanks for reminder, apologies for the delayed response, have added a brief explanation regarding the usage as requested by @Priyansi

vfdev-5 commented 2 years ago

@anirudhb11 Thanks for the update! I let @Priyansi review this PR and merge if everything is ok.

By the way, we are using <!--more--> tag (see https://github.com/pytorch-ignite/examples/blob/main/generate.py#L34-L56) to show short description of the guide in the list. For example https://raw.githubusercontent.com/pytorch-ignite/examples/main/how-to-guides/06-data-iterator.ipynb

Could you please add that as well.

Priyansi commented 2 years ago

Thanks so much @anirudhb11 for adding the explanation! We should be good to merge once @vfdev-5 's comment is resolved.

anirudhb11 commented 2 years ago

Have added a <!--more--> tag to state the dataset and model being used in the task