Merge branch 'main' into update-pie-rose-charts

Author: KD-7

LICENSE

@@ -19,41 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
----
-
-Some of TrueLearn's functionality is derived from externally maintained libraries,
-including:
-
-- scikit-learn, licensed as follows:
-    """
-        BSD 3-Clause License
-
-        Copyright (c) 2007-2022 The scikit-learn developers.
-        All rights reserved.
-
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are met:
-
-        * Redistributions of source code must retain the above copyright notice, this
-        list of conditions and the following disclaimer.
-
-        * Redistributions in binary form must reproduce the above copyright notice,
-        this list of conditions and the following disclaimer in the documentation
-        and/or other materials provided with the distribution.
-
-        * Neither the name of the copyright holder nor the names of its
-        contributors may be used to endorse or promote products derived from
-        this software without specific prior written permission.
-
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-    """

LICENSE-3RD-PARTY

@@ -0,0 +1,35 @@
+Some of TrueLearn's functionality is derived from externally maintained libraries,
+including:
+
+- scikit-learn, licensed as follows:
+    """
+        BSD 3-Clause License
+
+        Copyright (c) 2007-2022 The scikit-learn developers.
+        All rights reserved.
+
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+
+        * Redistributions of source code must retain the above copyright notice, this
+        list of conditions and the following disclaimer.
+
+        * Redistributions in binary form must reproduce the above copyright notice,
+        this list of conditions and the following disclaimer in the documentation
+        and/or other materials provided with the distribution.
+
+        * Neither the name of the copyright holder nor the names of its
+        contributors may be used to endorse or promote products derived from
+        this software without specific prior written permission.
+
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+    """

pyproject.toml

@@ -51,18 +51,21 @@ dependencies = [
     'typing-extensions>=4.4.0',
     'trueskill>=0.4.5',
     'scikit-learn>=1.0.2',
-    'orjson>=3.8.6',
     'mpmath>=1.2.1',
-    'plotly>=5.14.1',
     'matplotlib>=3.5.3',
     'circlify>=0.15.0',
-    "wordcloud>=1.8.2.2; python_version < '3.11'",
+
+    # We lock these dependencies because our usage
+    # might be broken by their updates. We want to
+    # manually update these dependencies.
+    'plotly==5.14.1',
+    "wordcloud==1.9.2",
 
     # This is a temporary fix for kaleido hanging on image generation on Windows
     # See: https://github.com/plotly/Kaleido/issues/110
     # and: https://github.com/plotly/Kaleido/issues/134
     "kaleido==0.1.0.post1; sys_platform == 'win32'",
-    "kaleido>=0.2.1; sys_platform != 'win32'",
+    "kaleido==0.2.1; sys_platform != 'win32'",
 ]
 [project.urls]
 Homepage = "https://truelearnai.github.io/"

truelearn/learning/_ink_classifier.py

@@ -1,5 +1,5 @@
 import math
-from typing import Any, Optional, Dict, Tuple
+from typing import Any, Optional, Dict, Tuple, Union
 from typing_extensions import Self, Final
 
 import trueskill
@@ -92,8 +92,8 @@ def __init__(
         self,
         *,
         learner_meta_weights: Optional[LearnerMetaWeights] = None,
-        novelty_classifier: Optional[NoveltyClassifier] = None,
-        interest_classifier: Optional[InterestClassifier] = None,
+        novelty_classifier: Optional[Union[NoveltyClassifier, Dict]] = None,
+        interest_classifier: Optional[Union[InterestClassifier, Dict]] = None,
         threshold: float = 0.5,
         tau: float = 0.0,
         greedy: bool = False,
@@ -106,9 +106,13 @@ def __init__(
             learner_meta_weights:
                 The novelty/interest/bias weights.
             novelty_classifier:
-                The NoveltyClassifier.
+                The NoveltyClassifier. It can be a NoveltyClassifier object or
+                a dictionary of parameters that can be used to instantiate a
+                NoveltyClassifier object.
             interest_classifier:
-                The InterestClassifier.
+                The InterestClassifier. It can be an InterestClassifier object or
+                a dictionary of parameters that can be used to instantiate an
+                InterestClassifier object.
             threshold:
                 A float that determines the classification threshold.
             tau:
@@ -125,8 +129,20 @@ def __init__(
             TrueLearnValueError:
                 Values of parameters do not satisfy their constraints.
         """
-        self._novelty_classifier = novelty_classifier or NoveltyClassifier()
-        self._interest_classifier = interest_classifier or InterestClassifier()
+        if novelty_classifier is None:
+            self._novelty_classifier = NoveltyClassifier()
+        elif isinstance(novelty_classifier, dict):
+            self._novelty_classifier = NoveltyClassifier(**novelty_classifier)
+        else:
+            self._novelty_classifier = novelty_classifier
+
+        if interest_classifier is None:
+            self._interest_classifier = InterestClassifier()
+        elif isinstance(interest_classifier, dict):
+            self._interest_classifier = InterestClassifier(**interest_classifier)
+        else:
+            self._interest_classifier = interest_classifier
+
         self._learner_meta_weights = learner_meta_weights or LearnerMetaWeights()
         self._threshold = threshold
         self._tau = tau

truelearn/preprocessing/_wikifier.py

@@ -1,7 +1,7 @@
 from typing import Optional, Union, Dict, List, Iterable, cast
 from urllib import parse, request
 
-import orjson
+import json
 
 from truelearn.errors import TrueLearnValueError, WikifierError
 
@@ -131,7 +131,7 @@ def __make_wikifier_request(
 
         # nosec because we know `url` is a valid https url
         with request.urlopen(url) as r:  # nosec
-            resp = orjson.loads(r.read().decode("utf-8"))
+            resp = json.loads(r.read().decode("utf-8"))
             if "error" in resp:
                 raise WikifierError(f"error in response : {resp['error']}")
             if "status" in resp:

truelearn/tests/test_learning.py

@@ -798,6 +798,25 @@ def test_ink_classifier_customize(self, train_cases, test_events):
 
         check_farray_close(actual_results, expected_results)
 
+    def test_ink_classifier_customize_via_dict(self, train_cases, test_events):
+        classifier = learning.INKClassifier(
+            novelty_classifier={"def_var": 0.4},
+            interest_classifier={"beta": 0.2},
+        )
+
+        train_events, train_labels = train_cases
+        for event, label in zip(train_events, train_labels):
+            classifier.fit(event, label)
+
+        expected_results = [
+            0.36741905582712336,
+            0.3247468970257655,
+            0.33375911026514554,
+        ]
+        actual_results = [classifier.predict_proba(event) for event in test_events]
+
+        check_farray_close(actual_results, expected_results)
+
     def test_ink_get_set_params(self):
         classifier = learning.INKClassifier()
 

truelearn/tests/test_utils_visualisations.py

@@ -4,7 +4,6 @@
 import pathlib
 import types
 import os
-import sys
 from typing import Dict, Optional, Callable
 
 import pytest
@@ -496,10 +495,6 @@ def test_top_n(self, resources):
         return plotter
 
 
-@pytest.mark.skipif(
-    sys.version_info >= (3, 11),
-    reason="WordPlotter only supports Python version < 3.11",
-)
 class TestWordPlotter:
     # no way to test this in a cross-platform way
     # because wordcloud renders the same font differently on different operating systems