Skip to content

Commit 7117f23

Browse files
Update README.md
1 parent f763e4f commit 7117f23

1 file changed

Lines changed: 14 additions & 20 deletions

File tree

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,20 @@
44
<b>Topic modeling is your turf too.</b> <br> <i> Contextual topic models with representations from transformers. </i></p>
55

66

7-
## Intentions
8-
- Provide simple, robust and fast implementations of existing approaches (BERTopic, Top2Vec, CTM) with minimal dependencies.
9-
- Implement state-of-the-art approaches from my papers. (papers work-in-progress)
10-
- Put all approaches in a broader conceptual framework.
11-
- Provide clear and extensive documentation about the best use-cases for each model.
12-
- Make the models' API streamlined and compatible with topicwizard and scikit-learn.
13-
- Develop smarter, transformer-based evaluation metrics.
14-
15-
**Note**: This package is still work in progress and scientific papers on some of the novel methods (e.g., decomposition-based methods) are currently undergoing peer-review. If you use this package and you encounter any problem, let us know by opening relevant issues.
16-
17-
## Feature Roadmap
18-
- [x] Model Implementation
19-
- [x] Pretty Printing
20-
- [x] Implement visualization utilites for these models in topicwizard
21-
- [x] Thorough documentation
22-
- [x] Dynamic modeling (`GMM`, `ClusteringTopicModel` and `KeyNMF`)
23-
- [ ] Publish papers :hourglass_flowing_sand: (in progress..)
24-
- [ ] High-level topic descriptions with LLMs.
25-
- [ ] Contextualized evaluation metrics.
26-
7+
## Features
8+
- Novel transformer-based topic models:
9+
- Semantic Signal Separation - S³ (paper in progress ⏳)
10+
- KeyNMF 🔑
11+
- GMM
12+
- Implementations of existing transformer-based topic models
13+
- Clustering Topic Models: BERTopic and Top2Vec
14+
- Autoencoding Topic Models: CombinedTM and ZeroShotTM
15+
- Streamlined scikit-learn compatible API 🛠️
16+
- Easy topic interpretation 🔍
17+
- Dynamic Topic Modeling 📈 (GMM, ClusteringTopicModel and KeyNMF)
18+
- Visualization with [topicwizard](https://github.com/x-tabdeveloping/topicwizard) 🖌️
19+
20+
> This package is still work in progress and scientific papers on some of the novel methods are currently undergoing peer-review. If you use this package and you encounter any problem, let us know by opening relevant issues.
2721
2822
#### New in version 0.3.0: Dynamic KeyNMF
2923
KeyNMF can now be used for dynamic topic modeling.

0 commit comments

Comments
 (0)