Skip to main content

TopicModeler

Struct TopicModeler 

Source
pub struct TopicModeler {
    pub config: TopicModelConfig,
    pub vocabulary: Vec<String>,
    pub word_index: HashMap<String, usize>,
}
Expand description

LDA-based topic modeler using collapsed Gibbs sampling.

Build the vocabulary from a corpus, run Gibbs sampling, and produce per-topic word distributions and per-document topic distributions.

Fields§

§config: TopicModelConfig

Model configuration.

§vocabulary: Vec<String>

Sorted vocabulary list (index → word).

§word_index: HashMap<String, usize>

Word → vocabulary index lookup.

Implementations§

Source§

impl TopicModeler

Source

pub fn new(config: TopicModelConfig) -> Self

Creates a new TopicModeler with the given configuration.

Source

pub fn fit( &mut self, documents: &[ModelDocument], ) -> Result<TopicModelResult, TopicModelError>

Fit the topic model to documents using collapsed Gibbs sampling.

Returns a TopicModelResult with topic word distributions, per-document topic distributions, perplexity, and metadata.

Source

pub fn transform( &mut self, documents: &[ModelDocument], result: &TopicModelResult, ) -> Result<Vec<DocumentTopics>, TopicModelError>

Infer topic distributions for documents given an already fitted model.

Runs a short round of Gibbs sampling on the new documents, keeping topic_word_counts frozen (using only the fitted model’s topic-word distributions as priors).

Source

pub fn coherence_score( topic: &LdaTopic, corpus_word_counts: &HashMap<String, u32>, ) -> f64

Compute a simplified PMI-based coherence score for a topic.

For each pair of top words (w_i, w_j), adds log((co_count + 1) / (count_j + 1)) where co_count is approximated as min(count_i, count_j) (simplified co-occurrence). Returns the mean over all pairs; returns 0.0 for single-word topics.

Source

pub fn most_similar_topics( topic_a: usize, topic_b: usize, result: &TopicModelResult, ) -> f64

Compute cosine similarity between the word-probability distributions of two topics.

Both topics must exist in result.topics. Returns 0.0 if either topic id is out of bounds or the distributions are zero.

Source

pub fn top_documents_for_topic( topic_id: usize, n: usize, result: &TopicModelResult, ) -> Vec<&DocumentTopics>

Return references to the top n documents ranked by topic_distribution[topic_id].

Returns an empty slice if topic_id is out of range.

Source

pub fn stats(result: &TopicModelResult) -> TopicModelerStats

Compute aggregate statistics from a fitted model result.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more