Skip to content

Added a short explanation of the difference between zeroshot and guid… #2238

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

janspoerer
Copy link

Added a short explanation of the difference between zeroshot and guided topic modeling to both of the respective documentations so that users immediately know that there are two very similar methods for providing pre-defined topics

What does this PR do?

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

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

Fixes #2237

Before submitting

  • This PR fixes a typo or improves the docs (if yes, ignore all other checks!).

…ed topic modeling to both of the respective documentations so that users immediately know that there are two very similar methods for providing pre-defined topics
Copy link
Owner

@MaartenGr MaartenGr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR! I understand the need to compare these two variants of what is something very similar. Perhaps at some point we would need to compare all variants against each other (maybe a table of sorts) so that users understand the many options out there and when to use it.

That said, left a couple of comments to clear up some things here and there.

@MaartenGr
Copy link
Owner

It seems there is a small linting issue. Could you check?

!!! 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 the importance of certain keywords. 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 clustering the remaining unclassified documents using the main algorithm of BERTopic.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like we have to further specify that Guided BERTopic is not primarily used to boost the importance of certain keywords but to guide clusters more towards predefined seed topics. That would make it a bit more clear that we do not focus on the importance of certain keywords (that's more of an side-effect).

@janspoerer
Copy link
Author

The linter job seems to succeed now :-)

@MaartenGr
Copy link
Owner

The linter job seems to succeed now :-)

Thanks! Did you see my comment above?

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 this pull request may close these issues.

Add context to the
2 participants