MaartenGr / MaartenGr/BERTopic

Typo in Merge Multiple Models docs

Open
#1,657 1 comment 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

Hi Maarten,

Thanks for the latest update, I think the latest merge_models function will be really useful for me!

I think there is a typo in the min_similarity section on the Merged Multiple Models page. Should *change* below be *chance*? (occurs twice)
https://maartengr.github.io/BERTopic/getting_started/merge/merge.html#min_similarity

"""
This (dis)similarity is can be tweaked using the min_similarity parameter. Increasing this value will increase the *change* of adding new topics. In contrast, decreasing this value will make it more strict and threfore decrease the *change* of adding new topics. The value is set to 0.7 by default, so let's see what happens if we were to increase this value to `0.9``:
"""

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

Open the Merge Multiple Models documentation page at the linked min_similarity section and review the quoted paragraph. Correct both occurrences of “change” if they are typos, then verify the rendered wording and surrounding documentation.】【。

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.