Update predictor.py

predictor.py

@@ -1,3 +1,5 @@
+# This file wraps around Pinpoint to provide simple prediction functionality.
+
 import csv
 import time
 import uuid
@@ -9,6 +11,9 @@ from Pinpoint.RandomForest import *
 class predictor():
 
     def __init__(self):
+        '''
+        Constructor
+        '''
         self.model = random_forest()
         self.model.PSYCHOLOGICAL_SIGNALS_ENABLED = False  # Needs LIWC markup
         self.model.BEHAVIOURAL_FEATURES_ENABLED = False
@@ -20,6 +25,12 @@ class predictor():
             baseline_training_dataset_location="LIWC2015 Results (Storm_Front_Posts).csv")
 
     def predict(self, string_to_predict = None, username = "unknown"):
+        '''
+        A wrapper function used to call pinpoint and predict if a given piece of text is extremist.
+        :param string_to_predict: 
+        :param username: 
+        :return: boolean true/ false
+        '''
 
         if string_to_predict == None:
             raise Exception("No prediction material given...")
@@ -75,4 +86,3 @@ class predictor():
             return True
         else:
             return False
-