Skip to main content

Word2Vec

Struct Word2Vec 

Source
pub struct Word2Vec<'a> {
    pub input: &'a mut Matrix,
    /* private fields */
}
Expand description

Initialise the word2vec model

§Fields

  • input: The input matrix
  • output: The output matrix
  • dim: The dimension of the model
  • lr: The learning rate
  • neg: The number of negative samples
  • grad: The gradient vector
  • neg_pos: The number of negative samples per positive sample
  • sigmoid_table: The sigmoid table
  • log_table: The log table
  • negative_table: The negative table
  • loss: The loss
  • n_samples: The number of samples

Fields§

§input: &'a mut Matrix

Implementations§

Source§

impl<'a> Word2Vec<'a>

Source

pub fn new( input: &'a mut Matrix, output: &'a mut Matrix, dim: usize, lr: f32, neg: usize, neg_table: Arc<Vec<usize>>, neg_start: usize, ) -> Word2Vec<'a>

Generate a new word2vec model

§Params
  • input - The input matrix
  • output - The output matrix
  • dim - The dimension of the model
  • lr - The learning rate
  • neg - The number of negative samples
  • neg_table - The negative table
§Returns

A new initialised word2vec model

Source

pub fn get_loss(&self) -> f64

Return the loss value

§Returns

The loss value

Source

pub fn set_lr(&mut self, lr: f32)

Set the learning rate

§Params
  • lr - The learning rate
Source

pub fn get_lr(&self) -> f32

Get the learning rate

§Returns

The learning rate

Source

pub fn update(&mut self, input: usize, target: usize)

Update the model

§Params
  • input - The input value
  • target - The target value

Auto Trait Implementations§

§

impl<'a> Freeze for Word2Vec<'a>

§

impl<'a> RefUnwindSafe for Word2Vec<'a>

§

impl<'a> Send for Word2Vec<'a>

§

impl<'a> Sync for Word2Vec<'a>

§

impl<'a> Unpin for Word2Vec<'a>

§

impl<'a> UnsafeUnpin for Word2Vec<'a>

§

impl<'a> !UnwindSafe for Word2Vec<'a>

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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