MaartenGr / PolyFuzz

Fuzzy string matching, grouping, and evaluation.
https://maartengr.github.io/PolyFuzz/
MIT License
725 stars 68 forks source link

Documentation: PolyFuzz don't take a model_id #74

Open raffaem opened 7 months ago

raffaem commented 7 months ago

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

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'
MaartenGr commented 7 months ago

Thanks for sharing this! It sees to be old documentation. I'll make sure it gets updated in a new release unless someone else comes around to pick this up including some of the other documentation updates you shared.