Skip to content

Commit bb7fce0

Browse files
Updated readme
1 parent 91d9f0c commit bb7fce0

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
## Features
88
| | |
99
| - | - |
10-
| SOTA Transformer-based Topic Models | :compass: [](https://x-tabdeveloping.github.io/turftopic/s3/), :key: [KeyNMF](https://x-tabdeveloping.github.io/turftopic/KeyNMF/), :gem: [GMM](https://x-tabdeveloping.github.io/turftopic/GMM/), [Clustering Models](https://x-tabdeveloping.github.io/turftopic/GMM/), [CTMs](https://x-tabdeveloping.github.io/turftopic/ctm/), [FASTopic](https://x-tabdeveloping.github.io/turftopic/FASTopic/) |
11-
| Models for all Scenarios | :chart_with_upwards_trend: [Dynamic](https://x-tabdeveloping.github.io/turftopic/dynamic/), :ocean: [Online](https://x-tabdeveloping.github.io/turftopic/online/), :herb: [Seeded](https://x-tabdeveloping.github.io/turftopic/seeded/), and :evergreen_tree: [Hierarchical](https://x-tabdeveloping.github.io/turftopic/hierarchical/) topic modeling |
10+
| SOTA Transformer-based Topic Models | :compass: [](https://x-tabdeveloping.github.io/turftopic/s3/), :key: [KeyNMF](https://x-tabdeveloping.github.io/turftopic/KeyNMF/), :gem: [GMM](https://x-tabdeveloping.github.io/turftopic/GMM/), [Clustering Models (BERTopic and Top2Vec)](https://x-tabdeveloping.github.io/turftopic/GMM/), [Autoencoding models (ZeroShotTM and CombinedTM)](https://x-tabdeveloping.github.io/turftopic/ctm/), [FASTopic](https://x-tabdeveloping.github.io/turftopic/FASTopic/) |
11+
| Models for all Scenarios | :chart_with_upwards_trend: [Dynamic](https://x-tabdeveloping.github.io/turftopic/dynamic/), :ocean: [Online](https://x-tabdeveloping.github.io/turftopic/online/), :herb: [Seeded](https://x-tabdeveloping.github.io/turftopic/seeded/), :evergreen_tree: [Hierarchical](https://x-tabdeveloping.github.io/turftopic/hierarchical/), and :camera: [Multimodal](https://x-tabdeveloping.github.io/turftopic/multimodal/) topic modeling |
1212
| [Easy Interpretation](https://x-tabdeveloping.github.io/turftopic/model_interpretation/) | :bookmark_tabs: Pretty Printing, :bar_chart: Interactive Figures, :art: [topicwizard](https://github.com/x-tabdeveloping/topicwizard) compatible |
1313
| [Topic Naming](https://x-tabdeveloping.github.io/turftopic/namers/) | :robot: LLM-based, N-gram Retrieval, :wave: Manual |
1414
| [Informative Topic Descriptions](https://x-tabdeveloping.github.io/turftopic/vectorizers/) | :key: Keyphrases, Noun-phrases, Lemmatization, Stemming |
@@ -17,6 +17,8 @@
1717
## Basics [(Documentation)](https://x-tabdeveloping.github.io/turftopic/)
1818
[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/x-tabdeveloping/turftopic/blob/main/examples/basic_example_20newsgroups.ipynb)
1919

20+
For detailed model comparison and tutorials, consult our documentation: [Click here](https://x-tabdeveloping.github.io/turftopic/)
21+
2022
### Installation
2123

2224
Turftopic can be installed from PyPI.
@@ -31,6 +33,12 @@ If you intend to use CTMs, make sure to install the package with Pyro as an opti
3133
pip install turftopic[pyro-ppl]
3234
```
3335

36+
If you want to use clustering models like BERTopic or Top2Vec, install:
37+
38+
```bash
39+
pip install turftopic[umap-learn]
40+
```
41+
3442
### Fitting a Model
3543

3644
Turftopic's models follow the scikit-learn API conventions, and as such they are quite easy to use if you are familiar with
@@ -140,10 +148,10 @@ model.print_topics()
140148
You can use a set of custom vectorizers for topic modeling over **phrases**, as well as **lemmata** and **stems**.
141149

142150
```python
143-
from turftopic import KeyNMF
151+
from turftopic import BERTopic
144152
from turftopic.vectorizers.spacy import NounPhraseCountVectorizer
145153

146-
model = KeyNMF(
154+
model = BERTopic(
147155
n_components=10,
148156
vectorizer=NounPhraseCountVectorizer("en_core_web_sm"),
149157
)

0 commit comments

Comments
 (0)