Skip to main content

SamRunner

Struct SamRunner 

Source
pub struct SamRunner {
    pub arch: SamArch,
    pub weights: PathBuf,
    pub device: Device,
    pub config_path: Option<PathBuf>,
}
Expand description

SAM runner — owns the resolved config and dispatches the per-arch forward pass. SAM 1 / 2 / 3 differ enough in their prompting that we keep the heavy result type (SamPredictionAny) as a discriminated union the caller matches on.

Fields§

§arch: SamArch§weights: PathBuf§device: Device§config_path: Option<PathBuf>

Implementations§

Source§

impl SamRunner

Source

pub fn builder(arch: SamArch) -> SamRunnerBuilder

Source

pub fn summary(&self) -> String

Print a human-readable summary — what the CLI prints before any per-arch image processing.

Source

pub fn predict_image( &self, rgb: &[u8], h_in: usize, w_in: usize, points: Option<(&[f32], &[f32])>, boxes: Option<&[f32]>, text_tokens: &[u32], ) -> Result<SamPredictionAny>

End-to-end forward: image bytes → masks. Dispatches to the right per-arch entrypoint:

  • SAM 1 → Sam::forward (multimask = true)
  • SAM 2 → Sam2::predict_image (multimask = true)
  • SAM 3 → Sam3::predict_image_text with the supplied text_tokens (required for SAM 3 — its decoder is text-conditioned). Pass an empty slice for arches that don’t use it.

rgb is HWC u8; points is (xy_pairs, labels) with one label per (x, y) pair (1 = foreground, 0 = background).

SAM-arch-specific defaults applied:

  • cfg derived from environment variables (RLX_SAM_VARIANT for v1: vit_b/l/h; RLX_SAM2_VARIANT for v2: tiny/small/ base_plus/large); falls back to the smallest variant.
  • multimask_output = true for v1 + v2.
  • SAM 3 vit defaults to base.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V