Update README.md

README.md

@@ -5,4 +5,28 @@ datasets:
 language:
 - en
 pipeline_tag: text-classification
----
+---
+
+# kgourgou/bert-base-uncased-QA-classification
+
+An experiment into classifying whether a pair of (question, answer) is valid. 
+
+Input must be formatted as 
+
+```
+question: {your query}? answer: {your possible answer}
+```
+
+The output probabilities are for 
+
+1. class 0 = the answer string couldn't be an answer to the question and
+2. class 1 = the answer string could be an answer to the question. 
+
+
+Examples: 
+
+- "question: What number comes after five? answer: four" -> this should be class 1 as the answer is a number (even if it's not the right number).
+- "question: Which person is associated with Kanye West? answer: a tree" -> this should be class 0 as a tree is not a person.
+
+
+