rslearn.models.multitask¶
multitask ¶
MultiTaskModel for rslearn.
MultiTaskModel ¶
Bases: Module
MultiTask model wrapper.
MultiTaskModel first passes its inputs through the sequential encoder models.
Then, it applies one sequential decoder for each configured task. It computes outputs and loss using the final module in the decoder.
Optionally include a shared trunk module to postprocess the encoder features.
Source code in rslearn/models/multitask.py
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 208 209 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 | |
apply_decoder ¶
apply_decoder(intermediates: Any, context: ModelContext, targets: list[dict[str, Any]] | None, decoder: list[IntermediateComponent | Predictor], task_name: str) -> ModelOutput
Apply a decoder to a list of inputs and targets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
intermediates
|
Any
|
the intermediate output from the encoder. |
required |
context
|
ModelContext
|
the model context. |
required |
targets
|
list[dict[str, Any]] | None
|
list of target dicts |
required |
decoder
|
list[IntermediateComponent | Predictor]
|
list of decoder modules |
required |
task_name
|
str
|
the name of the task |
required |
Returns:
| Type | Description |
|---|---|
ModelOutput
|
a ModelOutput containing outputs across all the decoders. |
Source code in rslearn/models/multitask.py
apply_decoders ¶
apply_decoders(intermediates: Any, context: ModelContext, targets: list[dict[str, Any]] | None) -> ModelOutput
Apply all the decoders to the features and targets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
intermediates
|
Any
|
the intermediates from the encoder. |
required |
context
|
ModelContext
|
the model context |
required |
targets
|
list[dict[str, Any]] | None
|
list of target dicts |
required |
Returns:
| Type | Description |
|---|---|
ModelOutput
|
combined ModelOutput. The outputs is a list of output dicts, one per example, where the dict maps from task name to the corresponding task output. The losses is a flat dict but the task name is prepended to the loss names. |
Source code in rslearn/models/multitask.py
forward ¶
forward(context: ModelContext, targets: list[dict[str, Any]] | None = None) -> ModelOutput
Apply the sequence of modules on the inputs, including shared trunk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
context
|
ModelContext
|
the model context. |
required |
targets
|
list[dict[str, Any]] | None
|
optional list of target dicts |
None
|
Returns:
| Type | Description |
|---|---|
ModelOutput
|
the model output from apply_decoders. |
Source code in rslearn/models/multitask.py
MultiTaskMergedModel ¶
Bases: MultiTaskModel
Similar to MultiTaskModel, but allow merging in label space.
For example, if you have two classification tasks with N and M labels each, this will handle generating an output layer with N+M layers and the corresponding modification of targets/predictions/metrics.
Applies one sequential decoder for each configured task. It computes outputs and loss using the final module in the decoder.
Source code in rslearn/models/multitask.py
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 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | |
merge_task_labels ¶
merge_task_labels(targets: list[dict[str, Any]] | None, task_name: str) -> list[dict[str, Any]] | None
Merge the task labels by adding an offset to the label key.
Make a clone before doing this because we may use targets elsewhere.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
targets
|
list[dict[str, Any]] | None
|
the target dicts |
required |
task_name
|
str
|
the name of the task |
required |
Source code in rslearn/models/multitask.py
unmerge_output_labels ¶
Unmerge the task outputs.
For most tasks, this means chopping off the corresponding label dimensions. For some, we might just need to subtract an offset from the target (ex: segmentation). Assume first dimension is the number of outputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
outputs
|
Iterable[Any]
|
the predictions |
required |
task_name
|
str
|
the name of the task |
required |
Returns:
| Type | Description |
|---|---|
list[dict[str, Tensor | dict]]
|
the unmerged outputs. |
Source code in rslearn/models/multitask.py
forward ¶
forward(context: ModelContext, targets: list[dict[str, Any]] | None = None) -> ModelOutput
Apply the sequence of modules on the inputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
context
|
ModelContext
|
the model context. |
required |
targets
|
list[dict[str, Any]] | None
|
optional list of target dicts |
None
|
Returns:
| Type | Description |
|---|---|
ModelOutput
|
the model output. |
Source code in rslearn/models/multitask.py
sort_keys ¶
Recursively (half in place) sort the keys of a dictionary.
Need this so that the order of task embeddings indexing is consistent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
d
|
dict[str, Any]
|
The dictionary to sort. |
required |
Source code in rslearn/models/multitask.py
deepcopy_tensordict ¶
Deepcopy a dict with torch.Tensor, dict, and other types.
Make sure tensor copying is handled properly.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
d
|
dict[Any, Any]
|
the dict to deepcopy |
required |