Replacing output_bands with input_bands in modules, config files and examples

Signed-off-by: Joao Lucas de Sousa Almeida <[email protected]>

Author: Joao-L-S-Almeida

examples/confs/burn_scars.yaml

@@ -40,7 +40,7 @@ data:
       - NIR_NARROW
       - SWIR_1
       - SWIR_2
-    output_bands:
+    input_bands:
       - BLUE
       - GREEN
       - RED

examples/confs/multi_temporal_crop.yaml

@@ -44,7 +44,7 @@ data:
       - NIR_NARROW
       - SWIR_1
       - SWIR_2
-    output_bands:
+    input_bands:
       - BLUE
       - GREEN
       - RED

examples/confs/sen1floods11_vit.yaml

@@ -31,7 +31,7 @@ data:
       - NIR_NARROW
       - SWIR_1
       - SWIR_2
-    output_bands:
+    input_bands:
       - BLUE
       - GREEN
       - RED

examples/confs/sen1floods11_vit_local_ckpt.yaml

@@ -30,7 +30,7 @@ data:
       - NIR_NARROW
       - SWIR_1
       - SWIR_2
-    output_bands:
+    input_bands:
       - BLUE
       - GREEN
       - RED

examples/notebooks/Tutorial.ipynb

@@ -468,7 +468,7 @@
     "        HLSBands.SWIR_1,\n",
     "        HLSBands.SWIR_2,\n",
     "    ],\n",
-    "    output_bands=[\n",
+    "    input_bands=[\n",
     "        HLSBands.BLUE,\n",
     "        HLSBands.GREEN,\n",
     "        HLSBands.RED,\n",
@@ -871,7 +871,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "terratorch_os",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -885,7 +885,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.14"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

src/terratorch/datamodules/generic_pixel_wise_data_module.py

