Package: response-validator
response_validation_appImplements a simple unsupervised method for classifying student short to medium sized responses to questions.InstallationThis was developed in Python 3.6.It may be installed as a package from the pypi repository, usingpip:pipinstallresponse-validatorDevelopmentAfter cloning the repository, you can install the repo in editable mode, as so:pipinstall-e.Note that this step will download several NLTK corpora, silently, and add them to the deployed tree.Additional functionality for running algorithm tests, etc. can be enabled by installing additional libraries:pipinstall-rrequirements.txtUsageDevelopmentIn order to persist the book vocabulary data between invocations, the Flask
server needs theDATA_DIRsetting to contain a path pointing to an existing
directory.  This can be set in several ways.Pass a key-value command line argument:python -m validator.app DATA_DIR=dataset theVALIDATOR_SETTINGSenvironment variable to the path of a file
that contains theDATA_DIRsetting:VALIDATOR_SETTINGS=data/dev.cfg python -m validator.appWhere the contents of dev.cfg is:DATA_DIR=dataand the directorydataexists.use gunicorn, provide arguments to app factory:gunicorn 'validator.app:create_app(DATA_DIR="data")'Use gunicorn, with an environment variable pointing to a config file:VALIDATOR_SETTINGS=../data/dev.cfg gunicorn "validator.app:create_app()"Note that this one can get confusing with relative paths, since flask  uses the
directory the app is imported from (in this case,validator) as the config
path when interpreting environment variables, while paths inside such files
will be based on the python current working directory. When in doubt, use full
paths:VALIDATOR_SETTINGS="$PWD/data/dev.cfg" gunicorn "validator.app:create_app()"ProductionThe recommended production method for deployment is to use a WSGI compliant
server, such as gunicorn:pipinstallgunicorngevent
gunicorn-kgevent-b5000"validator.app:create_app(DATA_DIR='/var/lib/validator/data')"Ideally, use a socket, and place nginx or other webserver in front of flask, for https termination, if nothing else.gunicorn-kgevent--bind/run/gunicorn.sock"validator.app:create_app(DATA_DIR='/var/lib/validator/data')"APIResponse ValidationThe main route for the app is /validate, which accepts a plaintext response (response) that will be checked.  It can also accept a number of optional arguments:uid(e.g., '1000@1', default None): This is the uid for the question pertaining to the response. The uid is used to compute domain-specific and module-specific vocabulary to aid in the classification process.
Iff the version of the question specified is not available, any version of the same qid (question id without the version, e.g. 1000) will be used.remove_stopwords(True or False, default True): Whether or not stopwords (e.g., 'the', 'and', etc) will be removed from the response.  This is generally advised since these words carry little predictive value.tag_numeric(True, False or auto, default auto): Whether numerical values will be tagged (e.g., 123.7 is tagged with a special 'numeric_type_float' identifier). While there are certainly responses for which this would be helpful, a large amount of student garbage consists of random number pressing which limits the utility of this option. Auto enables a mode that only does numeric tag processing if the question this response pertains to (as fond via the uid above) requires a numeric answer.spelling_correction(True, False or auto, default auto): Whether the app will attempt to correct misspellings. This is done by identifying unknown words in the response and seeing if a closely related known word can be substituted.  Currently, the app only attempts spelling correction on words of at least 5 characters in length and only considers candidate words that are within an edit distance of 2 from the misspelled word. When running inautomode, the app will attempt to determine validity without spelling correction. Only if that is not valid, will it attempt to reassess validity with spelling correction.spell_correction_max(integer, default 10): Limit spelling corrections applied to this number.remove_nonwords(True or False, default True): Words that are not recognized (after possibly attempting spelling correction) are flagged with a special 'nonsense_word' tag.  This is done primarily to combat keyboard mashes (e.g., 'asdfljasdfk') that make a large percentage of invalid student responses.Once the app is running, you can send requests using curl, requests, etc.  Here is an example using Python's requests library:Here an example of how to call things using the Python requests library (assuming that the app is running on the default local development port):importjsonimportrequestsparams={'response':'This is my answar to the macromolecules question nitrogenous awerawfsfs''uid':'100@2','remove_stopwords':True,'tag_numeric=True':False,'spelling_correction':True,'remove_nonwords':True}r=requests.get('http://127.0.0.1:5000/validate',params=params)print(json.dumps(r.json(),indent=2)){"bad_word_count":1,"common_word_count":3,"computation_time":0.013212919235229492,"domain_word_count":1,"inner_product":1.5999999999999996,"innovation_word_count":0,"intercept":1,"lazy_math_evaluation":true,"num_spelling_correction":2,"option_word_count":0,"processed_response":"answer macromolecules question nitrogenous nonsense_word","remove_nonwords":true,"remove_stopwords":true,"response":"This is my answar to the macromolecules question nitrogenous awerawfsfs","spelling_correction":true,"spelling_correction_used":true,"stem_word_count":0,"tag_numeric":"auto","tag_numeric_input":"auto","uid_found":true,"uid_used":"100@7","valid":true,"version":"2.4.0"}As you can see from these results, a number of features are taken into account
when determining the potential validity of the students response: the words in
the response itself, the words from the associated question (stem words) and
its answers (option words), the words in the textbook associated with this
assignment (domain words), and the words in the textbook whose first appearance
is on the page associated with this question (innovation words). Various other
features (presence or absence of math, spelling correction, stop word
elimination, etc) are also applied. These tests depend on vocabularies being loaded
for each exercise.Service APIsSee details in API.md