add relevance endpoint

Author: LeighWeston86

.gitignore

@@ -24,6 +24,7 @@ wheels/
 .installed.cfg
 *.egg
 MANIFEST
+src/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

matscholar/rest.py

@@ -301,10 +301,28 @@ def search_text_with_ents(self, text, filters, cutoff=1000):
 
         return self._make_request(sub_url, payload=payload, method=method)
 
+    def classify_relevance(self, docs, decision_boundary=0.5):
+        """
+        Determine whether or not a document relates to inorganic material science.
+
+        :param docs: list of strings; the documents to be classified
+        :param decision_boundary: float; decision boundary for the classifier
+        :return: list; classification labels for each doc (1 or 0)
+        """
+        method = "POST"
+        sub_url = "/relevance"
+        payload = {
+            "docs": docs,
+            "decision_boundary": decision_boundary
+        }
+
+        return self._make_request(sub_url, payload=payload, method=method)
+
 
 class MatScholarRestError(Exception):
     """
     Exception class for MatstractRester.
     Raised when the query has problems, e.g., bad query format.
     """
     pass
+

matscholar/tests/test_rest.py

@@ -224,6 +224,14 @@ def test_normalized(self):
         self.assertEqual(tagged_docs[0][0][2][1], "MAT")
         self.assertTrue(isinstance(tagged_docs[0][0][2][0], list))
 
+    def test_relevance(self):
+        test_docs = ["The polymer may be used in OLEDs and biosensors.",
+                     "The band gap of ZnO is 3.3 eV"]
+        preds = self.rester.classify_relevance(test_docs)
+        self.assertEqual(preds[0], 0)
+        self.assertEqual(preds[1], 1)
+
+
 class MaterialSearchEntsTest(unittest.TestCase):
 
     rester = Rester()