koaning / embetter

just a bunch of useful embeddings
https://koaning.github.io/embetter/
MIT License
469 stars 15 forks source link

typo fix and deprecation warning for MatrouskaEncoder #100

Closed anopsy closed 7 months ago

anopsy commented 7 months ago

I added deprecation warning using warn, because I noticed this solution in sklego (KlusterFoldValidation). If you prefer me to use deprecated-decorator, just let me know. Not sure if I changed init correctly but they made importing MatryoshkaEncoder possible.

anopsy commented 7 months ago

facepalm < Sorry, I'm on it, I will also adjust tests/test_text.py

anopsy commented 7 months ago

Let me know if I correctly assumed that the README.md, text.md and tests don't need mentions of both Matrouska and Matryoshka.

Edit: Now I realized that I could leave the MatrouskaEncoder in the docs and give it some frame and warning about deprecation. I'll check how to do that in markdown/mkdocs and will correct it accordingly