Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add context to the #2237

Open
janspoerer opened this issue Dec 8, 2024 · 0 comments · May be fixed by #2238
Open

Add context to the #2237

janspoerer opened this issue Dec 8, 2024 · 0 comments · May be fixed by #2238

Comments

@janspoerer
Copy link

Feature request

Cross-reference from the zeroshot doc to the guided doc (and vice versa).

Add a short explainer of the differences between zeroshot and guided.

Motivation

Two reasons:

  1. I used zeroshot topic modeling and only later found that there is a very similar approach that I would have like to have known earlier. It would be good if users would be cross-referenced to alternative approaches (from zeroshot to guided and from guided to zeroshot) when reading the documentation.

  2. Also, I found it not easy to compare these approaches as there is no explicit comparison in the docs between these two approaches. An explicit comparison would make it easier for users to understand the differences between zeroshot and guided.

Your contribution

This guide would go into the docs/getting_started/guided/guided.md markdown file:

!!! Note
    Difference between Zero-shot and Guided BERTopic: 
    Guided BERTopic is similar - yet not equivalent - to [Zeros-shot Topic Modeling](https://maartengr.github.io/BERTopic/getting_started/zeroshot/zeroshot.html). 
    Use Guided BERTopic to boost certain keyword's importance. Use [Zeros-shot Topic Modeling](https://maartengr.github.io/BERTopic/getting_started/zeroshot/zeroshot.html) to try to categorize documents into predefined topics ("zero-shot topics") before the clustering the remaining, unclassified documents, using the default unsupervised BERTopic topic exploration algorithm.

This guide would go into the docs/getting_started/zeroshot/zeroshot.md markdown file:

!!! Note
    Difference between Zero-shot and Guided BERTopic: 
    Zeros-shot Topic Modeling is similar - yet not equivalent - to [Guided BERTopic](https://maartengr.github.io/BERTopic/getting_started/guided/guided.html). Use [Guided BERTopic](https://maartengr.github.io/BERTopic/getting_started/guided/guided.html) to boost certain keyword's importance. Use [Zeros-shot Topic Modeling](https://maartengr.github.io/BERTopic/getting_started/zeroshot/zeroshot.html) to try to categorize documents into predefined topics ("zero-shot topics") before the clustering the remaining, unclassified documents, using the default unsupervised BERTopic topic exploration algorithm.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant