MaartenGr / MaartenGr/PolyFuzz
I don't understand what is returned
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 803
- Forks
- 72
- PR merge metrics
- No merged PRs in 30d
Description
The [docs provide the following example](https://maartengr.github.io/PolyFuzz/tutorial/quickstart/quickstart/#getting-started):
```
from polyfuzz import PolyFuzz
from_list = ["apple", "apples", "appl", "recal", "house", "similarity"]
to_list = ["apple", "apples", "mouse"]
model = PolyFuzz("TF-IDF").match(from_list, to_list)
```
which returns
```
>>> model.get_matches()
From To Similarity
0 apple apple 1.000000
1 apples apples 1.000000
2 appl apple 0.783751
3 recal None 0.000000
4 house mouse 0.587927
5 similarity None 0.000000
```
I don't understand what is returned. If polyfuzz is doing pairwise comparion from `from` list to `to` list, it should return len(from)*len(to) rows. So 18 results in this case.
In the example, apple->apples, apple->mouse, apples->apple, apples->mouse and so on are missing.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Quickstart documentation and its `PolyFuzz("TF-IDF").match(from_list, to_list)` example, then inspect the `model.get_matches()` entry point. Clarify why the output has one row per item in `from_list` rather than every pair, and document what the `From`, `To`, and `Similarity` columns represent so the example's result is understandable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100