This customized spell check is is based on the spell correction fuzzy search library SymSpell with a few customizations and optimizations
There are 2 implementations of the keyboards one is English Qwerty based and other is German Qwertz based implementation we used the adjancey graph of the keyboard for the weights to the connected nodes.
For 2 terms: slices olives If the misspelled word is, slives both slices and olives is 1 edit distnace, so in default case the one with higher frequency will end up in the result. While with the qwerty based char distance, slives is more closer to slices. The reason for this is in Qwerty Based Keyboard, S and O are too far while V and C are adjacent.
Word deletes are generated with taking edit distance which is minimum of max edit distance and 0.3 * word.length
Indexed Docs: 3695
|Qwerty Vanilla SymSpell||88.57%||11.43%||6860||279||348||573|
|Qwerty Weighted SymSpell||75.36%||24.64%||5744||330||297||1689|
We have done 3 runs each for 30k and 80k data set, which also includes results for each verbosity level. After the runs the final benchmarking looks like:
Average Precalculation time instance 30843.33 ms Average Lookup time instance 138141.09296296295 ns ~ 0.03814 ms Total Lookup results instance 648092
We use SemVer for versioning.
The MIT License (MIT) Copyright © 2019 Lucky Sharma ( https://github.com/MighTguY/customized-symspell ) Copyright © 2018 Wolf Garbe (Original C# implementation https://github.com/wolfgarbe/SymSpell ) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.