Merge pull request #80 from TrueLearnAI/release-1.1.0

Release TrueLearn 1.1.0

Author: KD-7

README.rst

@@ -50,19 +50,19 @@ User Installation
 
    pip install -U truelearn
 
-For more information on installation, see the `Getting Started guide <https://truelearn.readthedocs.io/en/latest/tutorial/quickstart.html>`_.
+For more information on installation, see the `Getting Started guide <https://truelearn.readthedocs.io/en/stable/tutorial/quickstart.html>`_.
 
 Documentation
 #############
 
-.. BROKEN LINK -> **Latest stable release** is available at: https://truelearn.readthedocs.io/en/stable/
+**Latest stable release** is available at: https://truelearn.readthedocs.io/en/stable/
 
 **Development version** is available at: https://truelearn.readthedocs.io/en/latest/
 
 Change Log
 ##########
 
-See the `Change Log <https://truelearn.readthedocs.io/en/latest/index.html#change-log>`_
+See the `Change Log <https://truelearn.readthedocs.io/en/stable/index.html#change-log>`_
 for a history of all the major changes to the truelearn.
 
 Alternatively you can find it in the ``CHANGELOG.rst`` file found here:

docs/authors.rst

@@ -1,4 +1,8 @@
 Authors and Contributors
 ------------------------
 
-REDACTED for double-blind review.
+`KD-7 <https://github.com/KD-7>`_,
+`yuxqiu <https://github.com/yuxqiu>`_,
+`sahanbull <https://github.com/sahanbull>`_,
+`deniselezi <https://github.com/deniselezi>`_,
+`aaneelshalman <https://github.com/aaneelshalman>`_,

docs/changelog.rst

@@ -3,5 +3,43 @@ Change Log
 ----------
 This file documents all notable changes to the project.
 
-- TrueLearn 1.0.0 (14-04-2023)
-    - Initial release!
+- Date format is DD-MM-YYYY.
+- TrueLearn adheres to `Semantic Versioning`_.
+- TrueLearn uses the `Keep a Changelog`_ format.
+
+.. _Semantic Versioning: http://semver.org/
+.. _Keep a Changelog: http://keepachangelog.com/
+
+
+**TrueLearn 1.1.0 (13-08-2023)**
+
+*Added*
+
+- The option to visualise the variance in Bar, Dot, Line plotters. By default this is
+  enabled except in the Line plotter.
+
+*Changed*
+
+- Interest Classifier now uses a binary skill representation.
+- The INK Classifier can now be instantiated using a dictionary of parameters
+- Added black border to Rose Plotter to make it easier to distinguish topics of similar
+  colour.
+- Locked the plotly, kaleido and wordcloud dependencies to avoid breaking changes.
+- Radar plotter doesnt show the variance, due to concerns about the representation of
+  variance being misleading.
+
+*Fixed*
+
+- Incorrect weights used in INK prediction
+- Topic label overflow in Bubble plotter. This means that a reasonable number
+  of topics (around 10 to 15) can be plotted for the default image size.
+- Wordcloud now fully supports Python 3.11
+
+*Removed*
+
+- orjson dependency, as JSON deserialisation is not our bottleneck and the additional dependency
+  is not worth it.
+
+**TrueLearn 1.0.0 (14-04-2023)**
+
+- Initial release!

docs/index.rst

@@ -49,7 +49,48 @@ See the :ref:`installation` for a quick introduction to the package.
 Related Papers
 --------------
 
