Skip to main content

ComplEx

Struct ComplEx 

Source
pub struct ComplEx {
    pub entity_re: Vec<Vec<f64>>,
    pub entity_im: Vec<Vec<f64>>,
    pub relation_re: Vec<Vec<f64>>,
    pub relation_im: Vec<Vec<f64>>,
    pub dim: usize,
}
Expand description

ComplEx knowledge graph embedding model.

Entities and relations are embedded in complex vector space ℂ^d. Each embedding is stored as two real vectors (real and imaginary parts).

Score: Re( Σ_k h_k · r_k · conj(t_k) ) = Σ_k ( Re(h)·Re(r)·Re(t) + Im(h)·Re(r)·Im(t) + Re(h)·Im(r)·Im(t) - Im(h)·Im(r)·Re(t) )

Fields§

§entity_re: Vec<Vec<f64>>

Real part of entity embeddings [n_entities, dim]

§entity_im: Vec<Vec<f64>>

Imaginary part of entity embeddings [n_entities, dim]

§relation_re: Vec<Vec<f64>>

Real part of relation embeddings [n_relations, dim]

§relation_im: Vec<Vec<f64>>

Imaginary part of relation embeddings [n_relations, dim]

§dim: usize

Embedding dimension (complex components per embedding)

Implementations§

Source§

impl ComplEx

Source

pub fn new(n_entities: usize, n_relations: usize, dim: usize) -> Result<Self>

Create a ComplEx model with random initialisation.

Source

pub fn score(&self, h: usize, r: usize, t: usize) -> Result<f64>

Score triple (h, r, t) using the ComplEx scoring function.

Link prediction score.

Source

pub fn predict_tails(&self, h: usize, r: usize, k: usize) -> Result<Vec<usize>>

Return the top-k entity indices most likely to complete (h, r, ?).

Source

pub fn train_epoch(&mut self, dataset: &KGDataset, lr: f64, margin: f64) -> f64

Train one epoch with margin-based negative sampling.

Trait Implementations§

Source§

impl Clone for ComplEx

Source§

fn clone(&self) -> ComplEx

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 ComplEx

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> 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