Skip to content

types

Shared type aliases, TypedDict definitions, and enums used across the package.

Classes:

  • Boxes3D –

    Packed 3D boxes with class and scene indices (e.g. detection ground truth, PyG batch layout).

  • Detection3D –

    Packed 3D detections: Boxes3D plus a per-box confidence score (a model's decode output).

  • MessagePassingParams –

    Keyword arguments a message-passing layer forwards to its MessagePassing base class.

  • StrEnum –

    Enum whose members are plain strings, so they compare, print and hash like their value.

Boxes3D

Bases: TypedDict

Packed 3D boxes with class and scene indices (e.g. detection ground truth, PyG batch layout).

Attributes:

  • boxes (Tensor) –

    Boxes \((N, 7)\) of \((c_x, c_y, c_z, d_x, d_y, d_z, \theta)\).

  • labels (Tensor) –

    Per-box class, shape \((N,)\).

  • batch (Tensor) –

    Per-box scene index, shape \((N,)\).

  • ignore_mask (NotRequired[Tensor]) –

    Per-box ignore mask, shape \((N,)\).

Detection3D

Bases: Boxes3D

Packed 3D detections: Boxes3D plus a per-box confidence score (a model's decode output).

Attributes:

  • boxes (Tensor) –

    Boxes \((N, 7)\) of \((c_x, c_y, c_z, d_x, d_y, d_z, \theta)\).

  • labels (Tensor) –

    Per-box class, shape \((N,)\).

  • batch (Tensor) –

    Per-box scene index, shape \((N,)\).

  • ignore_mask (NotRequired[Tensor]) –

    Per-box ignore mask, shape \((N,)\).

  • scores (Tensor) –

    Per-box confidence score, shape \((N,)\).

  • class_probs (NotRequired[Tensor]) –

    Per-box class probabilities, shape \((N, C)\), emitted by detectors whose eval protocol expands every kept box across all classes (e.g. VoteNet / 3DETR).

  • velocity (NotRequired[Tensor]) –

    Per-box BEV velocity \((v_x, v_y)\), shape \((N, 2)\), emitted by detectors whose head regresses velocity (the nuScenes heads).

MessagePassingParams

Bases: TypedDict

Keyword arguments a message-passing layer forwards to its MessagePassing base class.

StrEnum

Bases: str, Enum

Enum whose members are plain strings, so they compare, print and hash like their value.