Merge pull request #32 from msg-systems/development

Merge release 1.1.1. from development

Author: richardpaulhudson

README.md

@@ -25,6 +25,7 @@ Author: <a href="mailto:richard.hudson@msg.group">Richard Paul Hudson, msg syste
     -   [6.1 Version 1.0.0](#version-100)
     -   [6.2 Version 1.0.1](#version-101)
     -   [6.3 Version 1.1.0](#version-110)
+    -   [6.4 Version 1.1.1](#version-111)
 -   [7. Open issues/requests for assistance](#open-issues)
 
 <a id="introduction"></a>
@@ -510,6 +511,13 @@ The initial open-source version.
 -  Regeneration of all models
 -  Improvement of the Polish examples in [section 1.4.1](#covered-relevant-linguistic-features) to make them more pragmatically correct - many thanks to Małgorzata Styś for her valuable advice on this.
 
+<a id="version-111"></a>
+##### 6.4 Version 1.1.1
+
+- Changed the dependencies to allow Coreferee to run on the Apple M1 chipset
+- Sorted out a problem with the supported spaCy versions
+- Improved some of the tests
+
 <a id="open-issues"></a>
 ### 7. Open issues / requests for assistance
 

setup.cfg

@@ -30,7 +30,8 @@ packages = find:
 python_requires = >=3.9
 install_requires =
   spacy>=3.1.0,<3.2.0
-  keras~=2.4.0
-  tensorflow~=2.5.0
+  keras>=2.4.0
+  tensorflow~=2.5.0;platform_system!="Darwin"
+  tensorflow-macos~=2.6.0;platform_system=="Darwin"
 [options.package_data]
 * = *.dat, *.cfg

tests/common/test_tendencies_common.py

@@ -233,99 +233,106 @@ def test_get_position_map_conjunction_second_sentence_mentions_true(self):
         position_map = self.sm_tendencies_analyzer.get_position_map(Mention(doc[9], True), doc)
         self.assertEqual([5, 2, 1, 2, 0, 1, 0], position_map)
 
+    def compare_compatibility_map(self, expected_compatibility_map, returned_compatibility_map):
+        self.assertEqual(expected_compatibility_map[0], returned_compatibility_map[0])
+        self.assertEqual(expected_compatibility_map[1], returned_compatibility_map[1])
+        self.assertEqual(expected_compatibility_map[2], returned_compatibility_map[2])
+        self.assertAlmostEqual(expected_compatibility_map[3], returned_compatibility_map[3], 4)
+        self.assertEqual(expected_compatibility_map[4], returned_compatibility_map[4])
+
     def test_get_compatibility_map_simple(self):
 
         doc = self.sm_nlp('Richard said he was entering the big house')
         self.sm_rules_analyzer.initialize(doc)
-        self.assertEqual('[2, 0, 1, 0.26251248, 3]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[2])))
+        self.compare_compatibility_map([2, 0, 1, 0.26251248, 3],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[2]))
 
     def test_get_compatibility_map_coordination(self):
 
         doc = self.sm_nlp('Richard and Jane said he was entering the big house')
         self.sm_rules_analyzer.initialize(doc)
-        self.assertEqual('[4, 0, 1, 0.20765561, 3]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], True), doc[4])))
+        self.compare_compatibility_map([4, 0, 1, 0.20765561, 3],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], True), doc[4]))
 
     def test_get_compatibility_map_different_sentences(self):
 
         doc = self.sm_nlp('Richard called. He said he was entering the big house')
         self.sm_rules_analyzer.initialize(doc)
-        self.assertEqual('[3, 1, 0, 0.52525896, 6]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[3])))
+        self.compare_compatibility_map([3, 1, 0, 0.52525896, 6],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[3]))
 
     def test_get_compatibility_map_same_sentence_no_governance(self):
 
         doc = self.sm_nlp('After Richard arrived, he said he was entering the big house')
         self.sm_rules_analyzer.initialize(doc)
-        self.assertEqual('[4, 0, 0, -0.12525316, 5]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4])))
+        self.compare_compatibility_map([4, 0, 0, -0.12525316, 5],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4]))
 
     def test_get_compatibility_map_same_sentence_lefthand_sibling_governance(self):
 
         doc = self.lg_nlp('Richard said Peter and he were entering the big house')
         self.lg_rules_analyzer.initialize(doc)
-        self.assertEqual('[4, 0, 1, 0.15999001, 4]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4])))
+        self.compare_compatibility_map([4, 0, 1, 0.15999001, 4],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4]))
 
     def test_get_compatibility_map_same_sentence_lefthand_sibling_no_governance(self):
 
         doc = self.sm_nlp('After Richard arrived, Peter and he said he was entering the big house')
         self.sm_rules_analyzer.initialize(doc)
-        self.assertEqual('[5, 0, 0, 0.32681236, 6]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[1], False), doc[6])))
+        self.compare_compatibility_map([5, 0, 0, 0.32681236, 6],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[1], False), doc[6]))
 
     def test_get_cosine_similarity_lg(self):
 
         doc = self.lg_nlp('After Richard arrived, he said he was entering the big house')
         self.lg_rules_analyzer.initialize(doc)
-        self.assertEqual('[4, 0, 0, 0.3336621, 5]',
-            str(self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4])))
+        self.compare_compatibility_map([4, 0, 0, 0.3336621, 5],
+            self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4]))
 
     def test_get_cosine_similarity_lg_no_vector_1(self):
 
         doc = self.lg_nlp('After Richard arfewfewfrived, he said he was entering the big house')
         self.lg_rules_analyzer.initialize(doc)
 
