Struct EmbeddingTable 

pub struct EmbeddingTable {
    pub model: ScoreModel,
    pub rank: usize,
    pub ent_dim: usize,
    pub rel_dim: usize,
    pub n_entities: usize,
    pub n_relations: usize,
    pub entities: Vec<f64>,
    pub relations: Vec<f64>,
}

A trained (or freshly-initialised) embedding table: one vector per entity and one per relation. The storage length per entity/relation is fixed by the model and the rank k (see ScoreModel::dims).

Fields

model: ScoreModel

rank: usize

Rank (the conceptual embedding dimension). Storage may be k or 2k per vector depending on the model.

ent_dim: usize

rel_dim: usize

n_entities: usize

n_relations: usize

entities: Vec<f64>

n_entities * ent_dim, row-major.

relations: Vec<f64>

n_relations * rel_dim, row-major.

Implementations

impl EmbeddingTable

pub fn zeros( model: ScoreModel, k: usize, n_entities: usize, n_relations: usize, ) -> Result<Self, KgEmbeddingError>

Allocate a zeroed table sized for model at rank k.

pub fn entity(&self, i: usize) -> Result<&[f64], KgEmbeddingError>

pub fn relation(&self, i: usize) -> Result<&[f64], KgEmbeddingError>

pub fn entity_mut(&mut self, i: usize) -> &mut [f64]

pub fn relation_mut(&mut self, i: usize) -> &mut [f64]

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

Plausibility score for triple (h, r, t) (entity/relation indices). Higher = more plausible. Fails closed on out-of-range indices.

Trait Implementations

impl Clone for EmbeddingTable

fn clone(&self) -> EmbeddingTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingTable

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

Formats the value using the given formatter.

impl PartialEq for EmbeddingTable

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for EmbeddingTable