Closed marii-moe closed 4 years ago
Check out this pull request on
Review Jupyter notebook visual diffs & provide feedback on notebooks.
Powered by ReviewNB
This is looking good! The main thing to consider is that with notebooks you're not just writing code, but you're also writing docs. So use plenty of markdown cells, with plenty of links, to explain what each function does, why it's useful, etc.
For refs/cites, for actual code you can just add comments. For refs to ideas, add a link in the markdown.
Okay, thank you! Is there a gold standard notebook for this level of markdown cells and links? I was trying to copy the level of documentation/tests in nbs/09_vision.augment.ipynb, but maybe it also needs more documentation?
Yes it definitely needs more through much of the notebook. Here's a better example (at least, the start of it): http://dev.fast.ai/callback.hook#What-are-hooks?
Note that docstrings in fastai should always fit on one line, and not use triple quotes.
I'm going to merge this as-is since I'm moving the repos today. Hope it's OK for your to do another PR to fix the minor issues mentioned.
Wanted to share some code to get some feedback.
Possible Issues: