Documentation in FastAI, nbdev.

fastai nbdev python

You’re going to find some utterly newbie / neophyte - python / FastAI stuff in the TIL section (I don’t know, maybe I need more slashes?!) in the coming weeks and months, to which I say, “I don’t care.” If I can’t figure it out without asking, then someone else is in the same situation.

So I had heard a lot about nbdev, and I knew that it linked up somehow with making documentation searchable. But I didn’t know how I could access the source code from a Jupyter notebook, with some code that had been indexed (right term? don’t know) with nbdev. So to the forums!

Answer is here, first you need to have nbdev installed, which I did, import,

from nbdev.showdoc import * 

then use doc(myfunc). A box with the function’s documentation will appear.

This is super cool, from there you can go to the source and take a look at the function.

© Amy Tabb 2018 - 2023. All rights reserved. The contents of this site reflect my personal perspectives and not those of any other entity.