Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,45 @@
----
-license: mit
----
+---
+languages: en
+license: apache-2.0
+tags:
+- neuspell
+- spelling
+- spell-correction
+
+---
+# neuspell-subwordbert-probwordnoise
+
+> towards a reliable workaround for the `neuspell` lib being broken
+
+See the [github repository](https://github.com/neuspell/neuspell) for usage and all official information.
+
+## Usage
+
+Clone this model repo with git:
+
+```bash
+sudo apt-get install git-lfs -q
+git clone https://huggingface.co/pszemraj/neuspell-subwordbert-probwordnoise
+```
+
+Install `neuspell` from pypi:
+
+
+```bash
+pip install -U neuspell -q
+```
+
+Use in python for spell correction:
+
+```python
+from neuspell import BertChecker
+
+checker = BertChecker()
+checker.from_pretrained("./neuspell-subwordbert-probwordnoise/")
+
+checker.correct("I luk foward to receving your reply") # correct a string 
+
+checker.correct_strings(
+    ["I luk foward to receving your reply", "were did wendigo goe boating?"]
+) # correct a list of strings
+```