Documentation improvements

fastai
1

I just went through a huge proofread and update of the docs of fastai and there are quite a few of them that could be improved.

need_you

If you’re looking to help a bit with fast.ai while learning a little bit more about how the library works before part 2 of the course, this is a very good thing to look into. All the functions are properly documented but in some cases, we’re seriously lacking some examples (sometimes a lot of them). it doesn’t need to be super-evolved, but just a little example of what the function does, that runs fast (we’re using all the docs notebooks for tests). For instance vision transforms is a great doc page for this.

You don’t need to be an expert, just figuring out how the function works by playing with it, highlighting some unexpected behavior or difficulties you had adding a little more descriptions of what an argument does if needed, all of this would be great.

Here are the pages I think could really be improved (this list will be updated as things improve or new pages arrive):

  • callbacks.rnn
  • core (severely lacking)
  • callbacks
  • basic_data
  • datasets
  • layers (second half)
  • metrics
  • overview
  • tabular.models
  • tabular.transform
  • text.data (in the beginning)
  • torch_core (severely lacking)
  • vision.gan
  • vision.models
  • vision.models.unet
  • vision.transform pre-run resize methods

You can do just one function in one of them, I’m not making this topic a wiki with people putting their names in front of one page because I think small incremental progress is going to be more efficient, so don’t be afraid!

Compiling useful information posted in the forums and putting it in the docs would make for an extremely useful contribution, for some ideas see this post.

Feel free to use this topic to ask any questions you might have around the process or to suggest additional content that could be made better.

broken links

docs generator improvements:

  • None

website improvements:

Process for contributing to the docs

You will find the full instructions/explanations on how to author docs here:
https://docs.fast.ai/gen_doc_main.html#process-for-contributing-to-the-docs

Notes

show_doc entries

show_doc are supposed to be hidden. You need to install `jupyter_contrib_nbextensions:

pip install jupyter_contrib_nbextensions
jupyter contrib nbextension install --user
# then restart jupyter notebook

then activate the hide_input extension (as shown here). You can point us to them but we’ll likely forget so it’s best if you make a simple PR to fix them.

This is a wiki post, so please feel free to improve it.

34 Likes