Skip to main content

Biterm Topic Model

Project description

Biterm Topic Model

CircleCI Documentation Status Downloads PyPI

Bitermplus implements Biterm topic model for short texts introduced by Xiaohui Yan, Jiafeng Guo, Yanyan Lan, and Xueqi Cheng. Actually, it is a cythonized version of BTM. This package is also capable of computing perplexity and semantic coherence metrics.

Requirements

  • Cython
  • NumPy
  • Pandas
  • SciPy
  • Scikit-learn
  • pyLDAvis (optional)

Setup

Linux and Windows

There should be no issues with installing bitermplus under these OSes. You can install the package directly from PyPi.

pip install bitermplus

Or from this repo:

pip install git+https://github.com/maximtrp/bitermplus.git

Mac OS

First, you need to install XCode CLT and Homebrew. Then, install libomp using brew:

xcode-select --install
brew install libomp
pip3 install bitermplus

Example

import bitermplus as btm
import numpy as np
from gzip import open as gzip_open

# Importing and vectorizing text data
with gzip_open('dataset/SearchSnippets.txt.gz', 'rb') as file:
    texts = file.readlines()

# Vectorizing documents, obtaining full vocabulary and biterms
X, vocab = btm.get_words_freqs(texts)
docs_vec = btm.get_vectorized_docs(X)
biterms = btm.get_biterms(X)

# Initializing and running model
model = btm.BTM(X, vocab, T=8, W=vocab.size, M=20, alpha=50/8, beta=0.01)
model.fit(biterms, iterations=20)
p_zd = model.transform(docs_vec)

# Calculating metrics
perplexity = btm.perplexity(model.matrix_words_topics_, p_zd, X, 8)
coherence = btm.coherence(model.matrix_words_topics_, X, M=20)
# or
perplexity = model.perplexity_
coherence = model.coherence_

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bitermplus-0.5.7.tar.gz (602.8 kB view details)

Uploaded Source

File details

Details for the file bitermplus-0.5.7.tar.gz.

File metadata

  • Download URL: bitermplus-0.5.7.tar.gz
  • Upload date:
  • Size: 602.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for bitermplus-0.5.7.tar.gz
Algorithm Hash digest
SHA256 c56771b9e234cb0578ce79860ef4a935e21f7d0b84c034f928bc2e4d88aa9b08
MD5 422c410ba4bce80f432061cdd72c14a8
BLAKE2b-256 7dc41cee78a6fc705f9152467498cbdf4a1a2a9c196c39e165ccf34e3ab5245e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page