geo-deep-learning icon indicating copy to clipboard operation
geo-deep-learning copied to clipboard

Align GDL's nomenclature to Torchgeo/Pytorch Lightning

Open remtav opened this issue 3 years ago • 2 comments

Torchgeo's glossary

Some examples:

  • sample -> chip/patch
  • Use "aoi" and "tile" in documentation:
    • aoi: Synonym for region of interest (ROI). A particular spatial area to focus on.
    • tile: A single image file taken by a remote sensor like a satellite.

GDL's mode should also be revised. I'd suggest changing all modes to be verbs at the infinitive form:

  • sampling -> tile
  • train
  • inference -> predict
  • postprocess
  • validate
  • ...

Since some confusion exists in Torchgeo's glossary, we've agreed to the following:

  • Use "tiling" when possible rather than "tile" (as infinitive verb)
  • Use "patches", not "tiles", "chips" or "samples"

remtav avatar Mar 31 '22 13:03 remtav

changing all modes to verbs 👍

ymoisan avatar Mar 31 '22 17:03 ymoisan

For training, our SegmentationDataset returns a dict with "sat_img" and "map_img" as keys.

Torchgeo uses "image" and "mask" as equivalents to these keys. We should stick to this new standard, also because some torchgeo utilities that could become useful to us expect these keys specifically:

Examples of torchgeo datasets using these keys:

A torchgeo utility expecting these keys specifically:

remtav avatar Nov 09 '22 18:11 remtav