Skip to main content

Shared types

Types referenced by more than one section of the config.

EscapeHatchComponent

ComponentConfig with a 'manual' discriminator for use in typed unions.

FieldTypeRequiredDefaultDescription
class_pathstringyes
init_argsobject with arbitrary keysnonull
name"manual"yes

FixedSize

User-specified explicit window size in pixels.

Supplied geometries will be centered within a square window of this size. No checking for geometry clipping is performed.

Example: size = 128, point annotation at ×

←───── 128 px ─────→
┌────────────────────┐ ↑
│░░░░░░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░░░░░░│
│░░░░░░░░░×░░░░░░░░░░│ 128 px
│░░░░░░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░░░░░░│
└────────────────────┘ ↓

Example: size = 128, polygon annotation

←───── 128 px ─────→
┌────────────────────┐ ↑
│░░░░░░░░░░░░░░░░░░░░│
│░░░┌┄┄┄┄┄┄┄┄┄┄┄┄┐░░░│
│░░░┆ polygon ┆░░░│ 128 px
│░░░┆ (centered) ┆░░░│
│░░░└┄┄┄┄┄┄┄┄┄┄┄┄┘░░░│
│░░░░░░░░░░░░░░░░░░░░│
└────────────────────┘ ↓
FieldTypeRequiredDefaultDescription
name"fixed_size"yes
sizeinteger (> 0)yesSide length of each square window in pixels.

MatchInputSize

Window size equals input_preprocessing.default.input_size (or split override).

Natural choice for vector classification/regression where the window IS the model input.

Example: input_size = 64, point annotation at ×

←──── 64 px ────→
┌───────────────┐ ↑
│░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░│
│░░░░░░░×░░░░░░░│ 64 px
│░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░│
└───────────────┘ ↓

Example: input_size = 64, polygon annotation

←──── 64 px ────→
┌────────────────┐ ↑
│░░░░░░░░░░░░░░░░│
│░░┌┄┄┄┄┄┄┄┄┄┄┐░░│
│░░┆ polygon ┆░░│ 64 px
│░░┆(centered)┆░░│
│░░└┄┄┄┄┄┄┄┄┄┄┘░░│
│░░░░░░░░░░░░░░░░│
└────────────────┘ ↓

No checking for geometry clipping is performed.

FieldTypeRequiredDefaultDescription
name"match_input_size"yes