@@ -91,7 +91,7 @@ def __init__(
         allow_substring_split_file: bool = True,
         dataset_bands: list[HLSBands | int] | None = None,
         predict_dataset_bands: list[HLSBands | int] | None = None,
-        output_bands: list[HLSBands | int] | None = None,
+        input_bands: list[HLSBands | int] | None = None,
         constant_scale: float = 1,
         rgb_indices: list[int] | None = None,
         train_transform: A.Compose | None | list[A.BasicTransform] = None,
@@ -133,7 +133,7 @@ def __init__(
                 matches (e.g. eurosat). Defaults to True.
             dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
             predict_dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
-            output_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
+            input_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
             constant_scale (float, optional): _description_. Defaults to 1.
             rgb_indices (list[int] | None, optional): _description_. Defaults to None.
             train_transform (Albumentations.Compose | None): Albumentations transform
@@ -183,7 +183,7 @@ def __init__(
 
         self.dataset_bands = dataset_bands
         self.predict_dataset_bands = predict_dataset_bands if predict_dataset_bands else dataset_bands
-        self.output_bands = output_bands
+        self.input_bands = input_bands
         self.rgb_indices = rgb_indices
         self.expand_temporal_dimension = expand_temporal_dimension
         self.reduce_zero_label = reduce_zero_label
@@ -213,7 +213,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.train_transform,
@@ -233,7 +233,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.val_transform,
@@ -253,7 +253,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.test_transform,
@@ -267,7 +267,7 @@ def setup(self, stage: str) -> None:
                 self.predict_root,
                 self.num_classes,
                 dataset_bands=self.predict_dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.test_transform,
@@ -330,7 +330,7 @@ def __init__(
         allow_substring_split_file: bool = True,
         dataset_bands: list[HLSBands | int] | None = None,
         predict_dataset_bands: list[HLSBands | int] | None = None,
-        output_bands: list[HLSBands | int] | None = None,
+        input_bands: list[HLSBands | int] | None = None,
         constant_scale: float = 1,
         rgb_indices: list[int] | None = None,
         train_transform: A.Compose | None | list[A.BasicTransform] = None,
@@ -371,7 +371,7 @@ def __init__(
                 matches (e.g. eurosat). Defaults to True.
             dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
             predict_dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
-            output_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
+            input_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
             constant_scale (float, optional): _description_. Defaults to 1.
             rgb_indices (list[int] | None, optional): _description_. Defaults to None.
             train_transform (Albumentations.Compose | None): Albumentations transform
@@ -421,7 +421,7 @@ def __init__(
 
         self.dataset_bands = dataset_bands
         self.predict_dataset_bands = predict_dataset_bands if predict_dataset_bands else dataset_bands
-        self.output_bands = output_bands
+        self.input_bands = input_bands
         self.rgb_indices = rgb_indices
 
         # self.aug = AugmentationSequential(
@@ -447,7 +447,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.train_transform,
@@ -466,7 +466,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.val_transform,
@@ -485,7 +485,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.test_transform,
@@ -499,7 +499,7 @@ def setup(self, stage: str) -> None:
             self.predict_dataset = self.dataset_class(
                 self.predict_root,
                 dataset_bands=self.predict_dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.test_transform,

src/terratorch/datamodules/generic_scalar_label_data_module.py

@@ -77,7 +77,7 @@ def __init__(
         allow_substring_split_file: bool = True,
         dataset_bands: list[HLSBands | int] | None = None,
         predict_dataset_bands: list[HLSBands | int] | None = None,
-        output_bands: list[HLSBands | int] | None = None,
+        input_bands: list[HLSBands | int] | None = None,
         constant_scale: float = 1,
         rgb_indices: list[int] | None = None,
         train_transform: A.Compose | None | list[A.BasicTransform] = None,
@@ -112,7 +112,7 @@ def __init__(
                 matches (e.g. eurosat). Defaults to True.
             dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
             predict_dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
-            output_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
+            input_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
             constant_scale (float, optional): _description_. Defaults to 1.
             rgb_indices (list[int] | None, optional): _description_. Defaults to None.
             train_transform (Albumentations.Compose | None): Albumentations transform
@@ -152,7 +152,7 @@ def __init__(
 
         self.dataset_bands = dataset_bands
         self.predict_dataset_bands = predict_dataset_bands if predict_dataset_bands else dataset_bands
-        self.output_bands = output_bands
+        self.input_bands = input_bands
         self.rgb_indices = rgb_indices
         self.expand_temporal_dimension = expand_temporal_dimension
 
@@ -178,7 +178,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.train_transform,
@@ -193,7 +193,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.val_transform,
@@ -208,7 +208,7 @@ def setup(self, stage: str) -> None:
                 ignore_split_file_extensions=self.ignore_split_file_extensions,
                 allow_substring_split_file=self.allow_substring_split_file,
                 dataset_bands=self.dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.test_transform,
@@ -220,7 +220,7 @@ def setup(self, stage: str) -> None:
                 self.predict_root,
                 self.num_classes,
                 dataset_bands=self.predict_dataset_bands,
-                output_bands=self.output_bands,
+                input_bands=self.input_bands,
                 constant_scale=self.constant_scale,
                 rgb_indices=self.rgb_indices,
                 transform=self.test_transform,
@@ -277,7 +277,7 @@ def _dataloader_factory(self, split: str) -> DataLoader[dict[str, Tensor]]:
 #         allow_substring_split_file: bool = True,
 #         dataset_bands: list[HLSBands | int] | None = None,
 #         predict_dataset_bands: list[HLSBands | int] | None = None,
-#         output_bands: list[HLSBands | int] | None = None,
+#         input_bands: list[HLSBands | int] | None = None,
 #         constant_scale: float = 1,
 #         rgb_indices: list[int] | None = None,
 #         train_transform: A.Compose | None | list[A.BasicTransform] = None,
@@ -311,7 +311,7 @@ def _dataloader_factory(self, split: str) -> DataLoader[dict[str, Tensor]]:
 #                 matches (e.g. eurosat). Defaults to True.
 #             dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
 #             predict_dataset_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
-#             output_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
+#             input_bands (list[HLSBands | int] | None, optional): _description_. Defaults to None.
 #             constant_scale (float, optional): _description_. Defaults to 1.
 #             rgb_indices (list[int] | None, optional): _description_. Defaults to None.
 #             train_transform (Albumentations.Compose | None): Albumentations transform
@@ -350,7 +350,7 @@ def _dataloader_factory(self, split: str) -> DataLoader[dict[str, Tensor]]:
 #         self.constant_scale = constant_scale
 #         self.dataset_bands = dataset_bands
 #         self.predict_dataset_bands = predict_dataset_bands if predict_dataset_bands else dataset_bands
-#         self.output_bands = output_bands
+#         self.input_bands = input_bands
 #         self.rgb_indices = rgb_indices
 
 #         # self.aug = AugmentationSequential(
@@ -372,7 +372,7 @@ def _dataloader_factory(self, split: str) -> DataLoader[dict[str, Tensor]]:
 #                 ignore_split_file_extensions=self.ignore_split_file_extensions,
 #                 allow_substring_split_file=self.allow_substring_split_file,
 #                 dataset_bands=self.dataset_bands,
-#                 output_bands=self.output_bands,
+#                 input_bands=self.input_bands,
 #                 constant_scale=self.constant_scale,
 #                 rgb_indices=self.rgb_indices,
 #                 transform=self.train_transform,
@@ -386,7 +386,7 @@ def _dataloader_factory(self, split: str) -> DataLoader[dict[str, Tensor]]:
 #                 ignore_split_file_extensions=self.ignore_split_file_extensions,
 #                 allow_substring_split_file=self.allow_substring_split_file,
 #                 dataset_bands=self.dataset_bands,
-#                 output_bands=self.output_bands,
+#                 input_bands=self.input_bands,
 #                 constant_scale=self.constant_scale,
 #                 rgb_indices=self.rgb_indices,
 #                 transform=self.val_transform,
@@ -400,7 +400,7 @@ def _dataloader_factory(self, split: str) -> DataLoader[dict[str, Tensor]]:
 #                 ignore_split_file_extensions=self.ignore_split_file_extensions,
 #                 allow_substring_split_file=self.allow_substring_split_file,
 #                 dataset_bands=self.dataset_bands,
-#                 output_bands=self.output_bands,
+#                 input_bands=self.input_bands,
 #                 constant_scale=self.constant_scale,
 #                 rgb_indices=self.rgb_indices,
 #                 transform=self.test_transform,
@@ -412,7 +412,7 @@ def _dataloader_factory(self, split: str) -> DataLoader[dict[str, Tensor]]:
 #             self.predict_dataset = self.dataset_class(
 #                 self.predict_root,
 #                 dataset_bands=self.predict_dataset_bands,
-#                 output_bands=self.output_bands,
+#                 input_bands=self.input_bands,
 #                 constant_scale=self.constant_scale,
 #                 rgb_indices=self.rgb_indices,
 #                 transform=self.test_transform,