Enum Nms 

#[repr(u32)]
pub enum Nms {
    Auto = 1,
    ClassAware = 2,
    ClassAgnostic = 3,
}

NMS (Non-Maximum Suppression) mode for filtering overlapping detections.

This enum is used with Option<Nms>:

• Some(Nms::Auto) — resolve from config or fall back to ClassAware
• Some(Nms::ClassAgnostic) — class-agnostic NMS: suppress overlapping boxes regardless of class label
• Some(Nms::ClassAware) — class-aware NMS: only suppress boxes that share the same class label AND overlap above the IoU threshold
• None — bypass NMS entirely (for end-to-end models with embedded NMS)

The code is the one the C EF_NMS_* enumerators and the Python Nms enum use. Code 0 is reserved for None (NMS off), which has no variant here; see NMS_OFF_CODE.

Variants

Auto = 1

Let the builder resolve NMS mode from the model config (e.g. edgefirst.json). Falls back to Nms::ClassAware when no config specifies a mode. This is the builder default — callers should only use an explicit variant when they need to override the config.

ClassAware = 2

Only suppress boxes with the same class label that overlap (default concrete behavior; matches trainer and COCO evaluation).

ClassAgnostic = 3

Suppress overlapping boxes regardless of class label.

Implementations

impl Nms

pub const fn code(self) -> u32

The shared code for this variant. Identical on every surface.

const, deliberately: a downstream binding that cannot write Variant = OtherEnum::Variant.code() in a #[pyclass] discriminant position (PyO3 requires a literal there) can still pin that literal to this value with a const _: () = assert!(...) – a build-time check instead of a hand-synced comment. See PyTensorMemory/PyPixelFormat in crates/python-common/src/tensor.rs for the consumer.

pub fn from_code(code: u32) -> Option<Self>

Reject an unknown code rather than guessing at one.

pub fn as_str(self) -> &'static str

The wire string form – stable, unlike Debug.

pub fn from_str_code(s: &str) -> Option<Self>

Reject an unknown string rather than guessing at one.

pub fn all() -> &'static [Self]

Every variant, for exhaustive cross-surface tests.

impl Nms

pub const fn option_code(nms: Option<Nms>) -> u32

The code for an optional mode, None (NMS off) included.

pub fn from_option_code(code: u32) -> Option<Option<Nms>>

Decode an optional mode, NMS_OFF_CODE included. The outer None is an unknown code; Some(None) is NMS off.

Trait Implementations

impl Clone for Nms

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Nms

impl Debug for Nms

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Nms

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Nms

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Nms

impl Hash for Nms

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Nms

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Nms

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Nms