Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
AnjanaRita authored Nov 22, 2021
1 parent 05e2ff9 commit 9d01a5c
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
zeroshot_topics
===============

.. image:: https://static.pepy.tech/personalized-badge/zeroshot_topics?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads

.. contents:: **Table of Contents**
:backlinks: none

Expand All @@ -23,10 +25,12 @@ Algorithm

The algorithm contains, 4 stages:

1. Keyword & Keyphrase extraction
2. Keyword/Keyphrase expansion via knowledge graphs/Taxanomy
3. Trace the Hypernyms for the keywords
4. Use the Hypernyms and texts to label via zeroshot classifiers.
.. image:: assets/zstm.png

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.
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.
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.
4. **Zeroshot classification**: Use the Hypernyms and documents to label via zeroshot classifiers.


Installation
Expand Down Expand Up @@ -58,6 +62,15 @@ Usage
# Output - Topics: ['War', 'Head Of State']
Roadmap
-------

Some things that i plan to add in the coming days:

- Support custom keyword extractors.
- Support Custom Knowledge-graphs & taxonomy.
- Support Custom Zeroshot-classifiers in the pipeline.
- Add Usecase examples & improve documentation.

License
-------
Expand Down

0 comments on commit 9d01a5c

Please sign in to comment.