Skip to main content

A Frequency-Quantized HyperLogLog Autocorrection algorithm that also is dyslexia-friendly.

Project description

FQ-HLL

An improved Frequency-Quantized HyperLogLog (FQ-HLL) Autocorrection Library

For theoretical value, there is nothing in my algorithm that uses any information about the English language or the QWERTY keyboard, to do any of the corrections. It is a NON-ML algorithm too.

Usage

The library defaults to searching within its own folder before searching in your local directory. Visit my GitHub Repo for more details, but there are two text files offered as base dictionaries: 20k_shun4midx.txt and database.txt, with around 20000 and 400 words respectively. The below code would only visit the local directory. If no dictionary is specified, 20k_shun4midx.txt would be used instead.

# ======== SAMPLE USAGE ======== #
if __name__ == "__main__":
    ac = Autocorrector()

    # File
    ans1 = ac.autocorrect("test_files/typo_file.txt", "test_files/class_suggestions.txt")
    print(ans1)

    ans2 = ac.top3("test_files/typo_file.txt", "test_files/class_suggestions.txt")

    # Optionally, you can not want it to output it into a file, then:
    # Individual strings
    ans3 = ac.autocorrect("hillo")
    ans4 = ac.top3("hillo")

    # Arrays
    ans5 = ac.autocorrect(["tsetign", "hillo", "goobye", "haedhpoesn"])
    ans6 = ac.top3(["tsetign", "hillo", "goobye", "haedhpoesn"])

    # You can even have a custom dictionary!
    dictionary = ["apple", "banana", "grape", "orange"]
    custom_ac = Autocorrector(dictionary)

    ans7 = custom_ac.autocorrect(["applle", "banana", "banan", "orenge", "grap", "pineapple"])
    ans8 = custom_ac.top3(["applle", "banana", "banan", "orenge", "grap", "pineapple"])

    print(ans7)
    print(ans8)

Results

More detail can be found in my GitHub Repo.

TL;DR it is way more accurate than traditional non-ML, non-language-specific algorithms such as BK-Tree and SymSpell and it also quite fast.

Notes

  • HLL naturally doesn't have Local Differential Privacy (LDP) yet, but has natural obfuscation.
  • This library does not collect personal data. However, still use it at your own discretion.

Dyslexia

Personally, I've always had an interest in autocorrect because I'm dyslexic and often unintentionally scramble or reverse letters when I read. Here are my thoughts about this algorithm based on my dyslexia.

  • Reasoning would be more detailed in the algo_description/description.pdf file in my GitHub Repo, but I find this algorithm's autocorrection suggestions are sometimes more intuitive (e.g. "klof" -> "folk") to my dyslexia than other Levenshtein distance-based autocorrection models.
  • As a side note, as a dyslexic person, I naturally process words similar to how the FQ-HLL algorithm processes words, and that was my intuition in terms of how to create this algorithm in the first place.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dyslexicloglog-1.0.2.tar.gz (83.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dyslexicloglog-1.0.2-py3-none-any.whl (87.8 kB view details)

Uploaded Python 3

File details

Details for the file dyslexicloglog-1.0.2.tar.gz.

File metadata

  • Download URL: dyslexicloglog-1.0.2.tar.gz
  • Upload date:
  • Size: 83.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for dyslexicloglog-1.0.2.tar.gz
Algorithm Hash digest
SHA256 e0cd74b5590a552696a57ab8f0f20428a38c71dd47a0d34954b702d11848fa1b
MD5 880da4b148856bfd9c70caa47c9b3396
BLAKE2b-256 d7a4233333a5129490ff0be5e7a1161e6aa9ec566169de9f73e3f557f2ad8418

See more details on using hashes here.

File details

Details for the file dyslexicloglog-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: dyslexicloglog-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 87.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for dyslexicloglog-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3747929b1edc6448c2ceffae8b9ba182ed1f6ec4a4e2aa43e6ee1befe46ffe02
MD5 2f2746f514036ff7dc52372d3fc0062a
BLAKE2b-256 2be0cf31d7ba5387a44d21c26bb4a8ad611128133a4d8423f5e077f61d23929d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page