Incorporated feedbacks

InferenceServer.py

@@ -1,11 +1,13 @@
 import os
 
-print("Installing dependencies...")
+# print("Installing dependencies...")
 
-os.system("git clone https://github.com/PrithivirajDamodaran/neuspell.git")
-os.chdir('neuspell')
-os.system('pip install -e .[elmo]')
-os.system('pip install -e .[spacy]')
+# os.system("git clone https://github.com/PrithivirajDamodaran/neuspell.git")
+# os.chdir('neuspell')
+# os.system('pip install -e .[elmo]')
+# os.system('pip install -e .[spacy]')
+
+print("Loading Spacy Model...")
 os.system("python -m spacy download en_core_web_sm")
 
 import neuspell
@@ -14,7 +16,7 @@ bl_checker = BertsclstmChecker()
 el_checker = ElmosclstmChecker()
 cl_checker = CnnlstmChecker()
 
-print("Loading Models...")
+print("Loading Neuspell Models...")
 bl_checker.from_pretrained()
 el_checker.from_pretrained()
 cl_checker.from_pretrained()
@@ -27,7 +29,6 @@ from fastapi import File
 from fastapi import FastAPI
 import sys
 
-
 app = FastAPI()
 print("Models loaded !")
 
@@ -38,6 +39,7 @@ def read_root():
 
 @app.get("/{correct}")
 def get_correction(input_sentence, model):
+    '''Returns spell corrected sentence using the model passed in model param.'''
     if model == "BERT-LSTM":
         return {"corrected_sentence": bl_checker.correct(input_sentence)}
     elif model == "ELMo-LSTM":  

app.py

@@ -10,9 +10,11 @@ import time
 import os
 
 def start_server():   
+    '''Helper to start to service through Unicorn '''
     os.system("uvicorn InferenceServer:app --port 8080 --host 0.0.0.0 --workers 1")
 
 def load_models():
+    '''One time loading/ Init of models and starting server as a seperate process'''
     if not is_port_in_use(8080):
         with st.spinner(text="Loading models, please wait..."):
             proc = Process(target=start_server, args=(), daemon=True)
@@ -25,6 +27,7 @@ def load_models():
     st.session_state['models_loaded'] = True
 
 def is_port_in_use(port):
+    '''Helper to check if service already running'''
     import socket
     with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
         return s.connect_ex(('0.0.0.0', port)) == 0
@@ -33,8 +36,8 @@ if 'models_loaded' not in st.session_state:
     st.session_state['models_loaded'] = False
 
 
-
 def get_correction(input_text, model):
+    '''Invokes the Neuspell inference service'''
     correct_request = "http://0.0.0.0:8080/correct?input_sentence="+input_text + "&model=" + model
     correct_response = requests.get(correct_request)
     correct_json = json.loads(correct_response.text)
@@ -46,7 +49,7 @@ def get_correction(input_text, model):
 
 
 def diff_strings(a, b):
-    # taken from team-writing-assistant/grammar-correction
+    '''Highlights corrections with annotated_text library'''
     result = []
     diff = difflib.Differ().compare(a.split(), b.split())
     replacement = ""

requirements.txt

@@ -1,3 +1,6 @@
+git+https://github.com/PrithivirajDamodaran/neuspell.git
+spacy
+allennlp==1.5.0
 st-annotated-text
 fastapi
 uvicorn