Skip to content

Commit 9d01a5c

Browse files
authored
Update README.rst
1 parent 05e2ff9 commit 9d01a5c

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
zeroshot_topics
22
===============
33

4+
.. image:: https://static.pepy.tech/personalized-badge/zeroshot_topics?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads
5+
46
.. contents:: **Table of Contents**
57
:backlinks: none
68

@@ -23,10 +25,12 @@ Algorithm
2325

2426
The algorithm contains, 4 stages:
2527

26-
1. Keyword & Keyphrase extraction
27-
2. Keyword/Keyphrase expansion via knowledge graphs/Taxanomy
28-
3. Trace the Hypernyms for the keywords
29-
4. Use the Hypernyms and texts to label via zeroshot classifiers.
28+
.. image:: assets/zstm.png
29+
30+
1. **Keyword & Keyphrase extraction**: This is done with the help of `KeyBERT <https://github.com/MaartenGr/KeyBERT>`_. but really any sort of keyword extractor can be used.
31+
2. **Keyword/Keyphrase expansion via knowledge graphs/Taxanomy**: Then we expand the important keywords we discovered by using some sort of taxanomy/knowledge graph like wordnet, conceptnet etc.
32+
3. **Trace the Hypernyms for the keywords**: Identify the Hypernyms(the root/parent word) and use this as the psuedo-label for the zeroshot classifier.
33+
4. **Zeroshot classification**: Use the Hypernyms and documents to label via zeroshot classifiers.
3034

3135

3236
Installation
@@ -58,6 +62,15 @@ Usage
5862
# Output - Topics: ['War', 'Head Of State']
5963
6064
65+
Roadmap
66+
-------
67+
68+
Some things that i plan to add in the coming days:
69+
70+
- Support custom keyword extractors.
71+
- Support Custom Knowledge-graphs & taxonomy.
72+
- Support Custom Zeroshot-classifiers in the pipeline.
73+
- Add Usecase examples & improve documentation.
6174

6275
License
6376
-------

0 commit comments

Comments
 (0)