diff --git a/torchgeo/datasets/agb_live_woody_density.py b/torchgeo/datasets/agb_live_woody_density.py index d479ae2d1e2..8bee8d5ff02 100644 --- a/torchgeo/datasets/agb_live_woody_density.py +++ b/torchgeo/datasets/agb_live_woody_density.py @@ -69,8 +69,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/astergdem.py b/torchgeo/datasets/astergdem.py index 7055ab07cdf..290031d6867 100644 --- a/torchgeo/datasets/astergdem.py +++ b/torchgeo/datasets/astergdem.py @@ -54,9 +54,8 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found, here the collection of - individual zip files for each tile should be found + paths: one or more root directories to search or files to load, here + the collection of individual zip files for each tile should be found crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/cdl.py b/torchgeo/datasets/cdl.py index de198563e18..09e9362de46 100644 --- a/torchgeo/datasets/cdl.py +++ b/torchgeo/datasets/cdl.py @@ -218,8 +218,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/chesapeake.py b/torchgeo/datasets/chesapeake.py index f7e8b2b4f96..eab5ccd906e 100644 --- a/torchgeo/datasets/chesapeake.py +++ b/torchgeo/datasets/chesapeake.py @@ -100,8 +100,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/cms_mangrove_canopy.py b/torchgeo/datasets/cms_mangrove_canopy.py index f33f4f3645d..f251f27c8d8 100644 --- a/torchgeo/datasets/cms_mangrove_canopy.py +++ b/torchgeo/datasets/cms_mangrove_canopy.py @@ -178,8 +178,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/esri2020.py b/torchgeo/datasets/esri2020.py index c811813df72..af8e9f18d06 100644 --- a/torchgeo/datasets/esri2020.py +++ b/torchgeo/datasets/esri2020.py @@ -77,8 +77,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/eudem.py b/torchgeo/datasets/eudem.py index f65926dd798..707d8f31bf3 100644 --- a/torchgeo/datasets/eudem.py +++ b/torchgeo/datasets/eudem.py @@ -92,9 +92,8 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found, here the collection of - individual zip files for each tile should be found + paths: one or more root directories to search or files to load, here + the collection of individual zip files for each tile should be found crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/globbiomass.py b/torchgeo/datasets/globbiomass.py index 269817a0172..139b302ed8e 100644 --- a/torchgeo/datasets/globbiomass.py +++ b/torchgeo/datasets/globbiomass.py @@ -129,8 +129,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/l7irish.py b/torchgeo/datasets/l7irish.py index 7e53dd97c0f..542badea902 100644 --- a/torchgeo/datasets/l7irish.py +++ b/torchgeo/datasets/l7irish.py @@ -102,8 +102,7 @@ def __init__( """Initialize a new L7Irish instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to EPSG:3857) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/l8biome.py b/torchgeo/datasets/l8biome.py index 6fc59c60279..0bec4cb65f2 100644 --- a/torchgeo/datasets/l8biome.py +++ b/torchgeo/datasets/l8biome.py @@ -100,8 +100,7 @@ def __init__( """Initialize a new L8Biome instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to EPSG:3857) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/landcoverai.py b/torchgeo/datasets/landcoverai.py index 76aadacd5be..bec41de1386 100644 --- a/torchgeo/datasets/landcoverai.py +++ b/torchgeo/datasets/landcoverai.py @@ -229,21 +229,20 @@ def __init__( """Initialize a new LandCover.ai NonGeo dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found - crs: :term:`coordinate reference system (CRS)` to warp to - (defaults to the CRS of the first file found) - res: resolution of the dataset in units of CRS - (defaults to the resolution of the first file found) - transforms: a function/transform that takes input sample and its target as - entry and returns a transformed version - cache: if True, cache file handle to speed up repeated sampling - download: if True, download dataset and store it in the root directory - checksum: if True, check the MD5 of the downloaded files (may be slow) + paths: one or more root directories to search or files to load + crs: :term:`coordinate reference system (CRS)` to warp to + (defaults to the CRS of the first file found) + res: resolution of the dataset in units of CRS + (defaults to the resolution of the first file found) + transforms: a function/transform that takes input sample and its target as + entry and returns a transformed version + cache: if True, cache file handle to speed up repeated sampling + download: if True, download dataset and store it in the root directory + checksum: if True, check the MD5 of the downloaded files (may be slow) Raises: - RuntimeError: if ``download=False`` and data is not found, or checksums - don't match + RuntimeError: if ``download=False`` and data is not found, or checksums + don't match """ LandCoverAIBase.__init__(self, paths, download, checksum) RasterDataset.__init__( diff --git a/torchgeo/datasets/landsat.py b/torchgeo/datasets/landsat.py index 1122ec63b8a..a52a9200b2f 100644 --- a/torchgeo/datasets/landsat.py +++ b/torchgeo/datasets/landsat.py @@ -68,8 +68,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/nlcd.py b/torchgeo/datasets/nlcd.py index b3f05e1ea93..3ee2c1897c0 100644 --- a/torchgeo/datasets/nlcd.py +++ b/torchgeo/datasets/nlcd.py @@ -119,8 +119,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS diff --git a/torchgeo/datasets/sentinel.py b/torchgeo/datasets/sentinel.py index ad53d560346..0eb93c8c03e 100644 --- a/torchgeo/datasets/sentinel.py +++ b/torchgeo/datasets/sentinel.py @@ -150,8 +150,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS @@ -306,8 +305,7 @@ def __init__( """Initialize a new Dataset instance. Args: - paths: root directory or list of absolute filepaths where - dataset can be found + paths: one or more root directories to search or files to load crs: :term:`coordinate reference system (CRS)` to warp to (defaults to the CRS of the first file found) res: resolution of the dataset in units of CRS