-REDACTED for double-blind review.
+This work is related to the following papers:
+
+- `TrueLearn A Family of Bayesian Algorithms to Match Lifelong Learners to Open Educational Resources`_ published at the Thirty-forth AAAI Conference on Artificial Intelligence, 2020 at New York, NY, USA. BibTex below::
+
+   @inproceedings{truelearn2020,
+       author = {Bulathwela, S. and Perez-Ortiz, M. and Yilmaz, E. and Shawe-Taylor, J.},
+       title={TrueLearn: A Family of Bayesian Algorithms to Match Lifelong Learners to Open Educational Resources},
+       booktitle = {AAAI Conference on Artificial Intelligence},
+       year = {2020}
+   }
+
+- `Power to the Learner: Towards Human-Intuitive and Integrative Recommendations with Open Educational Resources`_ published in 2022 as part of the Special Issue on AI and Interaction Technologies for Social Sustainability. BibTex below::
+
+   @Article{su141811682,
+      author = {Bulathwela, Sahan and Pérez-Ortiz, María and Yilmaz, Emine and Shawe-Taylor, John},
+      title = {Power to the Learner: Towards Human-Intuitive and Integrative Recommendations with Open Educational Resources},
+      journal = {Sustainability},
+      volume = {14},
+      year = {2022},
+      number = {18},
+      article-number = {11682},
+      url = {https://www.mdpi.com/2071-1050/14/18/11682},
+      ISSN = {2071-1050},
+      DOI = {10.3390/su141811682}
+   }
+
+
+
+- `PEEK: A Large Dataset of Learner Engagement with Educational Videos`_ published in 2021 as part of the 4th workshop on Online Recommender Systems and User Modeling at ACM RecSys 2021. BibTex below::
+
+   @article{DBLP:journals/corr/abs-2109-03154,
+       author = {Bulathwela, Sahan and Yilmaz, Emine and Shawe-Taylor, John},
+       title={PEEK: A Large Dataset of Learner Engagement with Educational Videos},
+       booktitle = {4th workshop on Online Recommender Systems and User Modeling at ACM RecSys 2021},
+       year = {2021}
+   }
+
+
+.. _TrueLearn A Family of Bayesian Algorithms to Match Lifelong Learners to Open Educational Resources: https://arxiv.org/abs/1911.09471
+.. _Power to the Learner\: Towards Human-Intuitive and Integrative Recommendations with Open Educational Resources: https://www.mdpi.com/2071-1050/14/18/11682
+.. _PEEK\: A Large Dataset of Learner Engagement with Educational Videos: https://arxiv.org/abs/2109.03154
+
 
 .. include:: changelog.rst
 .. include:: authors.rst

docs/modules/api_reference.rst

@@ -38,7 +38,6 @@ Classes
     :template: class_with_call.rst
 
     datasets.PEEKKnowledgeComponentGenerator
-    datasets.PEEKData
 
 Functions
 ---------
@@ -114,7 +113,6 @@ Classes
     :toctree: generated/
     :template: class.rst
 
-    preprocessing.Annotation
     preprocessing.Wikifier
 
 Functions

examples/plot_knowledge_line.py

@@ -4,7 +4,7 @@
 ===================
 
 This example shows how to use the ``LinePlotter`` class
-to generate a bar chart to compare different learners' knowledge
+to generate a line chart to compare different learners' knowledge
 on the same topic.
 
 In this example, we use the ``NoveltyClassifier`` to build

examples/plot_knowledge_word.py

@@ -9,11 +9,6 @@
 In this example, we use the ``KnowledgeClassifier`` to build
 a representation of the learner's knowledge. You could also use
 other classifiers like ``NoveltyClassifier``.
-
-.. warning:: You need to use ``WordPlotter`` with caution because
-
-            - Compatibility: it fails to work on some systems with Python 3.11.
-            - Stability: it is not actively maintained.
 """
 from truelearn import learning, datasets
 from truelearn.utils import visualisations

pyproject.toml

@@ -48,12 +48,15 @@ classifiers = [
     "Topic :: Education",
 ]
 dependencies = [
-    'typing-extensions>=4.4.0',
+    'typing-extensions>=4.7.1',
     'trueskill>=0.4.5',
+    'mpmath>=1.3.0',
+    'circlify>=0.15.0',
+
+    # Bump these versions if we remove support for Python 3.7
     'scikit-learn>=1.0.2',
-    'mpmath>=1.2.1',
     'matplotlib>=3.5.3',
-    'circlify>=0.15.0',
+
 
     # We lock these dependencies because our usage
     # might be broken by their updates. We want to

truelearn/__init__.py

@@ -7,4 +7,4 @@
 # Follows Semantic Versioning 2.0.0
 # https://semver.org/
 # Append "-dev" to a version for development versions
-__version__ = "1.0.0" + "-dev"
+__version__ = "1.1.0"

truelearn/preprocessing/_wikifier.py

@@ -182,7 +182,7 @@ def __restructure_annotation(
         def page_rank_as_key(annotation: Annotation) -> float:
             """Return page rank from annotation.
 
-            This method could be used to change how the annotations
+            This method can be used to sort the annotations by page rank.
 
             Args:
                 annotation: An annotation from the wikifier API.
@@ -195,6 +195,8 @@ def page_rank_as_key(annotation: Annotation) -> float:
         def cosine_as_key(annotation: Annotation) -> float:
             """Return cosine from annotation.
 
+            This method can be used to sort the annotations by cosine similarity.
+
             Args:
                 annotation: An annotation from the wikifier API.