Struct rust2vec::embeddings::Embeddings

pub struct Embeddings<V, S> { /* fields omitted */ }

Deprecated:

rust2vec is superseded by the finalfusion crate

Word embeddings.

This data structure stores word embeddings (also known as word vectors) and provides some useful methods on the embeddings, such as similarity and analogy queries.

Methods

impl<V, S> Embeddings<V, S>

pub fn new(metadata: Option<Metadata>, vocab: V, storage: S) -> Self

Deprecated:

rust2vec is superseded by the finalfusion crate

Construct an embeddings from a vocabulary and storage.

pub fn into_parts(self) -> (Option<Metadata>, V, S)

Deprecated:

rust2vec is superseded by the finalfusion crate

Decompose embeddings in its vocabulary and storage.

pub fn metadata(&self) -> Option<&Metadata>

Deprecated:

rust2vec is superseded by the finalfusion crate

Get metadata.

pub fn metadata_mut(&mut self) -> Option<&mut Metadata>

Deprecated:

rust2vec is superseded by the finalfusion crate

Get metadata mutably.

pub fn set_metadata(&mut self, metadata: Option<Metadata>) -> Option<Metadata>

Deprecated:

rust2vec is superseded by the finalfusion crate

Set metadata.

Returns the previously-stored metadata.

pub fn storage(&self) -> &S

Deprecated:

rust2vec is superseded by the finalfusion crate

Get the embedding storage.

pub fn vocab(&self) -> &V

Deprecated:

rust2vec is superseded by the finalfusion crate

Get the vocabulary.

impl<V, S> Embeddings<V, S> where
    V: Vocab,
    S: Storage, 

pub fn dims(&self) -> usize

Deprecated:

rust2vec is superseded by the finalfusion crate

Return the length (in vector components) of the word embeddings.

pub fn embedding(&self, word: &str) -> Option<CowArray1<f32>>

Deprecated:

rust2vec is superseded by the finalfusion crate

Get the embedding of a word.

Important traits for Iter<'a>

impl<'a> Iterator for Iter<'a> type Item = (&'a str, CowArray1<'a, f32>);

pub fn iter(&self) -> Iter

Deprecated:

rust2vec is superseded by the finalfusion crate

Get an iterator over pairs of words and the corresponding embeddings.

pub fn len(&self) -> usize

Deprecated:

rust2vec is superseded by the finalfusion crate

Get the vocabulary size.

The vocabulary size excludes subword units.

Trait Implementations

impl<V, S> ReadEmbeddings for Embeddings<V, S> where
    V: ReadChunk,
    S: ReadChunk, 

fn read_embeddings<R>(read: &mut R) -> Result<Self, Error> where
    R: Read + Seek, 

Read the embeddings.

impl<V, S> MmapEmbeddings for Embeddings<V, S> where
    Self: Sized,
    V: ReadChunk,
    S: MmapChunk, 

fn mmap_embeddings(read: &mut BufReader<File>) -> Result<Self, Error>

impl<V, S> WriteEmbeddings for Embeddings<V, S> where
    V: WriteChunk,
    S: WriteChunk, 

fn write_embeddings<W>(&self, write: &mut W) -> Result<(), Error> where
    W: Write + Seek, 

impl<V, S> Analogy for Embeddings<V, S> where
    V: Vocab,
    S: StorageView, 

fn analogy(
    &self,
    word1: &str,
    word2: &str,
    word3: &str,
    limit: usize
) -> Option<Vec<WordSimilarity>>

Perform an analogy query.

impl<V, S> AnalogyBy for Embeddings<V, S> where
    V: Vocab,
    S: StorageView, 

fn analogy_by<F>(
    &self,
    word1: &str,
    word2: &str,
    word3: &str,
    limit: usize,
    similarity: F
) -> Option<Vec<WordSimilarity>> where
    F: FnMut(ArrayView2<f32>, ArrayView1<f32>) -> Array1<f32>, 

Perform an analogy query using the given similarity function.

impl<V, S> Similarity for Embeddings<V, S> where
    V: Vocab,
    S: StorageView, 

fn similarity(&self, word: &str, limit: usize) -> Option<Vec<WordSimilarity>>

Find words that are similar to the query word.

impl<V, S> SimilarityBy for Embeddings<V, S> where
    V: Vocab,
    S: StorageView, 

