Allow users to use Stability (FSRS) instead of Interval to determine known threshold

Author: JSchoreels

.pre-commit-config.yaml

@@ -24,6 +24,8 @@ repos:
               docs/src/img/learn-now.mp4|
               docs/src/img/adding-extra-fields.mp4|
               test/data/card_collections/big_japanese_collection.anki2|
+              test/data/card_collections/card_stability_collection.anki2|
+              test/data/card_collections/card_interval_collection.anki2|
               test/data/am_dbs/big_japanese_collection.db|
           )$
       - id: check-case-conflict

ankimorphs/ankimorphs_config.py

@@ -97,6 +97,7 @@ class RawConfigKeys:
     RECALC_NUMBER_OF_MORPHS_TO_OFFSET = "recalc_number_of_morphs_to_offset"
     RECALC_MOVE_NEW_CARDS_TO_THE_END = "recalc_move_new_cards_to_the_end"
     READ_KNOWN_MORPHS_FOLDER = "read_known_morphs_folder"
+    USE_STABILITY_FOR_KNOWN_THRESHOLD = "use_stability_for_known_threshold"
     TOOLBAR_STATS_USE_KNOWN = "toolbar_stats_use_known"
     TOOLBAR_STATS_USE_SEEN = "toolbar_stats_use_seen"
     EXTRA_FIELDS_DISPLAY_INFLECTIONS = "extra_fields_display_inflections"
@@ -373,6 +374,11 @@ def __init__(self, is_default: bool = False) -> None:
                 expected_type=bool,
                 use_default=is_default,
             )
+            self.use_stability_for_known_threshold: bool = self._get_config_item(
+                key=RawConfigKeys.USE_STABILITY_FOR_KNOWN_THRESHOLD,
+                expected_type=bool,
+                use_default=is_default,
+            )
             self.toolbar_stats_use_known: bool = self._get_config_item(
                 key=RawConfigKeys.TOOLBAR_STATS_USE_KNOWN,
                 expected_type=bool,

ankimorphs/ankimorphs_globals.py

@@ -5,7 +5,7 @@
 """
 
 # Semantic Versioning https://semver.org/
-__version__ = "6.0.3"
+__version__ = "6.1.0"
 
 DEV_MODE: bool = False
 

ankimorphs/config.json

@@ -92,5 +92,6 @@
   "tag_ready": "am-ready",
   "tag_suspended_automatically": "am-suspended-automatically",
   "toolbar_stats_use_known": false,
-  "toolbar_stats_use_seen": true
+  "toolbar_stats_use_seen": true,
+  "use_stability_for_known_threshold": false
 }

ankimorphs/recalc/anki_data_utils.py

@@ -22,6 +22,7 @@ class AnkiDBRowData:
     __slots__ = (
         "card_id",
         "card_interval",
+        "card_stability",
         "card_type",
         "note_id",
         "note_fields",
@@ -35,22 +36,26 @@ def __init__(self, data_row: Sequence[Any]) -> None:
         assert isinstance(data_row[1], int)
         self.card_interval: int = data_row[1]
 
-        assert isinstance(data_row[2], int)
-        self.card_type: int = data_row[2]
+        assert isinstance(data_row[2], float)
+        self.card_stability: float = data_row[2]
 
-        assert isinstance(data_row[4], int)
-        self.note_id: int = data_row[4]
+        assert isinstance(data_row[3], int)
+        self.card_type: int = data_row[3]
 
-        assert isinstance(data_row[5], str)
-        self.note_fields: str = data_row[5]
+        assert isinstance(data_row[5], int)
+        self.note_id: int = data_row[5]
 
         assert isinstance(data_row[6], str)
-        self.note_tags: str = data_row[6]
+        self.note_fields: str = data_row[6]
+
+        assert isinstance(data_row[7], str)
+        self.note_tags: str = data_row[7]
 
 
 class AnkiCardData:  # pylint:disable=too-many-instance-attributes
     __slots__ = (
         "interval",
+        "stability",
         "type",
         "expression",
         "automatically_known_tag",
@@ -86,6 +91,7 @@ def __init__(  # pylint:disable=too-many-arguments
         not_ready_tag = am_config.tag_not_ready in tags_list
 
         self.interval = anki_row_data.card_interval
+        self.stability = anki_row_data.card_stability
         self.type = anki_row_data.card_type
         self.expression = expression
         self.automatically_known_tag = automatically_known_tag
@@ -207,7 +213,7 @@ def _get_anki_data(
 
     result: list[Sequence[Any]] = mw.col.db.all(
         """
-        SELECT cards.id, cards.ivl, cards.type, cards.queue, notes.id, notes.flds, notes.tags
+        SELECT cards.id, cards.ivl, COALESCE(json_extract(cards.data, '$.s'), 0.0), cards.type, cards.queue, notes.id, notes.flds, notes.tags
         FROM cards
         INNER JOIN notes ON
             cards.nid = notes.id

ankimorphs/recalc/caching.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import csv
+import math
 from pathlib import Path
 from typing import Any
 
@@ -91,15 +92,7 @@ def cache_anki_data(  # pylint:disable=too-many-locals, too-many-branches, too-m
                 max_value=card_amount,
             )
             card_data: AnkiCardData = cards_data_dict[card_id]
-
-            if card_data.automatically_known_tag or card_data.manually_known_tag:
-                highest_interval = am_config.interval_for_known_morphs
-            elif card_data.type == 1:  # 1: learning
-                # cards in the 'learning' state have an interval of zero, but we don't
-                # want to treat them as 'unknown', so we change the value manually.
-                highest_interval = 1
-            else:
-                highest_interval = card_data.interval
+            card_memory_strength = _get_card_memory_strength(am_config, card_data)
 
             card_table_data.append(
                 {
@@ -120,7 +113,7 @@ def cache_anki_data(  # pylint:disable=too-many-locals, too-many-branches, too-m
                         "lemma": morph.lemma,
                         "inflection": morph.inflection,
                         "highest_lemma_learning_interval": None,  # updates later
-                        "highest_inflection_learning_interval": highest_interval,
+                        "highest_inflection_learning_interval": card_memory_strength,
                     }
                 )
                 card_morph_map_table_data.append(
@@ -131,7 +124,7 @@ def cache_anki_data(  # pylint:disable=too-many-locals, too-many-branches, too-m
                     }
                 )
 
-    if am_config.read_known_morphs_folder is True:
+    if am_config.read_known_morphs_folder:
         progress_utils.background_update_progress(label="Importing known morphs")
         morph_table_data += _get_morphs_from_files(am_config)
 
@@ -146,6 +139,29 @@ def cache_anki_data(  # pylint:disable=too-many-locals, too-many-branches, too-m
     am_db.con.close()
 
 
+def _get_card_memory_strength(
+    am_config: AnkiMorphsConfig, card_data: AnkiCardData
+) -> int:
+    if card_data.automatically_known_tag or card_data.manually_known_tag:
+        return am_config.interval_for_known_morphs
+
+    if card_data.type == 0:  # 0: new
+        # force a zero value as an early exit and to prevent edge cases.
+        return 0
+
+    if card_data.type == 1:  # 1: learning
+        # cards in the 'learning' state have an interval of zero, but we don't
+        # want to treat them as 'unknown', so we change the value manually.
+        return 1
+
+    if am_config.use_stability_for_known_threshold:
+        # Stability being a float, we floor it to get an integer value of "secured" interval, and we
+        # give a minimum stability of 1 since the card is not new
+        return max(1, math.floor(card_data.stability))
+
+    return card_data.interval
+
+
 def _get_morphs_from_files(am_config: AnkiMorphsConfig) -> list[dict[str, Any]]:
     assert mw is not None
 

ankimorphs/settings/settings_general_tab.py

@@ -34,6 +34,7 @@ def __init__(
         self._raw_config_key_to_check_box: dict[str, QCheckBox] = {
             RawConfigKeys.RECALC_ON_SYNC: self.ui.recalcBeforeSyncCheckBox,
             RawConfigKeys.READ_KNOWN_MORPHS_FOLDER: self.ui.recalcReadKnownMorphsFolderCheckBox,
+            RawConfigKeys.USE_STABILITY_FOR_KNOWN_THRESHOLD: self.ui.useStabilityThresholdForKnownMorphsCheckBox,
             RawConfigKeys.HIDE_RECALC_TOOLBAR: self.ui.hideRecalcCheckBox,
             RawConfigKeys.HIDE_LEMMA_TOOLBAR: self.ui.hideLemmaCheckBox,
             RawConfigKeys.HIDE_INFLECTION_TOOLBAR: self.ui.hideInflectionCheckBox,

ankimorphs/ui/settings_dialog.ui

@@ -152,6 +152,13 @@
               </item>
              </layout>
             </item>
+            <item>
+             <widget class="QCheckBox" name="useStabilityThresholdForKnownMorphsCheckBox">
+              <property name="text">
+               <string>Use FSRS card stability instead of card interval for known threshold</string>
+              </property>
+             </widget>
+            </item>
             <item>
              <widget class="QCheckBox" name="recalcReadKnownMorphsFolderCheckBox">
               <property name="text">

ankimorphs/ui/settings_dialog_ui.py

@@ -80,6 +80,9 @@ def setupUi(self, SettingsDialog):
         spacerItem1 = QtWidgets.QSpacerItem(40, 20, QtWidgets.QSizePolicy.Policy.Expanding, QtWidgets.QSizePolicy.Policy.Minimum)
         self.horizontalLayout_6.addItem(spacerItem1)
         self.verticalLayout_17.addLayout(self.horizontalLayout_6)
+        self.useStabilityThresholdForKnownMorphsCheckBox = QtWidgets.QCheckBox(parent=self.groupBox_3)
+        self.useStabilityThresholdForKnownMorphsCheckBox.setObjectName("useStabilityThresholdForKnownMorphsCheckBox")
+        self.verticalLayout_17.addWidget(self.useStabilityThresholdForKnownMorphsCheckBox)
         self.recalcReadKnownMorphsFolderCheckBox = QtWidgets.QCheckBox(parent=self.groupBox_3)
         self.recalcReadKnownMorphsFolderCheckBox.setObjectName("recalcReadKnownMorphsFolderCheckBox")
         self.verticalLayout_17.addWidget(self.recalcReadKnownMorphsFolderCheckBox)
@@ -964,6 +967,7 @@ def retranslateUi(self, SettingsDialog):
         self.groupBox_3.setTitle(_translate("SettingsDialog", "Known Morphs"))
         self.label_16.setText(_translate("SettingsDialog", "Morphs are considered known when they have a learning interval of"))
         self.label_17.setText(_translate("SettingsDialog", "days or more"))
+        self.useStabilityThresholdForKnownMorphsCheckBox.setText(_translate("SettingsDialog", "Use FSRS card stability instead of card interval for known threshold"))
         self.recalcReadKnownMorphsFolderCheckBox.setText(_translate("SettingsDialog", "Read files in \'known-morphs\' folder and register morphs as known"))
         self.groupBox_2.setTitle(_translate("SettingsDialog", "On Sync"))
         self.recalcBeforeSyncCheckBox.setText(_translate("SettingsDialog", "Automatically Recalc before Anki sync"))

docs/src/contributors.md

@@ -6,7 +6,7 @@ know, and I'll add you ;)
 
 ### Code contribution
 
-mortii, Vilhelm-Ian, xofm31, Jcuhfehl, schiozzone, Tartee, wolearyc, mdraves91, hans, RobHelgeson.
+mortii, Vilhelm-Ian, xofm31, Jcuhfehl, schiozzone, Tartee, wolearyc, mdraves91, hans, RobHelgeson, JSchoreels.
 
 ### Docs contribution