SLUSpell

SLUSpell is an open-source project that provides a simple user interface for spell checking. This project currently supports English and Irish.

Application Performance - version 0.2.0

The Irish 10100 test case
- Accuracy
  
  The accuracy of the application version 0.2.0 on corrections500.tsv test cases is %91.78.
- Average Runtime
  
  The average runtime of the application, including the API call, preprocessing, and postprocessing, is 0.233 ms.

Usage Guide

Install (Recommended)

To install SLUSpell, you can simply use the following commands:

# on windows
pip install sluspell

# run sluspell in cmd or Windows PowerShell 
sluspell

# Open browser, go to localhost:5000 and enjoy!

# on Linux/Mac 
pip3 install sluspell

Usage guide from source

To use the project, you should first fork the repo and clone it on your computer, or you might just easily download it. After that, you should install the project dependencies.

Dependencies

You can easily install the dependencies by entering the following command in the project directory on windows OS:

pip install -r requirements.txt

or the following command on Linux or Mac OS:

pip3 install -r requirements.txt

Quick Start

To run the application first, go to the /src directory and run the following command on Windows OS:

python main.py

or the below command on Linux or Mac OS:

python3 main.py

Out of repo contributions

Irish large preprocessed data

This repo contains pure Irish words extracted from several sources. Some of the main text files before preprocessing contained around 1400 non-Irish characters.

Todo

Using more accurate dictionaries.
Adding more test cases to check the robustness of the application.
Adding more complicated models to handle misspelled cases better.

License

SLUSpell is licensed under the terms of GNU General Public License v3. This library can be used for both academic and commercial purposes. For more information, check out the LICENSE file.

MahdiRahbar/SLUSpell