Image Segmentation
ultralytics
PyTorch
English
object-detection
instance-segmentation
yolov8
coco
real-time
capsule-network
interpretable-ai
symbolic-ai
Eval Results (legacy)
Instructions to use zpyuan/SymbolicCapsuleNetwork with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- ultralytics
How to use zpyuan/SymbolicCapsuleNetwork with ultralytics:
from ultralytics import YOLOvv8 model = YOLOvv8.from_pretrained("zpyuan/SymbolicCapsuleNetwork") source = 'http://images.cocodataset.org/val2017/000000039769.jpg' model.predict(source=source, save=True) - Notebooks
- Google Colab
- Kaggle
File size: 30,151 Bytes
966d9af | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 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 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 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 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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 | """
CapsNeck: efficient capsule-style neck blocks for Ultralytics YAML models.
Design intent:
- Keep capsule semantics (type/channel grouping + routing-style fusion).
- Stay lightweight and export-friendly for detection training/inference.
- Avoid expensive iterative EM/dynamic routing inside the neck path.
This neck is "capsule-style" rather than a full matrix-capsule network:
1) CapsProj : CNN feature -> packed capsules (K types * D dims)
2) CapsAlign : scale alignment between pyramid levels (no global context)
3) CapsRoute : efficient self-routing proxy across sources (softmax source gating)
4) CapsDecode: packed capsules -> standard feature map for Detect
5) CapsuleTap: optional pass-through cache hook for analysis/aux losses
Note:
- Routing here is source-level and single-step by default (iters=1), chosen for speed.
- If stronger capsule routing is needed, it should be added in the head where cost is lower.
"""
from __future__ import annotations
from typing import List, Optional, Tuple, Union
import math
import time
import torch
import torch.nn as nn
import torch.nn.functional as F
from ultralytics.nn.modules import C3k2, Conv, DWConv
# -------------------------
# 1) CapsProj
# -------------------------
class CapsProj(nn.Module):
"""
Project a standard feature map into packed capsule channels using one C3k2 block.
Input: x [B, C, H, W]
Output: u [B, K*(D+1), H, W]
Args:
K: number of capsule types
D: capsule pose dimension per type
mix/mix_kernel: kept for backward YAML compatibility (unused)
"""
def __init__(self, c1: int, K: int = 4, D: int = 16):
super().__init__()
self.K = int(K)
self.D = int(D)
self.c_out = self.K * (self.D + 1)
# Use a single C3k2 block as the capsule projection operator.
self.map = C3k2(c1, self.c_out, n=1, c3k=False, e=0.5, g=1, shortcut=True)
def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.map(x)
# -------------------------
# 2) CapsAlign (no context)
# -------------------------
class CapsAlign(nn.Module):
"""
Align packed capsules across pyramid levels with YOLO-style ops.
- Upsampling uses ``nn.Upsample(scale_factor=2, mode='nearest')``.
- Downsampling uses stride-2 ``Conv`` blocks.
Args:
c1: input/output channel count.
src_level: source pyramid level in {3,4,5}.
tgt_level: target pyramid level in {3,4,5}.
down_groups: groups for downsample Conv.
Use capsule-type count K to keep each capsule block isolated.
"""
def __init__(self, c1: int, src_level: int, tgt_level: int, down_groups: int = 1):
super().__init__()
self.c1 = int(c1)
self.src_level = int(src_level)
self.tgt_level = int(tgt_level)
self.down_groups = int(down_groups)
if self.src_level not in (3, 4, 5) or self.tgt_level not in (3, 4, 5):
raise ValueError("CapsAlign levels must be in {3,4,5}.")
if self.down_groups < 1 or self.c1 % self.down_groups != 0:
raise ValueError(f"CapsAlign down_groups={self.down_groups} must divide c1={self.c1}.")
steps = abs(self.src_level - self.tgt_level)
if self.src_level == self.tgt_level:
self.mode = 'identity'
self.ops = nn.ModuleList()
elif self.src_level > self.tgt_level:
self.mode = 'up'
# YOLO-style top-down path: nearest-neighbor upsample x2 per level.
self.ops = nn.ModuleList(nn.Upsample(scale_factor=2, mode='nearest') for _ in range(steps))
else:
self.mode = 'down'
# YOLO-style bottom-up path: stride-2 grouped Conv per level.
self.ops = nn.ModuleList(Conv(self.c1, self.c1, 3, 2, g=self.down_groups) for _ in range(steps))
def forward(self, x: torch.Tensor) -> torch.Tensor:
if self.mode == 'identity':
return x
for op in self.ops:
x = op(x)
return x
# -------------------------
# 3) CapsRoute (light, parser-friendly)
# -------------------------
class ConvSelfRouting(nn.Module):
"""Grouped-conv self-routing over stacked capsule sources.
Args:
K_in: input capsule type count.
P_in: input pose dimension.
K_out: output capsule type count.
P_out: output pose dimension.
kernel_size: grouped conv kernel for local capsule mixing.
"""
def __init__(self, K_in: int, P_in: int, K_out: int, P_out: int, kernel_size: int = 3):
super().__init__()
self.K_in = int(K_in)
self.P_in = int(P_in)
self.K_out = int(K_out)
self.P_out = int(P_out)
if min(self.K_in, self.P_in, self.K_out, self.P_out) <= 0:
raise ValueError('ConvSelfRouting expects positive K/P values.')
self.c_in = self.K_in * (self.P_in + 1)
self.c_out = self.K_out * (self.P_out + 1)
k = int(kernel_size)
padding = k//2
self.mix = nn.Conv2d(self.c_in, self.c_in, kernel_size=k, stride=1, padding=padding, groups=self.K_in, bias=False)
self.gate = nn.Conv2d(self.c_in, self.K_in, kernel_size=1, stride=1, padding=0, groups=self.K_in, bias=True)
def forward(self, x: torch.Tensor) -> torch.Tensor:
# x: [B,C,H,W], C = K_in*(P_in+1)
b, c, h, w = x.shape
if c != self.c_in:
raise ValueError(f'ConvSelfRouting expected C={self.c_in}, got C={c}')
mixed = self.mix(x)
logits = self.gate(mixed).reshape(b, self.K_in, h, w)
weights = logits.softmax(dim=1)
caps = mixed.reshape(b, self.K_in, self.P_in + 1, h, w)
routed = weights.unsqueeze(2) * caps
routed = routed.reshape(b, self.c_in, h, w)
return routed
class SelfRouting(nn.Module):
"""Pose-transform self-routing on packed capsule tensor.
Args:
K_in: input capsule type count.
P_in: input pose dimension.
K_out: output capsule type count.
P_out: output pose dimension.
Input:
x: [B, K_in*(P_in+1), H, W]
Output:
y: [B, K_out*(P_out+1), H, W]
"""
def __init__(self, K_in: int, P_in: int, K_out: int, P_out: int):
super().__init__()
self.K_in = int(K_in)
self.P_in = int(P_in)
self.K_out = int(K_out)
self.P_out = int(P_out)
if min(self.K_in, self.P_in, self.K_out, self.P_out) <= 0:
raise ValueError('SelfRouting expects positive K/P values.')
self.c_in = self.K_in * (self.P_in + 1)
self.c_out = self.K_out * (self.P_out + 1)
self.eps = 1e-6
self.W_pose = nn.Parameter(torch.empty(self.K_in, self.K_out, self.P_in, self.P_out))
nn.init.kaiming_uniform_(self.W_pose, a=math.sqrt(5))
self.W_gate = nn.Parameter(torch.zeros(self.K_in, self.K_out, self.P_in))
self.b_gate = nn.Parameter(torch.zeros(1, self.K_in, self.K_out, 1, 1))
def forward(self, x: torch.Tensor) -> torch.Tensor:
# x: [B, C, H, W], C = K_in*(P_in+1)
if x.ndim != 4:
raise TypeError(f'SelfRouting expects [B,C,H,W], got {tuple(x.shape)}')
b, c, h, w = x.shape
if c != self.c_in:
raise ValueError(f'SelfRouting expected C={self.c_in}, got C={c}')
# Packed capsule layout is interleaved per type: [pose(P), act(1)].
# x_caps: [B, K_in, P_in+1, H, W]
x_caps = x.reshape(b, self.K_in, self.P_in + 1, h, w)
pose = x_caps[:, :, :self.P_in] # [B, K_in, P_in, H, W]
act = x_caps[:, :, self.P_in : self.P_in + 1].sigmoid() # [B, K_in, 1, H, W]
# votes: [B, K_in, K_out, H, W, P_out]
votes = torch.einsum('bkphw,kopq->bkohwq', pose, self.W_pose)
# logits/weights: [B, K_in, K_out, H, W]
logits = torch.einsum('bkphw,kop->bkohw', pose, self.W_gate) + self.b_gate
weights = logits.softmax(dim=2)
ar = weights * act # [B, K_in, K_out, H, W]
ar_sum = ar.sum(dim=1, keepdim=True) + self.eps
coeff = ar / ar_sum
pose_out = (coeff.unsqueeze(-1) * votes).sum(dim=1) # [B, K_out, H, W, P_out]
pose_out = pose_out.permute(0, 1, 4, 2, 3) # [B, K_out, P_out, H, W]
act_out = ar_sum.squeeze(1).unsqueeze(2) # [B, K_out, 1, H, W]
# Keep interleaved packed output: [pose(P_out), act(1)] per capsule type.
out = torch.cat([pose_out, act_out], dim=2).reshape(b, self.c_out, h, w)
return out
class HybridRoute1(nn.Module):
"""Conv-heavy replacement for SelfRouting with lightweight capsule-aware gating."""
def __init__(self, K_in: int, P_in: int, K_out: int, P_out: int):
super().__init__()
self.K_in = int(K_in)
self.P_in = int(P_in)
self.K_out = int(K_out)
self.P_out = int(P_out)
self.c_in = self.K_in * (self.P_in + 1)
self.c_out = self.K_out * (self.P_out + 1)
pose_in = self.K_in * self.P_in
pose_out = self.K_out * self.P_out
vote_groups = math.gcd(self.K_in, self.K_out)
vote_groups = max(int(vote_groups), 1)
self.vote_proj = Conv(pose_in, pose_out, 1, 1, g=vote_groups)
self.gate_proj = nn.Conv2d(self.c_in, self.K_out, kernel_size=1, stride=1, padding=0, bias=True)
self.act_proj = nn.Conv2d(self.K_in, self.K_out, kernel_size=1, stride=1, padding=0, bias=True)
def forward(self, x: torch.Tensor) -> torch.Tensor:
if x.ndim != 4:
raise TypeError(f'HybridRoute1 expects [B,C,H,W], got {tuple(x.shape)}')
b, c, h, w = x.shape
if c != self.c_in:
raise ValueError(f'HybridRoute1 expected C={self.c_in}, got C={c}')
x_caps = x.reshape(b, self.K_in, self.P_in + 1, h, w)
pose = x_caps[:, :, :self.P_in].reshape(b, self.K_in * self.P_in, h, w)
act = x_caps[:, :, self.P_in].contiguous()
pose_votes = self.vote_proj(pose).reshape(b, self.K_out, self.P_out, h, w)
gate = self.gate_proj(x).sigmoid().unsqueeze(2)
pose_out = pose_votes * gate
act_out = self.act_proj(act).sigmoid().unsqueeze(2)
out = torch.cat([pose_out, act_out], dim=2).reshape(b, self.c_out, h, w)
return out
class CapsRoute(nn.Module):
"""Capsule routing fusion by direct capsule concatenation.
Args:
K_in: list of input capsule type counts per source.
P_in: list of input pose dimensions per source.
K_out: target output capsule type count.
P_out: target output pose dimension.
kernel_size: grouped-conv kernel for ``ConvSelfRouting``.
Notes:
Inputs are concatenated directly (no pre-projection).
For direct packed concat, all ``P_in`` must be identical.
"""
def __init__(
self,
K_in: Union[List[int], Tuple[int, ...]],
P_in: Union[List[int], Tuple[int, ...]],
K_out: int,
P_out: int,
kernel_size: int = 3,
pre_k: int = 3,
post_k: int = 3,
pre_groups: Optional[int] = None,
post_groups: Optional[int] = None,
):
super().__init__()
self.K_in_list = [int(v) for v in K_in]
self.P_in_list = [int(v) for v in P_in]
if len(self.K_in_list) < 2 or len(self.K_in_list) != len(self.P_in_list):
raise ValueError('CapsRoute expects K_in/P_in lists with same length >= 2.')
if min(*self.K_in_list, *self.P_in_list) <= 0:
raise ValueError('CapsRoute expects positive K_in/P_in values.')
# Direct capsule concat requires a shared pose dimension.
if len(set(self.P_in_list)) != 1:
raise ValueError('CapsRoute direct concat requires all P_in to be identical.')
self.num_sources = len(self.K_in_list)
self.P_cat = int(self.P_in_list[0])
self.K_cat = int(sum(self.K_in_list))
self.c_cat = self.K_cat * (self.P_cat + 1)
self.K_out = int(K_out)
self.P_out = int(P_out)
if min(self.K_out, self.P_out) <= 0:
raise ValueError('CapsRoute expects positive K_out/P_out values.')
self.c_out = self.K_out * (self.P_out + 1)
# self.conv_route = ConvSelfRouting(
# K_in=self.K_cat,
# P_in=self.P_cat,
# K_out=self.K_cat,
# P_out=self.P_cat,
# kernel_size=kernel_size,
# )
# Grouped Conv before routing: C = K_cat * (P_cat + 1), groups = K_cat.
self.conv_route = Conv(self.c_cat, self.c_cat, 3, 1, g=self.K_cat)
self.route1 = SelfRouting(K_in=self.K_cat, P_in=self.P_cat, K_out=self.K_out, P_out=self.P_out)
# Grouped Conv after routing: C = K_out * (P_out + 1), groups = K_out.
self.spagg = Conv(self.c_out, self.c_out, 3, 1, g=self.K_out)
# self.route2 = SelfRouting(K_in=self.K_out, P_in=self.P_out, K_out=self.K_out, P_out=self.P_out)
def forward(self, xs: Union[List[torch.Tensor], Tuple[torch.Tensor, ...]]) -> torch.Tensor:
if not isinstance(xs, (list, tuple)):
raise TypeError(f'CapsRoute expects list/tuple inputs, got {type(xs)}')
if len(xs) != self.num_sources:
raise ValueError(f'CapsRoute expected {self.num_sources} sources, got {len(xs)}')
h, w = int(xs[0].shape[-2]), int(xs[0].shape[-1])
cat_parts = []
for i, x in enumerate(xs):
expected_c = self.K_in_list[i] * (self.P_in_list[i] + 1)
if int(x.shape[1]) != expected_c:
raise ValueError(f'CapsRoute source-{i} expected C={expected_c} from K_in/P_in, got C={int(x.shape[1])}')
if int(x.shape[-2]) != h or int(x.shape[-1]) != w:
raise ValueError('CapsRoute inputs must share H,W. Use CapsAlign before routing.')
cat_parts.append(x)
x_cat = torch.cat(cat_parts, dim=1) # [B, K_cat*(P+1), H, W]
routed = self.route1(self.conv_route(x_cat))
routed = self.spagg(routed)
return routed
class CapsRoutev2(CapsRoute):
"""CapsRoute with per-capsule pose refinement and act residual update."""
def __init__(
self,
K_in: Union[List[int], Tuple[int, ...]],
P_in: Union[List[int], Tuple[int, ...]],
K_out: int,
P_out: int,
kernel_size: int = 3,
pre_k: int = 3,
post_k: int = 3,
pre_groups: Optional[int] = None,
post_groups: Optional[int] = None,
):
super().__init__(K_in, P_in, K_out, P_out, kernel_size, pre_k, post_k, pre_groups, post_groups)
_ = (post_k, post_groups, pre_k, pre_groups) # kept for YAML/API compatibility
self.profile_route = False
self._route_profile = {
'cat_ms': 0.0,
'conv_route_ms': 0.0,
'route1_ms': 0.0,
'pose_refine_ms': 0.0,
'act_from_pose_ms': 0.0,
'pack_ms': 0.0,
'calls': 0.0,
}
deep_stage = self.K_out >= 64
pose_ch = self.K_out * self.P_out
# Match YOLO26 neck style:
# - shallow/mid stages: C3k2(n=2, c3k=True, attn=False)
# - deep stage: C3k2(n=1, c3k=True, attn=True)
pose_e = 0.5 if (self.P_out % 2 == 0) else 1.0
self.pose_refine = C3k2(
pose_ch,
pose_ch,
n=1 if deep_stage else 2,
c3k=True,
e=pose_e,
attn=deep_stage,
g=self.K_out,
shortcut=True,
)
self.act_from_pose = Conv(pose_ch, self.K_out, 1, 1, g=self.K_out)
self.act_alpha = nn.Parameter(torch.tensor(0.1))
@staticmethod
def _sync_profile() -> None:
if torch.cuda.is_available():
torch.cuda.synchronize()
def _ensure_route_profile_state(self) -> None:
if not hasattr(self, "profile_route"):
self.profile_route = False
if not hasattr(self, "_route_profile"):
self._route_profile = {
'cat_ms': 0.0,
'conv_route_ms': 0.0,
'route1_ms': 0.0,
'pose_refine_ms': 0.0,
'act_from_pose_ms': 0.0,
'pack_ms': 0.0,
'calls': 0.0,
}
def reset_route_profile(self) -> None:
self._ensure_route_profile_state()
for k in self._route_profile:
self._route_profile[k] = 0.0
def get_route_profile(self) -> dict:
self._ensure_route_profile_state()
calls = max(float(self._route_profile.get('calls', 0.0)), 1.0)
total = (
self._route_profile['cat_ms']
+ self._route_profile['conv_route_ms']
+ self._route_profile['route1_ms']
+ self._route_profile['pose_refine_ms']
+ self._route_profile['act_from_pose_ms']
+ self._route_profile['pack_ms']
)
out = dict(self._route_profile)
out['total_ms'] = total
out['cat_avg_ms'] = self._route_profile['cat_ms'] / calls
out['conv_route_avg_ms'] = self._route_profile['conv_route_ms'] / calls
out['route1_avg_ms'] = self._route_profile['route1_ms'] / calls
out['pose_refine_avg_ms'] = self._route_profile['pose_refine_ms'] / calls
out['act_from_pose_avg_ms'] = self._route_profile['act_from_pose_ms'] / calls
out['pack_avg_ms'] = self._route_profile['pack_ms'] / calls
out['total_avg_ms'] = total / calls
return out
def forward(self, xs: Union[List[torch.Tensor], Tuple[torch.Tensor, ...]]) -> torch.Tensor:
if not isinstance(xs, (list, tuple)):
raise TypeError(f'CapsRoutev2 expects list/tuple inputs, got {type(xs)}')
if len(xs) != self.num_sources:
raise ValueError(f'CapsRoutev2 expected {self.num_sources} sources, got {len(xs)}')
h, w = int(xs[0].shape[-2]), int(xs[0].shape[-1])
cat_parts = []
for i, x in enumerate(xs):
expected_c = self.K_in_list[i] * (self.P_in_list[i] + 1)
if int(x.shape[1]) != expected_c:
raise ValueError(f'CapsRoutev2 source-{i} expected C={expected_c}, got C={int(x.shape[1])}')
if int(x.shape[-2]) != h or int(x.shape[-1]) != w:
raise ValueError('CapsRoutev2 inputs must share H,W. Use CapsAlign before routing.')
cat_parts.append(x)
self._ensure_route_profile_state()
if getattr(self, "profile_route", False):
self._route_profile['calls'] += 1.0
self._sync_profile()
t0 = time.perf_counter()
x_cat = torch.cat(cat_parts, dim=1) # [B, K_cat*(P+1), H, W]
self._sync_profile()
self._route_profile['cat_ms'] += (time.perf_counter() - t0) * 1000.0
t0 = time.perf_counter()
conv_out = self.conv_route(x_cat)
self._sync_profile()
self._route_profile['conv_route_ms'] += (time.perf_counter() - t0) * 1000.0
t0 = time.perf_counter()
routed = self.route1(conv_out) # [B, K_out*(P_out+1), H, W]
self._sync_profile()
self._route_profile['route1_ms'] += (time.perf_counter() - t0) * 1000.0
else:
x_cat = torch.cat(cat_parts, dim=1) # [B, K_cat*(P+1), H, W]
routed = self.route1(self.conv_route(x_cat)) # [B, K_out*(P_out+1), H, W]
b, _, _, _ = routed.shape
# Packed layout by type: [pose(P), act(1)] repeated K times.
caps = routed.reshape(b, self.K_out, self.P_out + 1, h, w)
pose = caps[:, :, :self.P_out].contiguous() # [B, K_out, P_out, H, W]
act = caps[:, :, self.P_out].contiguous() # [B, K_out, H, W]
# Grouped pose refinement across type blocks (equivalent to per-type grouped processing).
pose_flat = pose.reshape(b, self.K_out * self.P_out, h, w)
if getattr(self, "profile_route", False):
t0 = time.perf_counter()
pose_flat = self.pose_refine(pose_flat)
self._sync_profile()
self._route_profile['pose_refine_ms'] += (time.perf_counter() - t0) * 1000.0
t0 = time.perf_counter()
act_delta = self.act_from_pose(pose_flat)
act_final = act + act_delta
self._sync_profile()
self._route_profile['act_from_pose_ms'] += (time.perf_counter() - t0) * 1000.0
else:
pose_flat = self.pose_refine(pose_flat)
act_delta = self.act_from_pose(pose_flat)
act_final = act + act_delta
if getattr(self, "profile_route", False):
t0 = time.perf_counter()
pose_pack = pose_flat.reshape(b, self.K_out, self.P_out, h, w)
out = torch.cat([pose_pack, act_final.unsqueeze(2)], dim=2).reshape(b, self.c_out, h, w)
self._sync_profile()
self._route_profile['pack_ms'] += (time.perf_counter() - t0) * 1000.0
else:
pose_pack = pose_flat.reshape(b, self.K_out, self.P_out, h, w)
out = torch.cat([pose_pack, act_final.unsqueeze(2)], dim=2).reshape(b, self.c_out, h, w)
return out
# -------------------------
# 4) CapsDecode
# -------------------------
class CapsRoutev3(CapsRoute):
"""CapsRoute with DS-style lightweight pose refinement and act residual update."""
def __init__(
self,
K_in: Union[List[int], Tuple[int, ...]],
P_in: Union[List[int], Tuple[int, ...]],
K_out: int,
P_out: int,
kernel_size: int = 3,
pre_k: int = 3,
post_k: int = 3,
pre_groups: Optional[int] = None,
post_groups: Optional[int] = None,
):
super().__init__(K_in, P_in, K_out, P_out, kernel_size, pre_k, post_k, pre_groups, post_groups)
_ = (post_k, post_groups, pre_k, pre_groups)
self.profile_route = False
self._route_profile = {
'cat_ms': 0.0,
'conv_route_ms': 0.0,
'route1_ms': 0.0,
'pose_refine_ms': 0.0,
'act_from_pose_ms': 0.0,
'pack_ms': 0.0,
'calls': 0.0,
}
pose_ch = self.K_out * self.P_out
# Keep refinement fully type-grouped to preserve capsule semantics:
# each capsule type only mixes its own pose channels.
self.pose_refine = nn.Sequential(
Conv(pose_ch, pose_ch, 1, 1, g=self.K_out),
Conv(pose_ch, pose_ch, 3, 1, g=self.K_out),
Conv(pose_ch, pose_ch, 1, 1, g=self.K_out),
)
self.act_from_pose = Conv(pose_ch, self.K_out, 1, 1, g=self.K_out)
self.act_alpha = nn.Parameter(torch.tensor(0.1))
@staticmethod
def _sync_profile() -> None:
if torch.cuda.is_available():
torch.cuda.synchronize()
def _ensure_route_profile_state(self) -> None:
if not hasattr(self, "profile_route"):
self.profile_route = False
if not hasattr(self, "_route_profile"):
self._route_profile = {
'cat_ms': 0.0,
'conv_route_ms': 0.0,
'route1_ms': 0.0,
'pose_refine_ms': 0.0,
'act_from_pose_ms': 0.0,
'pack_ms': 0.0,
'calls': 0.0,
}
def reset_route_profile(self) -> None:
self._ensure_route_profile_state()
for k in self._route_profile:
self._route_profile[k] = 0.0
def get_route_profile(self) -> dict:
self._ensure_route_profile_state()
calls = max(float(self._route_profile.get('calls', 0.0)), 1.0)
total = (
self._route_profile['cat_ms']
+ self._route_profile['conv_route_ms']
+ self._route_profile['route1_ms']
+ self._route_profile['pose_refine_ms']
+ self._route_profile['act_from_pose_ms']
+ self._route_profile['pack_ms']
)
out = dict(self._route_profile)
out['total_ms'] = total
out['cat_avg_ms'] = self._route_profile['cat_ms'] / calls
out['conv_route_avg_ms'] = self._route_profile['conv_route_ms'] / calls
out['route1_avg_ms'] = self._route_profile['route1_ms'] / calls
out['pose_refine_avg_ms'] = self._route_profile['pose_refine_ms'] / calls
out['act_from_pose_avg_ms'] = self._route_profile['act_from_pose_ms'] / calls
out['pack_avg_ms'] = self._route_profile['pack_ms'] / calls
out['total_avg_ms'] = total / calls
return out
def forward(self, xs: Union[List[torch.Tensor], Tuple[torch.Tensor, ...]]) -> torch.Tensor:
if not isinstance(xs, (list, tuple)):
raise TypeError(f'CapsRoutev3 expects list/tuple inputs, got {type(xs)}')
if len(xs) != self.num_sources:
raise ValueError(f'CapsRoutev3 expected {self.num_sources} sources, got {len(xs)}')
h, w = int(xs[0].shape[-2]), int(xs[0].shape[-1])
cat_parts = []
for i, x in enumerate(xs):
expected_c = self.K_in_list[i] * (self.P_in_list[i] + 1)
if int(x.shape[1]) != expected_c:
raise ValueError(f'CapsRoutev3 source-{i} expected C={expected_c}, got C={int(x.shape[1])}')
if int(x.shape[-2]) != h or int(x.shape[-1]) != w:
raise ValueError('CapsRoutev3 inputs must share H,W. Use CapsAlign before routing.')
cat_parts.append(x)
self._ensure_route_profile_state()
if getattr(self, "profile_route", False):
self._route_profile['calls'] += 1.0
self._sync_profile()
t0 = time.perf_counter()
x_cat = torch.cat(cat_parts, dim=1)
self._sync_profile()
self._route_profile['cat_ms'] += (time.perf_counter() - t0) * 1000.0
t0 = time.perf_counter()
conv_out = self.conv_route(x_cat)
self._sync_profile()
self._route_profile['conv_route_ms'] += (time.perf_counter() - t0) * 1000.0
t0 = time.perf_counter()
routed = self.route1(conv_out)
self._sync_profile()
self._route_profile['route1_ms'] += (time.perf_counter() - t0) * 1000.0
else:
x_cat = torch.cat(cat_parts, dim=1)
routed = self.route1(self.conv_route(x_cat))
b, _, _, _ = routed.shape
caps = routed.reshape(b, self.K_out, self.P_out + 1, h, w)
pose = caps[:, :, :self.P_out].contiguous()
act = caps[:, :, self.P_out].contiguous()
pose_flat = pose.reshape(b, self.K_out * self.P_out, h, w)
if getattr(self, "profile_route", False):
t0 = time.perf_counter()
pose_flat = pose_flat + self.pose_refine(pose_flat)
self._sync_profile()
self._route_profile['pose_refine_ms'] += (time.perf_counter() - t0) * 1000.0
t0 = time.perf_counter()
act_delta = self.act_from_pose(pose_flat)
act_final = act + act_delta
self._sync_profile()
self._route_profile['act_from_pose_ms'] += (time.perf_counter() - t0) * 1000.0
else:
pose_flat = pose_flat + self.pose_refine(pose_flat)
act_delta = self.act_from_pose(pose_flat)
act_final = act + act_delta
if getattr(self, "profile_route", False):
t0 = time.perf_counter()
pose_pack = pose_flat.reshape(b, self.K_out, self.P_out, h, w)
out = torch.cat([pose_pack, act_final.unsqueeze(2)], dim=2).reshape(b, self.c_out, h, w)
self._sync_profile()
self._route_profile['pack_ms'] += (time.perf_counter() - t0) * 1000.0
else:
pose_pack = pose_flat.reshape(b, self.K_out, self.P_out, h, w)
out = torch.cat([pose_pack, act_final.unsqueeze(2)], dim=2).reshape(b, self.c_out, h, w)
return out
class CapsRoutev4(CapsRoutev2):
"""CapsRoutev2 with conv-heavy HybridRoute1 to reduce routing overhead."""
def __init__(
self,
K_in: Union[List[int], Tuple[int, ...]],
P_in: Union[List[int], Tuple[int, ...]],
K_out: int,
P_out: int,
kernel_size: int = 3,
pre_k: int = 3,
post_k: int = 3,
pre_groups: Optional[int] = None,
post_groups: Optional[int] = None,
):
super().__init__(K_in, P_in, K_out, P_out, kernel_size, pre_k, post_k, pre_groups, post_groups)
self.route1 = HybridRoute1(K_in=self.K_cat, P_in=self.P_cat, K_out=self.K_out, P_out=self.P_out)
class CapsDecode(nn.Module):
"""
Decode routed capsule features to standard feature map for Detect.
Input: y [B, C_in, H, W] (often concat of weighted sources, so C_in = S*(K*D))
Output: f [B, C_out, H, W]
Args:
c2: output channels (e.g., 256/512/1024)
"""
def __init__(self, c1: int, c2: int):
super().__init__()
self.conv = nn.Conv2d(c1, c2, kernel_size=1, stride=1, padding=0, bias=False)
self.bn = nn.BatchNorm2d(c2)
self.act = nn.SiLU(inplace=True)
def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.act(self.bn(self.conv(x)))
# -------------------------
# 5) CapsuleTap
# -------------------------
class CapsuleTap(nn.Module):
"""
Pass-through hook to cache feature maps for explainability/aux loss.
MUST NOT change tensor shape. Returns x unchanged.
Args:
tag: string identifier ("F3"/"F4"/"F5")
K,D: capsule hyperparams (metadata only)
cache_enabled: if True, cache during training (disabled in tracing/scripting)
"""
def __init__(self, tag: str = "F", K: int = 4, D: int = 16, cache_enabled: bool = True):
super().__init__()
self.tag = str(tag)
self.K = int(K)
self.D = int(D)
self.cache_enabled = bool(cache_enabled)
self.last_x: Optional[torch.Tensor] = None
def clear_cache(self) -> None:
self.last_x = None
def forward(self, x: torch.Tensor) -> torch.Tensor:
if (
self.cache_enabled
and self.training
and (not torch.jit.is_scripting())
and (not torch.jit.is_tracing())
):
self.last_x = x.detach()
return x
|