microsoft / torchgeo

TorchGeo: datasets, samplers, transforms, and pre-trained models for geospatial data
https://www.osgeo.org/projects/torchgeo/
MIT License
2.61k stars 322 forks source link

An effort at dataset docstring standardization #586

Open calebrob6 opened 2 years ago

calebrob6 commented 2 years ago

I've noticed that the docstrings of some datasets aren't complete (in the sense that an unfamiliar user wouldn't know what the data looks like even after reading the docstring). We should go through the docstrings of existing datasets and see if we can standardize some data/formatting. I think including the following for the non-geospatial datasets would be a good start:

adamjstewart commented 3 weeks ago

I wonder how much of this is covered by our dataset tables: https://torchgeo.readthedocs.io/en/stable/api/datasets.html#non-geospatial-datasets

Without a custom ruff plugin to check for this, I think it's going to be impossible to enforce, even for me.