Skip to main content

sptm: Sentence Topic Prediction using Topic Modeling

sptm logo

license

Quick rundown

sptm is a high-level API, written in Python and capable of training Topic Models using Gensim and MALLET. It was developed as a summer internship project under the guidance of @Anupam Mediratta. The package was wriiten with a focus on enabling fast experimentation. Being able to go from idea to result with the least possible delay is key to doing good research.

Use sptm if you need a library that:

  • Allows for easy and fast topic model training
  • Draw Inter-topic Distance Maps
  • Construct Conditional Probability Matrix for topics
  • Predict topic of sentences

Read the documentation at [sptm_source]/docs/_build/html/index.html.

sptm is compatible (tested) with: Python 3.7.


Some good stuff about sptm

  • User friendliness. The source code is very simple to follow

  • Modularity. You can use your own models, training algorithms etc. as long as it is supported by gensim


Getting started: 30 seconds to sptm

In the test folder of the repository, you will find a single script with almost all classes and functions used.


Installation

  • Important

sptm makes use of MALLET whose installtion steps can be found here.

This is required only if you want to train the topic model using gensim's LDAMallet wrapper that is the default training algorithm used in sptm.

Then, you can install sptm itself. There are two ways to install sptm:

  • Install sptm from PyPI (recommended):
sudo pip3 install sptm

If you are using a virtualenv, you may want to avoid using sudo:

pip3 install sptm
  • Alternatively: install sptm from the GitHub source:

First, clone sptm using git:

git clone https://github.com/Rochan-A/sptm.git

Then, cd to the sptm folder and run the install command:

cd sptm
sudo python3 setup.py install
  • NOTE: You will need to specifically download spacy's en_core_web_sm model.

This step needs to be done irrespective the method of installation.

You can do that by running:

python3 -m spacy download en_core_web_sm

Support

You can post bug reports and feature requests in GitHub issues. Make sure to read the guidelines first.


Why name it sptm?

sptm stands for - Sentence topic Prediction using Topic Modeling

Why is this readme oddly familiar?

This README is a heavily edited version of keras's


Metadata

Release files for sptm 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sptm 1.1.1
File Size Uploaded
sptm-1.1.1.tar.gz 13.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sptm 1.1.1
File Interpreter ABI Platform
sptm-1.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 28.3 kB

Release files / sptm-1.1.1.tar.gz

Download URL sptm-1.1.1.tar.gz
Size 13.5 kB
Tags Source
SHA-256 checksum
How to use checksums
2e520d753d77f4f63fd02aaa43150ba28b2a593a16cfc4d389ae77f151d09fcd
BLAKE2b-256 checksum
How to use checksums
bcae9c28e7dba42f44b0201e31e09caf6fd111b08f87e6763e7e67a6888d8cf2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

Release files / sptm-1.1.1-py3-none-any.whl

Download URL sptm-1.1.1-py3-none-any.whl
Size 14.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5e3c7b3158f8d9a44af2c9abc336247d4cf90a1c5ce1e0a4a30ed5a241c4bae9
BLAKE2b-256 checksum
How to use checksums
80a5becfb99a4199d82ecf01230f14ddaf8a8e192c9d8c4eb9f4523a0f1ff434
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files

1.1.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page