rslearn.train.tasks.per_pixel_regression¶
per_pixel_regression ¶
Per-pixel regression task.
PerPixelRegressionTask ¶
Bases: BasicTask
A per-pixel regression task.
Source code in rslearn/train/tasks/per_pixel_regression.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | |
process_inputs ¶
process_inputs(raw_inputs: dict[str, RasterImage | list[Feature]], metadata: SampleMetadata, load_targets: bool = True) -> tuple[dict[str, Any], dict[str, Any]]
Processes the data into targets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw_inputs
|
dict[str, RasterImage | list[Feature]]
|
raster or vector data to process |
required |
metadata
|
SampleMetadata
|
metadata about the patch being read |
required |
load_targets
|
bool
|
whether to load the targets or only inputs |
True
|
Returns:
| Type | Description |
|---|---|
tuple[dict[str, Any], dict[str, Any]]
|
tuple (input_dict, target_dict) containing the processed inputs and targets that are compatible with both metrics and loss functions |
Source code in rslearn/train/tasks/per_pixel_regression.py
process_output ¶
process_output(raw_output: Any, metadata: SampleMetadata) -> NDArray[Any] | list[Feature]
Processes an output into raster or vector data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw_output
|
Any
|
the output from prediction head, which must be an HW tensor. |
required |
metadata
|
SampleMetadata
|
metadata about the patch being read |
required |
Returns:
| Type | Description |
|---|---|
NDArray[Any] | list[Feature]
|
either raster or vector data. |
Source code in rslearn/train/tasks/per_pixel_regression.py
visualize ¶
visualize(input_dict: dict[str, Any], target_dict: dict[str, Any] | None, output: Any) -> dict[str, NDArray[Any]]
Visualize the outputs and targets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_dict
|
dict[str, Any]
|
the input dict from process_inputs |
required |
target_dict
|
dict[str, Any] | None
|
the target dict from process_inputs |
required |
output
|
Any
|
the prediction |
required |
Returns:
| Type | Description |
|---|---|
dict[str, NDArray[Any]]
|
a dictionary mapping image name to visualization image |
Source code in rslearn/train/tasks/per_pixel_regression.py
get_metrics ¶
Get the metrics for this task.
Source code in rslearn/train/tasks/per_pixel_regression.py
PerPixelRegressionHead ¶
Bases: Predictor
Head for per-pixel regression task.
Source code in rslearn/train/tasks/per_pixel_regression.py
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 | |
forward ¶
forward(intermediates: Any, context: ModelContext, targets: list[dict[str, Any]] | None = None) -> ModelOutput
Compute the regression outputs and loss from logits and targets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
intermediates
|
Any
|
output from previous component, which must be a FeatureMaps with one feature map corresponding to the logits. The channel dimension size must be 1. |
required |
context
|
ModelContext
|
the model context. |
required |
targets
|
list[dict[str, Any]] | None
|
must contain values key that stores the regression labels, and valid key containing mask image indicating where the labels are valid. |
None
|
Returns:
| Type | Description |
|---|---|
ModelOutput
|
tuple of outputs and loss dict. The output is a BHW tensor so that the per-sample output is an HW tensor. |
Source code in rslearn/train/tasks/per_pixel_regression.py
PerPixelRegressionMetricWrapper ¶
Bases: Metric
Metric for per-pixel regression task.
Source code in rslearn/train/tasks/per_pixel_regression.py
update ¶
Update metric.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
preds
|
list[Any] | Tensor
|
the predictions |
required |
targets
|
list[dict[str, Any]]
|
the targets |
required |