convnext
sleap_nn.architectures.convnext
¶
This module provides a generalized implementation of ConvNext.
See the ConvNextWrapper
class docstring for more information.
Classes:
Name | Description |
---|---|
ConvNeXtEncoder |
ConvNext backbone for pose estimation. |
ConvNextWrapper |
ConvNext architecture for pose estimation. |
ConvNeXtEncoder
¶
Bases: Module
ConvNext backbone for pose estimation.
This class implements ConvNext from the A ConvNet for the 2020s <https://arxiv.org/abs/2201.03545>
paper. Source: torchvision.models. This module serves as the backbone/ encoder
architecture to extract features from the input image.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
blocks (dict)
|
Dictionary of depths and channels. Default is "Tiny architecture" |
required | |
in_channels
|
int
|
Input number of channels. Default: 1. |
1
|
stem_kernel
|
int
|
Size of the convolutional kernels in the stem layer. Default is 4. |
4
|
stem_stride
|
int
|
Convolutional stride in the stem layer. Default is 2. |
2
|
stochastic_depth_prob
|
float
|
Stochastic depth rate. Default: 0.1. |
0.0
|
layer_scale
|
float
|
Scale for Layer normalization layer. Default: 1e-6. |
1e-06
|
block
|
Module
|
SwinTransformer Block. Default: None. |
None
|
norm_layer
|
Module
|
Normalization layer. Default: None. |
None
|
Methods:
Name | Description |
---|---|
__init__ |
Initialize the ConvNext Encoder. |
forward |
Forward pass through the ConvNext encoder. |
Source code in sleap_nn/architectures/convnext.py
19 20 21 22 23 24 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 |
|
__init__(blocks={'depths': [3, 3, 9, 3], 'channels': [96, 192, 384, 768]}, in_channels=1, stem_kernel=4, stem_stride=2, stochastic_depth_prob=0.0, layer_scale=1e-06, block=None, norm_layer=None, **kwargs)
¶
Initialize the ConvNext Encoder.
Source code in sleap_nn/architectures/convnext.py
forward(x)
¶
Forward pass through the ConvNext encoder.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x
|
Tensor
|
Input tensor. |
required |
Returns:
Type | Description |
---|---|
Tensor
|
Outputs a list of tensors from each stage after applying the ConvNext backbone. |
Source code in sleap_nn/architectures/convnext.py
ConvNextWrapper
¶
Bases: Module
ConvNext architecture for pose estimation.
This class defines the ConvNext architecture for pose estimation, combining an ConvNext as the encoder and a decoder. The encoder extracts features from the input, while the decoder generates confidence maps based on the features.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_type
|
str
|
One of the ConvNext architecture types: ["tiny", "small", "base", "large"]. |
required |
output_stride
|
int
|
Minimum of the strides of the output heads. The input confidence map. |
required |
in_channels
|
int
|
Number of input channels. Default is 1. |
1
|
arch
|
dict
|
Dictionary of depths and channels. Default is "Tiny architecture" |
{'depths': [3, 3, 9, 3], 'channels': [96, 192, 384, 768]}
|
{'depths'
|
[3,3,9,3], 'channels':[96, 192, 384, 768]} |
required | |
kernel_size
|
int
|
Size of the convolutional kernels. Default is 3. |
3
|
stem_patch_kernel
|
int
|
Size of the convolutional kernels in the stem layer. Default is 4. |
4
|
stem_patch_stride
|
int
|
Convolutional stride in the stem layer. Default is 2. |
2
|
filters_rate
|
int
|
Factor to adjust the number of filters per block. Default is 2. |
2
|
convs_per_block
|
int
|
Number of convolutional layers per block. Default is 2. |
2
|
up_interpolate
|
bool
|
If True, use bilinear interpolation instead of transposed convolutions for upsampling. Interpolation is faster but transposed convolutions may be able to learn richer or more complex upsampling to recover details from higher scales. |
True
|
max_stride
|
int
|
Factor by which input image size is reduced through the layers. This is always |
32
|
block_contraction
|
bool
|
If True, reduces the number of filters at the end of middle and decoder blocks. This has the effect of introducing an additional bottleneck before each upsampling step. |
False
|
Methods:
Name | Description |
---|---|
__init__ |
Initialize the class. |
forward |
Forward pass through the ConvNeXt architecture. |
from_config |
Create ConvNextWrapper from a config. |
Attributes:
Name | Type | Description |
---|---|---|
max_channels |
Returns the maximum channels of the ConvNext (last layer of the encoder). |
Source code in sleap_nn/architectures/convnext.py
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 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 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 |
|
max_channels
property
¶
Returns the maximum channels of the ConvNext (last layer of the encoder).
__init__(model_type, output_stride, arch={'depths': [3, 3, 9, 3], 'channels': [96, 192, 384, 768]}, in_channels=1, kernel_size=3, stem_patch_kernel=4, stem_patch_stride=2, filters_rate=2, convs_per_block=2, up_interpolate=True, max_stride=32, block_contraction=False)
¶
Initialize the class.
Source code in sleap_nn/architectures/convnext.py
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 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 |
|
forward(x)
¶
Forward pass through the ConvNeXt architecture.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x
|
Tensor
|
Input tensor (Batch, Channels, Height, Width). |
required |
Returns:
Name | Type | Description |
---|---|---|
x |
Tuple[List[Tensor], List]
|
Outputs a dictionary with |
Source code in sleap_nn/architectures/convnext.py
from_config(config)
classmethod
¶
Create ConvNextWrapper from a config.