Skip to main content

HdpTopicModel

Struct HdpTopicModel 

Source
pub struct HdpTopicModel {
    pub phi: Vec<Vec<f64>>,
    pub theta: Vec<Vec<f64>>,
    /* private fields */
}
Expand description

Task-API Hierarchical Dirichlet Process topic model.

Provides the interface HdpTopicModel::fit(corpus, vocab_size, config), .transform(doc), .topics(), and .num_topics_inferred().

Internally delegates to Hdp for the Gibbs sampling loop, then post-processes to expose phi (topic × word) and theta (document × topic) arrays.

§Example

use scirs2_text::topic::hdp::{HdpTopicConfig, HdpTopicModel};

let corpus = vec![
    vec![0usize, 1, 2],
    vec![3usize, 4, 5],
];
let cfg = HdpTopicConfig { n_iter: 10, t_max: 5, burn_in: 2, seed: 0, ..Default::default() };
let model = HdpTopicModel::fit(&corpus, 6, cfg).expect("fit must succeed");
assert!(model.num_topics_inferred() >= 1);

Fields§

§phi: Vec<Vec<f64>>

φ[k][w] = word probability in topic k. Shape: [active_k × vocab_size].

§theta: Vec<Vec<f64>>

θ[d][k] = topic proportion for document d. Shape: [n_docs × t_max].

Implementations§

Source§

impl HdpTopicModel

Source

pub fn fit( corpus: &[Vec<usize>], vocab_size: usize, config: HdpTopicConfig, ) -> Result<Self, TopicError>

Fit the HDP topic model to corpus.

§Parameters
  • corpus: slice of documents, each a Vec<usize> of word indices (all must be < vocab_size).
  • vocab_size: vocabulary size.
  • config: hyperparameters and iteration counts.
§Errors

Returns TopicError::EmptyCorpus when corpus is empty, and TopicError::WordOutOfVocab when any word index ≥ vocab_size.

Source

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

Infer the topic distribution for an unseen document.

Returns a vector of length t_max that sums to 1.0, with each entry representing the proportion of the document’s content assigned to that topic.

Word indices ≥ vocab_size are silently skipped.

Source

pub fn topics(&self) -> &[Vec<f64>]

Return references to all (active + inactive) topic-word distributions.

The outer slice has length t_max; the inner slices each have length vocab_size. Inactive topics have a uniform distribution over the prior η.

Source

pub fn num_topics_inferred(&self) -> usize

Number of topics with at least one word token assigned after Gibbs sampling (approximates the model’s belief about how many topics the corpus requires).

Trait Implementations§

Source§

impl Debug for HdpTopicModel

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