Skip to main content

KGDataset

Struct KGDataset 

Source
pub struct KGDataset {
    pub triples: Vec<(usize, usize, usize)>,
    pub n_entities: usize,
    pub n_relations: usize,
    pub entity_labels: Vec<String>,
    pub relation_labels: Vec<String>,
}
Expand description

A collection of (head, relation, tail) triples for a knowledge graph.

Entities and relations are referenced by their integer indices. Use KGDataset::from_str_triples to build a dataset from string labels automatically.

Fields§

§triples: Vec<(usize, usize, usize)>

All triples as (head_idx, rel_idx, tail_idx)

§n_entities: usize

Number of distinct entities

§n_relations: usize

Number of distinct relation types

§entity_labels: Vec<String>

Entity index → string label

§relation_labels: Vec<String>

Relation index → string label

Implementations§

Source§

impl KGDataset

Source

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

Build a KGDataset from raw integer triples.

§Arguments
  • triples – Vec of (head, relation, tail) triples.
  • n_entities – Total number of entities (must exceed all indices).
  • n_relations – Total number of relation types.
Source

pub fn from_str_triples(triples: &[(&str, &str, &str)]) -> Self

Build a dataset from string-labeled triples.

Entity and relation vocabularies are inferred from the data in the order they are first encountered.

Source

pub fn len(&self) -> usize

Return the number of triples.

Source

pub fn is_empty(&self) -> bool

Return true if the dataset contains no triples.

Source

pub fn corrupt_triple( &self, triple: (usize, usize, usize), ) -> (usize, usize, usize)

Randomly corrupt one triple by replacing either the head or the tail with a uniformly sampled entity (excluding the original).

Trait Implementations§

Source§

impl Clone for KGDataset

Source§

fn clone(&self) -> KGDataset

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 KGDataset

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