Feat/Inbuilt optimizer

.gitignore

@@ -1,3 +1,16 @@
 .DS_Store
 .idea/
+__pycache__
+
+*.anki*
+*.apkg
+*.colpkg
+media
+meta
+
+*.csv
+*.tsv
+*.pth
+
+meta.json
 .vscode/

__init__.py

@@ -16,7 +16,9 @@
     Config,
     run_on_configuration_change
 )
+from .optimizer import optimize, install as install_optimizer
 
+from aqt.utils import showInfo
 
 """
 Acknowledgement to Arthur Milchior, Carlos Duarte and oakkitten.
@@ -111,6 +113,10 @@ def reschedule_recent(did):
 
 menu_disperse_siblings = build_action(disperse_siblings, "Disperse all siblings")
 
+menu_install_optimizer = build_action(install_optimizer, "Install local optimizer")
+menu_show_saved_optimized = build_action(lambda _: showInfo(config.results_string()), "Show saved optimized deck settings")
+add_action_to_gear(optimize, "Optimize")
+
 menu_for_helper = mw.form.menuTools.addMenu("FSRS4Anki Helper")
 menu_for_helper.addAction(menu_auto_reschedule)
 menu_for_helper.addAction(menu_auto_disperse)
@@ -123,6 +129,8 @@ def reschedule_recent(did):
 menu_for_helper.addAction(menu_advance)
 menu_for_helper.addAction(menu_reset)
 menu_for_helper.addAction(menu_disperse_siblings)
+menu_for_helper.addAction(menu_install_optimizer)
+menu_for_helper.addAction(menu_show_saved_optimized)
 
 
 def set_free_days(day, checked):

configuration.py

@@ -3,12 +3,32 @@
 
 tag = mw.addonManager.addonFromModule(__name__)
 
+# Config
 LOAD_BALANCE = "load_balance"
 FREE_DAYS = "free_days"
 DAYS_TO_RESCHEDULE = "days_to_reschedule"
 AUTO_RESCHEDULE_AFTER_SYNC = "auto_reschedule_after_sync"
 AUTO_DISPERSE = "auto_disperse"
-
+SAVED_OPTIMIZED_PARAMETERS = "saved_optimized"
+
+# Deck params
+RETENTION_IS_NOT_OPTIMIZED = "unoptimized_retention_warning"
+REQUEST_RETENTION = "requested_retention"
+MAX_INTERVAL = "maximum_interval"
+EASY_BONUS = "easy_bonus"
+HARD_INTERVAL = "hard_interval"
+
+DEFAULT_PARAMS = {
+    "DEFAULT": {
+        "name": "global config for FSRS4Anki",
+        "w": [1, 1, 5, -0.5, -0.5, 0.2, 1.4, -0.12, 0.8, 2, -0.2, 0.2, 1],
+        REQUEST_RETENTION: 0.9,
+        MAX_INTERVAL: 36500,
+        EASY_BONUS: 1.3,
+        HARD_INTERVAL: 1.2,
+        RETENTION_IS_NOT_OPTIMIZED: False,
+    }
+}
 
 def load_config():
     return mw.addonManager.getConfig(tag)
@@ -77,4 +97,43 @@ def auto_disperse(self):
     @auto_disperse.setter
     def auto_disperse(self, value):
         self.data[AUTO_DISPERSE] = value
-        self.save()
+        self.save()
+
+    @property
+    def saved_optimized(self):
+        return self.data.get(SAVED_OPTIMIZED_PARAMETERS, DEFAULT_PARAMS)
+
+    @saved_optimized.setter
+    def saved_optimized(self, value):
+        self.data[SAVED_OPTIMIZED_PARAMETERS] = value
+        self.save()
+
+    @staticmethod
+    def result_string(result: dict[str]):
+        """Produce the pasteable config for a singular result"""
+        return \
+f"""    {{
+        // Generated, Optimized anki deck settings
+        "deckName": "{result["name"]}",
+        "w": {result["w"]},
+        "requestRetention": {result[REQUEST_RETENTION]}, {"//Un-optimized, Replace this with desired number." if result[RETENTION_IS_NOT_OPTIMIZED] else ""}
+        "maximumInterval": {result[MAX_INTERVAL]},
+        "easyBonus": {result[EASY_BONUS]},
+        "hardInterval": {result[HARD_INTERVAL]},
+    }},"""
+
+    def results_string(self):
+        """Get the config for every result"""
+        self.load()
+        results = '\n'.join(self.result_string(a) for a in self.saved_optimized.values())
+
+        return \
+f"""// Copy this into your optimizer code.
+// You can edit these values in the addon's config.
+// The full optimizer you need to paste this into can be found here
+// https://github.com/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_scheduler.js
+
+const deckParams = [
+{results}
+]
+"""