-        self.assertEqual('[4, 0, 0, 0.59521705, 5]',
-            str(self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4])))
+        self.compare_compatibility_map([4, 0, 0, 0.59521705, 5],
+            self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4]))
 
     def test_get_cosine_similarity_lg_no_vector_2(self):
 
         doc = self.lg_nlp('After Richard arrived, he saifefefwefefd he was entering the big house')
         self.lg_rules_analyzer.initialize(doc)
-        self.assertEqual('[4, 0, 0, 0.59521705, 3]',
-            str(self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4])))
+        self.compare_compatibility_map([4, 0, 0, 0.59521705, 3],
+            self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[4]))
 
     def test_get_cosine_similarity_sm_root_1(self):
 
         doc = self.sm_nlp('Richard. He said he was entering the big house')
         self.sm_rules_analyzer.initialize(doc)
 
-        self.assertEqual('[2, 1, 0, -1, 1]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[2])))
+        self.compare_compatibility_map([2, 1, 0, -1, 1],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[2]))
 
     def test_get_cosine_similarity_sm_root_2(self):
 
         doc = self.sm_nlp('Richard arrived. He.')
         self.sm_rules_analyzer.initialize(doc)
-        self.assertEqual('[3, 1, 0, -1, 1]',
-            str(self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[3])))
+        self.compare_compatibility_map([3, 1, 0, -1, 1],
+            self.sm_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[3]))
 
     def test_get_cosine_similarity_lg_root_1(self):
 
         doc = self.lg_nlp('Richard. He said he was entering the big house')
         self.lg_rules_analyzer.initialize(doc)
 
-        self.assertEqual('[2, 1, 0, -1, 1]',
-            str(self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[2])))
+        self.compare_compatibility_map([2, 1, 0, -1, 1],
+            self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[2]))
 
     def test_get_cosine_similarity_lg_root_2(self):
 
         doc = self.lg_nlp('Richard arrived. He.')
         self.lg_rules_analyzer.initialize(doc)
-        self.assertEqual('[3, 1, 0, -1, 1]',
-            str(self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[3])))
+        self.compare_compatibility_map([3, 1, 0, -1, 1],
+            self.lg_tendencies_analyzer.get_compatibility_map(Mention(doc[0], False), doc[3]))
 
     def test_get_vectors_token_with_head_sm(self):