Skip to main content

BoxEmbedding

Struct BoxEmbedding 

Source
pub struct BoxEmbedding {
    pub min: Vec<f32>,
    pub max: Vec<f32>,
    pub temperature: Option<f32>,
}
Expand description

Box embedding for geometric coreference resolution.

Uses axis-aligned hyperrectangles to encode logical invariants. This is based on research showing that box embeddings can capture containment relationships better than vector embeddings.

§Status: Experimental

This type may change significantly. The current representation uses serde_json::Value as a placeholder; a proper typed representation will be added once the embedding format stabilizes.

§References

  • Vilnis et al., “Probabilistic Embedding of Knowledge Graphs with Box Lattice Measures”
  • Dasgupta et al., “Improving Local Identifiability in Probabilistic Box Embeddings”

Fields§

§min: Vec<f32>

Minimum corner of the box (lower bounds).

§max: Vec<f32>

Maximum corner of the box (upper bounds).

§temperature: Option<f32>

Temperature parameter for softbox formulation.

Implementations§

Source§

impl BoxEmbedding

Source

pub fn new(min: Vec<f32>, max: Vec<f32>) -> Self

Create a new box embedding.

Source

pub fn dim(&self) -> usize

Get the dimensionality of the box.

Source

pub fn is_valid(&self) -> bool

Check if this box is valid (min <= max in all dimensions).

Source

pub fn volume(&self) -> f32

Compute the volume of the box (product of side lengths).

Source

pub fn contains_point(&self, point: &[f32]) -> bool

Check if this box contains a point.

Source

pub fn contains_box(&self, other: &BoxEmbedding) -> bool

Check if this box contains another box.

Source

pub fn intersection_volume(&self, other: &BoxEmbedding) -> f32

Compute intersection volume with another box.

Source

pub fn from_json(value: &Value) -> Option<Self>

Convert from a JSON value (for backwards compatibility with existing data).

Source

pub fn to_json(&self) -> Value

Convert to a JSON value (for backwards compatibility).

Trait Implementations§

Source§

impl Clone for BoxEmbedding

Source§

fn clone(&self) -> BoxEmbedding

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 BoxEmbedding

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BoxEmbedding

Source§

fn default() -> BoxEmbedding

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BoxEmbedding

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for BoxEmbedding

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for BoxEmbedding

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BoxEmbedding

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,