MaartenGr / MaartenGr/BERTopic

Add context to the

Open Beginner friendly
#2,237 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.8k
Forks
920
Avg merge
22h 24m
Merged PRs (30d)
5

Description

### 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.
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading docs/getting_started/guided/guided.md and docs/getting_started/zeroshot/zeroshot.md to compare their existing explanations. Add reciprocal cross-references and a short comparison, then verify that both guides clearly explain when each approach is appropriate and that the links resolve.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.