torchgeo icon indicating copy to clipboard operation
torchgeo copied to clipboard

An effort at dataset docstring standardization

Open calebrob6 opened this issue 3 years ago • 1 comments

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:

  • Sensor
  • Task
  • Source of imagery
  • Number of samples by split
  • Size of sample
  • Spatial resolution
  • Number / type of bands

calebrob6 avatar Jun 15 '22 21:06 calebrob6

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.

adamjstewart avatar Aug 21 '24 15:08 adamjstewart