MaartenGr / MaartenGr/PolyFuzz
Documentation: PolyFuzz don't take a model_id
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 803
- Forks
- 72
- PR merge metrics
- No merged PRs in 30d
Description
In some documented examples a `model_id` paramater is passed to the constructor of PolyFuzz, but PolyFuzz's constructor don't take such parameter
For instance, [the example here](https://maartengr.github.io/PolyFuzz/api/polyfuzz/#polyfuzz.polyfuzz.PolyFuzz.match)
```
import polyfuzz as pf
model = pf.PolyFuzz("TF-IDF", model_id="TF-IDF")
```
which return:
```
TypeError Traceback (most recent call last)
Cell In[12], line 2
1 import polyfuzz as pf
----> 2 model = pf.PolyFuzz("TF-IDF", model_id="TF-IDF")
3 model.match(from_list = ["string_one", "string_two"],
4 to_list = ["string_three", "string_four"])
TypeError: PolyFuzz.__init__() got an unexpected keyword argument 'model_id'
```
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 PolyFuzz API documentation example and compare it with the current PolyFuzz constructor signature. Update the example so it no longer passes the unsupported model_id parameter, then verify that it runs without the reported TypeError.
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
- Clearly specified
- Newbie friendliness
- 48/100