and as Ilia mentioned in the discussion thread about this pull request: Iterative computations of confusion matrixfastai codebase doesn’t document function args in the docstings. I’ve used to more advanced docstrings like this(which does not mean it is better in general):
The docstrings should take the minimum amount of space (one line is best) and explain in sentences what the function does, with the arguments between backquotes. That’s the format that will work best with our documentation framework. Note that the argument and the return should be type-annotated. Example:
"Return `Image` object created from image in file `fn`."
that you for your reply. I am a bit struggling with adding example to fastai_docs/docs_src . On one hand, there is already a vision.learner.ipynb notebook where I could add my documentation/example. On another hand, it is not up to date and does not work with the latest fastai code. What would you suggest? add a new notebook even though I am adding just a relatively minor feature to the module?
If you don’t have this function, it’s definitely because you don’t have the latest version. ImageClassificationDataset is an ImageDataset which is a LabelDataset which is a Datasetbase which has a set_item function