Update README.md

README.md

@@ -1,48 +1,39 @@
 ---
 license: apache-2.0
 ---
-# pszemraj/neuspell-subwordbert-probwordnoise
+# neuspell-subwordbert-probwordnoise
 
-> towards a reliable workaround for the ``neuspell` lib being broken
+> towards a reliable workaround for the `neuspell` lib being broken
 
-## original usage
+See the [github repository](https://github.com/neuspell/neuspell) for usage and all official information.
 
+## Usage
 
-this one would use bert checker
-
-```python
-!pip install -U neuspell -q
-
-data_folder = "/usr/local/lib/python3.7/dist-packages/neuspell"
+Clone this model repo with git:
 
+```bash
+sudo apt-get install git-lfs -q
+git clone https://huggingface.co/pszemraj/neuspell-subwordbert-probwordnoise
+```
 
-import neuspell
-from neuspell import *
+Install `neuspell` from pypi:
 
 
-""" select spell checkers & load """
-# checker = SclstmChecker(pretrained=True)
-# checker.from_pretrained()
-# ^^are the standard method and broken
+```bash
+pip install -U neuspell -q
+```
 
-url = "https://www.dropbox.com/sh/7u160z9gvijnc06/AACf3RDpbFn76vKS-f5rzvxWa?dl=1" #@param {type:"string"}
+Use in python for spell correction:
 
-!wget $url -O mychecker.zip
-
-import os
-target_dir = "/content/dl-checker"
-os.makedirs(target_dir, exist_ok=True)
-!unzip /content/mychecker.zip -d $target_dir
+```python
+from neuspell import BertChecker
 
-# checker3 = BertChecker()
-checker4 = SclstmChecker()
-checker4.from_pretrained(target_dir)
+checker = BertChecker()
+checker.from_pretrained("./neuspell-scrnn-probwordnoise/")
 
-checker4.correct("I luk foward to receving your reply")
+checker.correct("I luk foward to receving your reply") # correct a string 
 
-checker4.correct_strings(
-    ["I luk foward to receving your reply", 
-     "hooba dooba im like a pooba",
-     "were did wendigo goe goating?"]
-    )
-```
+checker.correct_strings(
+    ["I luk foward to receving your reply", "were did wendigo goe boating?"]
+) # correct a list of strings
+```