Thought I’d start a topic to talk about documentation for the fastai library in general, since we don’t have any other so far.
Being honest though, my hidden goal is to thank everybody who has been involved in writing/updating the documenation, and making it available online. This is just amazing, as it’s going to help immensely understanding the library design. Thanks again
Looking forward to the lectures, and contributing to the documentation where needed.
Love the fact that it’s generated using Jupyter notebooks that we can clone and run, to follow along as we read. Can’t believe I’m actually looking forward to reading a library’s docs!
Once again, maybe it’s just me, but the docs are amazing. Perfect for not having to jump in the source or the forum right away when there’s some confusion. Also, the explanantion helps a lot.
Now and then, I run into links that are broken, but I’m assuming this is because some part of the libs are in flux, or should I be reporting this somewhere ? (I don’t want to create more noise either)
Just a minor enhancement, i do see some help doesn’t show the return value or type ; So i have to take a look at the source code ( which is a good thing ).
(eg)
[1] help(untar_data) <-- No return value in the help o/p
Help on function untar_data in module fastai.datasets:
untar_data(url:str, fname:Union[pathlib.Path, str]=None, dest:Union[pathlib.Path, str]=None, data=True)
Download url if doesn’t exist to fname and un-tgz to folder dest
[2] help(get_transforms) <-- this shows return value in help o/p
Help on function get_transforms in module fastai.vision.transform:
get_transforms(do_flip:bool=True, flip_vert:bool=False, max_rotate:float=10.0, max_zoom:float=1.1, max_lighting:float=0.2, max_warp:float=0.2, p_affine:float=0.75, p_lighting:float=0.75, xtra_tfms:float=None) -> Collection[fastai.vision.image.Transform]
Utility func to easily create a list of flip, rotate, zoom, warp, lighting transforms.