Skip to main content

SparseMap

pub struct SparseMap { /* private fields */ }
Expand description

A SparseMap layer: structured prediction with sparse marginals.

Solves the QP:

max θᵀμ - ½ μᵀ μ s.t. μ ∈ M

where M is the marginal polytope (e.g., the simplex for unstructured classification). The solution is a sparse probability distribution.

The backward pass uses the KKT conditions of the QP.

Implementations§

Source§

impl SparseMap

Source

pub fn new(a_marginal: Vec<Vec<f64>>, b_marginal: Vec<f64>) -> Self

Create a new SparseMap layer for a given marginal polytope.

§Arguments
  • a_marginal – equality constraints defining the polytope (Ax = b, x ≥ 0).
  • b_marginal – equality rhs.
Source

pub fn simplex(n: usize) -> Self

Create a SparseMap for the simplex: Σ μ_i = 1, μ_i ≥ 0.

Source

pub fn with_config( a_marginal: Vec<Vec<f64>>, b_marginal: Vec<f64>, config: SparseMapConfig, ) -> Self

Create a SparseMap with custom configuration.

Source

pub fn forward(&mut self, theta: &[f64]) -> OptimizeResult<Vec<f64>>

Forward pass: solve the QP on the marginal polytope.

μ* = argmax_{μ ∈ M} θᵀμ - ½ ||μ||² = argmin_{μ ∈ M} ½ ||μ - θ||² = Π_M(θ) (Euclidean projection onto M)

Uses iterative projected gradient on the Lagrangian.

§Arguments
  • theta – score vector (length n).
Source

pub fn backward(&self, dl_dmu: &[f64]) -> OptimizeResult<Vec<f64>>

Backward pass: compute dL/dθ via KKT sensitivity.

At the optimal μ*, the KKT conditions of the QP are:

μ* - θ + Aᵀν* + s = 0 (stationarity, s = -min(μ*, 0)) Aμ* = b (equality) μ* ≥ 0, s ≥ 0, s⊙μ* = 0 (complementarity)

For the active variables (μ*_i > 0), we have s_i = 0, and the KKT system reduces to an equality system on the support.

§Arguments
  • dl_dmu – upstream gradient dL/dμ (length n).
Source

pub fn project_simplex(v: &[f64]) -> Vec<f64>

Project a vector onto the probability simplex.

Solves: argmin_{μ ≥ 0, Σμ = 1} ||μ - v||²

Uses the O(n log n) sorting algorithm.

Trait Implementations§

Source§

impl Clone for SparseMap

Source§

fn clone(&self) -> SparseMap

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SparseMap

Source§

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

Formats the value using the given formatter. Read more

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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

Source§

impl<T> Ungil for T
where T: Send,