[PoC] add docstring for prototype datasets #5843
Conversation
| API | ||
| --- | ||
|
|
||
| .. autofunction:: home |
There was a problem hiding this comment.
This is just here to make the cross link from the dataset docstrings work.
|
|
||
| .. autosummary:: | ||
| :toctree: generated/ | ||
| :template: class.rst |
There was a problem hiding this comment.
I've not used the class_dataset.rst template here, since we no longer promote "special members", i.e. dunder methods like __getitem__.
| @@ -54,7 +54,38 @@ class ImageNetDemux(enum.IntEnum): | |||
| @register_dataset(NAME) | |||
| class ImageNet(Dataset): | |||
| """ | |||
| $DESCRIPTION | |||
There was a problem hiding this comment.
This is just a placeholder, because I was to lazy to write something here for now. This should still be static and will not be filled at runtime.
|
|
||
| .. warning:: | ||
|
|
||
| The dataset files cannot be downloaded automatically! |
There was a problem hiding this comment.
Not sure how we can put the download instructions here without duplicating them in the resources. I'm inclined to put something like "Just instantiate this and follow the instructions in the error message" here, but that also seems weird.
Rendered documentation