Replace docstring for paths in all raster

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

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

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

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

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

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

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

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

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

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

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__(

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

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

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