Skip to main content

HdpModel

Struct HdpModel 

Source
pub struct HdpModel {
    pub n_topics_active: usize,
    /* private fields */
}
Expand description

Hierarchical Dirichlet Process topic model.

Fitted with collapsed Gibbs sampling over the Chinese Restaurant Franchise.

After calling fit you can:

  • Query n_topics_active for the inferred number of topics.
  • Call transform to get topic distributions for new documents.
  • Call top_words to inspect topic–word associations.
  • Call coherence to evaluate topic quality.

Fields§

§n_topics_active: usize

Number of active topics inferred from data.

Implementations§

Source§

impl HdpModel

Source

pub fn new(config: HdpConfig) -> Self

Create a new (unfitted) HDP model.

Source

pub fn fit( &mut self, corpus: &[Vec<usize>], vocab_size: usize, ) -> Result<HdpResult>

Fit the HDP model to corpus.

corpus is a slice of documents; each document is a Vec<usize> of word indices (all indices must be < vocab_size).

§Errors

Returns an error if corpus is empty, vocab_size is zero, or any word index is out of range.

Source

pub fn transform(&self, doc: &[usize]) -> Result<Vec<f64>>

Infer the topic distribution for a new (unseen) document.

Uses one pass of the E-step (word-topic probability normalisation) without modifying model parameters.

§Errors

Returns an error if the model is not fitted or doc is empty.

Source

pub fn top_words(&self, n: usize) -> Result<Vec<Vec<usize>>>

Return the top-n word indices for each active topic, ordered by descending probability.

§Errors

Returns an error if the model is not fitted.

Source

pub fn coherence(&self, corpus: &[Vec<usize>], n_top: usize) -> Result<Vec<f64>>

Compute per-topic PMI-based coherence scores.

Uses the top-n_top words per active topic and measures co-occurrence in the training corpus.

§Errors

Returns an error if the model is not fitted.

Trait Implementations§

Source§

impl Debug for HdpModel

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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