pub struct RotatEPlus {
pub entity_phase: Vec<Vec<f32>>,
pub relation_phase: Vec<Vec<f32>>,
pub dim: usize,
}Expand description
RotatE+ with phase-space operations.
Entities and relations are represented as phase vectors in [0, 2π). The scoring function computes the L1 distance in phase space after applying the relational rotation: score = -||h ∘ r - t||_1.
Fields§
§entity_phase: Vec<Vec<f32>>Entity phase embeddings: [num_entities][dim], values in [0, 2π)
relation_phase: Vec<Vec<f32>>Relation phase embeddings: [num_relations][dim], values in [0, 2π)
dim: usizeEmbedding dimension
Implementations§
Source§impl RotatEPlus
impl RotatEPlus
Sourcepub fn new(num_entities: usize, num_relations: usize, dim: usize) -> Self
pub fn new(num_entities: usize, num_relations: usize, dim: usize) -> Self
Create a new RotatE+ model with random phase initialization.
Sourcepub fn score(&self, head: usize, relation: usize, tail: usize) -> f32
pub fn score(&self, head: usize, relation: usize, tail: usize) -> f32
Compute score = -||h ∘ r - t||_1 where ∘ is element-wise phase addition mod 2π.
Sourcepub fn update(
&mut self,
head: usize,
relation: usize,
tail: usize,
pos_score: f32,
neg_score: f32,
lr: f32,
)
pub fn update( &mut self, head: usize, relation: usize, tail: usize, pos_score: f32, neg_score: f32, lr: f32, )
Update embeddings via margin-based gradient step.
pos_score and neg_score are output from score().
We push pos_score higher and neg_score lower.
Sourcepub fn entity_count(&self) -> usize
pub fn entity_count(&self) -> usize
Number of entities
Sourcepub fn relation_count(&self) -> usize
pub fn relation_count(&self) -> usize
Number of relations
Trait Implementations§
Source§impl Clone for RotatEPlus
impl Clone for RotatEPlus
Source§fn clone(&self) -> RotatEPlus
fn clone(&self) -> RotatEPlus
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for RotatEPlus
impl RefUnwindSafe for RotatEPlus
impl Send for RotatEPlus
impl Sync for RotatEPlus
impl Unpin for RotatEPlus
impl UnsafeUnpin for RotatEPlus
impl UnwindSafe for RotatEPlus
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.