fn similarity_by<F>(
    &self,
    word: &str,
    limit: usize,
    similarity: F
) -> Option<Vec<WordSimilarity>> where
    F: FnMut(ArrayView2<f32>, ArrayView1<f32>) -> Array1<f32>, 

Find words that are similar to the query word using the given similarity function.

impl<R> ReadText<R> for Embeddings<SimpleVocab, NdArray> where
    R: BufRead, 

fn read_text(reader: &mut R, normalize: bool) -> Result<Self, Error>

Read the embeddings from the given buffered reader.

impl<R> ReadTextDims<R> for Embeddings<SimpleVocab, NdArray> where
    R: BufRead, 

fn read_text_dims(reader: &mut R, normalize: bool) -> Result<Self, Error>

Read the embeddings from the given buffered reader.

impl<W, V, S> WriteText<W> for Embeddings<V, S> where
    W: Write,
    V: Vocab,
    S: Storage, 

fn write_text(&self, write: &mut W) -> Result<(), Error>

Write the embeddings to the given writer.

impl<W, V, S> WriteTextDims<W> for Embeddings<V, S> where
    W: Write,
    V: Vocab,
    S: Storage, 

fn write_text_dims(&self, write: &mut W) -> Result<(), Error>

Write the embeddings to the given writer.

impl<R> ReadWord2Vec<R> for Embeddings<SimpleVocab, NdArray> where
    R: BufRead, 

fn read_word2vec_binary(reader: &mut R, normalize: bool) -> Result<Self, Error>

Read the embeddings from the given buffered reader.

impl<W, V, S> WriteWord2Vec<W> for Embeddings<V, S> where
    W: Write,
    V: Vocab,
    S: Storage, 

fn write_word2vec_binary(&self, w: &mut W) -> Result<(), Error> where
    W: Write, 

Write the embeddings from the given writer.

impl<'a, V, S> IntoIterator for &'a Embeddings<V, S> where
    V: Vocab,
    S: Storage, 

type Item = (&'a str, CowArray1<'a, f32>)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl From<Embeddings<SimpleVocab, NdArray>> for Embeddings<VocabWrap, StorageWrap>

fn from(from: Embeddings<SimpleVocab, NdArray>) -> Self

Performs the conversion.

impl From<Embeddings<SimpleVocab, NdArray>> for Embeddings<VocabWrap, StorageViewWrap>

fn from(from: Embeddings<SimpleVocab, NdArray>) -> Self

Performs the conversion.

impl From<Embeddings<SimpleVocab, MmapArray>> for Embeddings<VocabWrap, StorageWrap>

fn from(from: Embeddings<SimpleVocab, MmapArray>) -> Self

Performs the conversion.

impl From<Embeddings<SimpleVocab, MmapArray>> for Embeddings<VocabWrap, StorageViewWrap>

fn from(from: Embeddings<SimpleVocab, MmapArray>) -> Self

Performs the conversion.

impl From<Embeddings<SimpleVocab, QuantizedArray>> for Embeddings<VocabWrap, StorageWrap>

fn from(from: Embeddings<SimpleVocab, QuantizedArray>) -> Self

Performs the conversion.

impl From<Embeddings<SubwordVocab, NdArray>> for Embeddings<VocabWrap, StorageWrap>

fn from(from: Embeddings<SubwordVocab, NdArray>) -> Self

Performs the conversion.

impl From<Embeddings<SubwordVocab, NdArray>> for Embeddings<VocabWrap, StorageViewWrap>

fn from(from: Embeddings<SubwordVocab, NdArray>) -> Self

Performs the conversion.

impl From<Embeddings<SubwordVocab, MmapArray>> for Embeddings<VocabWrap, StorageWrap>

fn from(from: Embeddings<SubwordVocab, MmapArray>) -> Self

Performs the conversion.

impl From<Embeddings<SubwordVocab, MmapArray>> for Embeddings<VocabWrap, StorageViewWrap>

fn from(from: Embeddings<SubwordVocab, MmapArray>) -> Self

Performs the conversion.

impl From<Embeddings<SubwordVocab, QuantizedArray>> for Embeddings<VocabWrap, StorageWrap>

fn from(from: Embeddings<SubwordVocab, QuantizedArray>) -> Self

Performs the conversion.

impl<V: Debug, S: Debug> Debug for Embeddings<V, S>

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

Formats the value using the given formatter.