From 9d79c9b08a571638968f542b75dafa86a712731b Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Sun, 13 Aug 2023 16:32:09 +0530 Subject: [PATCH 01/16] Update README.md --- README.md | 120 +++++++++++------------------------------------------- 1 file changed, 24 insertions(+), 96 deletions(-) diff --git a/README.md b/README.md index c0a2984..7590fd0 100644 --- a/README.md +++ b/README.md @@ -64,21 +64,30 @@ For more detail on the mechanism of the FSRS algorithm, please see my papers: [A 中文版请见：[FSRS4Anki 使用指北](https://zhuanlan.zhihu.com/p/636564830) -## 1 Quick Start +## How to Get Started? -### 1.1 Enable Anki's V3 Scheduler +To get started with FSRS, you'll need to follow a two-step process. + +- First, you'll need to enable the FSRS scheduler in your Anki application. +- Next, you'll need to train the FSRS parameters for your collection, tailoring the algorithm to your learning patterns. + +Let's now discuss both of these steps in detail. + +### Step 1: Enabling the FSRS Scheduler + +#### 1.1 Enable Anki's V3 Scheduler Preferences > Review > Enable V3 Scheduler ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/8f91fba8-9b8b-405c-8aa9-42123ba5faeb) -### 1.2 Paste FSRS Scheduler Code +#### 1.2 Paste FSRS Scheduler Code In the deck options, find the Advanced Settings column, and paste the code in [fsrs4anki_scheduler.js](https://github.com/open-spaced-repetition/fsrs4anki/releases/latest) into the Custom Scheduling field: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5c292f91-8845-4f8c-ac42-55f9a0f2946e) -Idealy, you've now started using the FSRS4Anki Scheduler. If you're unsure, you can change this part of the code: +Ideally, the FSRS4Anki Scheduler should be now active. If you want to confirm this, you can change this part of the code: ```javascript const display_memory_state = false; @@ -94,16 +103,13 @@ Then open any deck for review and you'll see: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/0a5d4561-6052-45f3-91a5-5f21dd6497b9) -This shows that your FSRS is running normally. You can then change the code back and the message will no longer display. - -## 2 Advanced Usage +This shows that the FSRS scheduler is running normally. You can then change the code back and the message will no longer display. -### 2.1 Generate Personalized Parameters +### Step 2: Training FSRS Parameters for Your Collection -You can generate parameters in a variety of ways depending on which method you prefer. -For the most up to date methods please check the [releases](https://github.com/open-spaced-repetition/fsrs4anki/releases/tag/v3.26.2). +For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned here (provide link). -### 2.1a Google Colab +#### Training using Google Colab Open the [optimizer's notebook](https://github.com/open-spaced-repetition/fsrs4anki/releases/latest) and click on Open in Colab to run the optimizer on Google Colab. You don't need to configure the coding environment yourself and you can use Google's machines for free (you'll need to register a Google account): @@ -127,102 +133,24 @@ Wait for the code to finish in section 2.3, then copy the personalized parameter ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/8df1d210-73c3-4194-9b3b-256279c4c2fd) -Replace the parameters in the FSRS code you copied earlier. - -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/70b3b45a-f014-4574-81eb-cad6d19f93d9) - -⚠️Note: when replacing these parameters, be sure not to delete the comma at the end. - -### 2.1b Website +#### Training using Hugging Face Simply upload your exported decks to this website and it will optimise it for you. https://huggingface.co/spaces/open-spaced-repetition/fsrs4anki_app ![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/a03217f0-6627-4854-971f-f2bc9d14da5c) +After training the parameters by either of the methods above, replace the parameters in the FSRS code that you copied earlier. -### 2.1c Command Line - -There is a python package for the optimizer. This package has torch as a dependency, so note it might take about half a gigabyte of space. - -#### Installation - -Install the package with the command: - -``` -python -m pip install fsrs-optimizer -``` - -You should upgrade regularly to make sure you have the most recent version of FSRS-Optimizer: - -``` -python -m pip install fsrs-optimizer --upgrade -``` - -#### Usage - -Export your deck and cd into the folder to which you exported it. -Then you can run: - -``` -python -m fsrs-optimizer "package.(colpkg/apkg)" -``` - -You can also list multiple files, e.g.: - -``` -python -m fsrs-optimizer "file1.akpg" "file2.apkg" -``` - -Wildcards are supported: - -``` -python -m fsrs-optimizer *.apkg -``` - -There are certain options which are as follows: - -``` -options: - -h, --help show this help message and exit - -y, --yes, --no-yes If set automatically defaults on all stdin settings. - -o OUT, --out OUT File to APPEND the automatically generated profile to. -``` - -#### Expected Functionality - -![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/ac2e8ae0-726c-46fd-b110-0701fa87cb66) -![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/1fe8b0bb-7ac0-4a31-b594-465239ea3a1e) - -### 2.1d Anki Addon **EXPERIMENTAL** - -Download and install [this](https://github.com/Luc-mcgrady/fsrs4anki-helper/tree/optimizer) version of the anki helper addon either by git cloning it into the anki addons folder or [downloading it as a zip](https://github.com/Luc-mcgrady/fsrs4anki-helper/archive/refs/heads/optimizer.zip) and extracting the zip into the anki addons folder. - -Install the optimizer locally. -![image](https://user-images.githubusercontent.com/63685643/236647263-b1e57db1-4ad0-441b-9abe-91cbd36c13b0.png) -Please pay attention to the popup. -![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/ebe42eb4-f63d-4e58-b593-c173891dd29c) - - -After that has downloaded and installed you should be able to run the optimizer from within anki. -Press the cog next to any given deck and hit the optimize option. -![image](https://user-images.githubusercontent.com/63685643/236647245-757ca803-b8cf-41cd-a1ae-8ed9af852ad8.png) -Anki may then hang a small while while it loads the optimizer. - -![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/e160e5ba-c51f-46a9-9813-9dceb18e47ff) -Hit yes to find the optimum retention, Hit no to not or hit cancel to pick a different deck. +![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/70b3b45a-f014-4574-81eb-cad6d19f93d9) -If all is well you should then get a toolbar popup which tells you the progress of the optimization. -![image](https://user-images.githubusercontent.com/63685643/236647707-38101c10-ccd2-4417-aa3f-f2e4e10bb4c3.png) +⚠️Note: when replacing these parameters, be sure not to delete the comma at the end. -You should then get the stats in a format which is easy to copy into the javascript scheduler. -![image](https://user-images.githubusercontent.com/63685643/236647716-bfd8099a-6e7f-46e7-bce8-e18e75e75d46.png) -These values are saved in the addons config file which can be found and edited in anki if you want to change the retention manually for example. -![image](https://user-images.githubusercontent.com/63685643/236647915-7a865bb0-f057-4404-af0f-27c81be99082.png) +After performing the above steps, you are ready to start using FSRS. Just start reviewing and FSRS will do its work. -If there are any issues with this please mention them on this pull request [here](https://github.com/open-spaced-repetition/fsrs4anki-helper/pull/91). +For better results, you are advised to reschedule your existing cards using the FSRS4Anki helper add-on. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. -### 2.2 Deck Parameter Settings +## Configuring Different Parameters for Different Decks You can also generate different parameters for different decks and configure them separately in the code. In the default configuration, `deckParams` already contains three groups of parameters. From cdabfab2772626a5ef26e62fa05112d40f0a2541 Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Sun, 13 Aug 2023 16:41:19 +0530 Subject: [PATCH 02/16] Update README.md --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7590fd0..9c56dbc 100644 --- a/README.md +++ b/README.md @@ -25,17 +25,13 @@ _✨ A modern Anki [custom scheduling](https://faqs.ankiweb.net/the-2021-schedul - [FSRS4Anki](#fsrs4anki) - [Introduction](#introduction) -- [1 Quick Start](#1-quick-start) - - [1.1 Enable Anki's V3 Scheduler](#11-enable-ankis-v3-scheduler) - - [1.2 Paste FSRS Scheduler Code](#12-paste-fsrs-scheduler-code) -- [2 Advanced Usage](#2-advanced-usage) - - [2.1 Generate Personalized Parameters](#21-generate-personalized-parameters) - - [2.1a Google Colab](#21a-google-colab) - - [2.1b Website](#21b-website) - - [2.1c Command Line](#21c-command-line) - - [2.1d Anki Addon](#21d-anki-addon-experimental) **EXPERIMENTAL** - - [2.2 Deck Parameter Settings](#22-deck-parameter-settings) -- [3 Using the Helper Add-on](#3-using-the-helper-add-on) +- [How to Get Started?](#how-to-get-started) + - [Step 1: Enabling the FSRS Scheduler](#step-1-enabling-the-fsrs-scheduler) + - [Step 2: Training FSRS Parameters for Your Collection](#step-2-training-fsrs-parameters-for-your-collection) + - [Training using Google Colab](#training-using-google-colab) + - [Training using Hugging Face](#training-using-hugging-face) +- [Configuring Different Parameters for Different Decks](#configuring-different-parameters-for-different-decks) +- [Using the Helper Add-on](#using-the-helper-add-on) - [FAQ](#faq) - [Compatibility](#compatibility) - [Contribute](#contribute) @@ -198,7 +194,7 @@ If there are some decks you don't want to use FSRS with, you can add their names const skip_decks = ["MainDeck3", "MainDeck4::SubDeck"]; ``` -## 3 Using the Helper Add-on +## Using the Helper Add-on Please see: [FSRS4Anki Helper](https://github.com/open-spaced-repetition/fsrs4anki-helper) From 74664c73d641020fdfc5dc8ea299df72b507e381 Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Sun, 13 Aug 2023 17:14:14 +0530 Subject: [PATCH 03/16] Update README.md --- README.md | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9c56dbc..74904d1 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,7 @@ _✨ A modern Anki [custom scheduling](https://faqs.ankiweb.net/the-2021-schedul - [Introduction](#introduction) - [How to Get Started?](#how-to-get-started) - [Step 1: Enabling the FSRS Scheduler](#step-1-enabling-the-fsrs-scheduler) - - [Step 2: Training FSRS Parameters for Your Collection](#step-2-training-fsrs-parameters-for-your-collection) - - [Training using Google Colab](#training-using-google-colab) - - [Training using Hugging Face](#training-using-hugging-face) + - [Step 2: Personalizing FSRS](#step-2-personalizing-fsrs) - [Configuring Different Parameters for Different Decks](#configuring-different-parameters-for-different-decks) - [Using the Helper Add-on](#using-the-helper-add-on) - [FAQ](#faq) @@ -48,13 +46,7 @@ The optimizer applies *Maximum Likelihood Estimation* and *Backpropagation Throu For more detail on the mechanism of the FSRS algorithm, please see my papers: [A Stochastic Shortest Path Algorithm for Optimizing Spaced Repetition Scheduling (free access)](https://www.maimemo.com/paper/) and [Optimizing Spaced Repetition Schedule by Capturing the Dynamics of Memory (submit request)](https://www.researchgate.net/publication/369045947_Optimizing_Spaced_Repetition_Schedule_by_Capturing_the_Dynamics_of_Memory). -[FSRS4Anki Helper](https://github.com/open-spaced-repetition/fsrs4anki-helper) is an Anki add-on that supports the FSRS4Anki Scheduler. It has six features: -1. **Reschedule** cards based on their entire review histories. -2. **Postpone** due cards whose retention is higher than your target. -3. **Advance** undue cards whose retention is lower than your target. -4. **Balance** the load during rescheduling. -5. **No Anki** on Free Days (such as weekends). -6. **Disperse** Siblings (cards with the same note) to avoid interference & reminder. +FSRS4Anki Helper is an Anki add-on that complements the FSRS4Anki Scheduler. You can read about it here: https://github.com/open-spaced-repetition/fsrs4anki-helper # Tutorial @@ -65,7 +57,7 @@ For more detail on the mechanism of the FSRS algorithm, please see my papers: [A To get started with FSRS, you'll need to follow a two-step process. - First, you'll need to enable the FSRS scheduler in your Anki application. -- Next, you'll need to train the FSRS parameters for your collection, tailoring the algorithm to your learning patterns. +- Next, you'll need to personalize FSRS to suit your learning patterns. Let's now discuss both of these steps in detail. @@ -73,13 +65,14 @@ Let's now discuss both of these steps in detail. #### 1.1 Enable Anki's V3 Scheduler -Preferences > Review > Enable V3 Scheduler +Go to Tools > Preferences > Review > Enable V3 Scheduler. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/8f91fba8-9b8b-405c-8aa9-42123ba5faeb) #### 1.2 Paste FSRS Scheduler Code -In the deck options, find the Advanced Settings column, and paste the code in [fsrs4anki_scheduler.js](https://github.com/open-spaced-repetition/fsrs4anki/releases/latest) into the Custom Scheduling field: +- Go to the following page and copy all of the code.: https://github.com/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_scheduler.js +- In Anki, open the deck options of any deck (it doesn’t matter which deck). Find the Advanced Settings column, and paste the code you copied into the Custom Scheduling field: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5c292f91-8845-4f8c-ac42-55f9a0f2946e) @@ -101,46 +94,54 @@ Then open any deck for review and you'll see: This shows that the FSRS scheduler is running normally. You can then change the code back and the message will no longer display. -### Step 2: Training FSRS Parameters for Your Collection +### Step 2: Personalizing FSRS For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned here (provide link). -#### Training using Google Colab +
+ Method 1: Training using Google Colab Open the [optimizer's notebook](https://github.com/open-spaced-repetition/fsrs4anki/releases/latest) and click on Open in Colab to run the optimizer on Google Colab. You don't need to configure the coding environment yourself and you can use Google's machines for free (you'll need to register a Google account): ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5f5af21b-583d-496c-9bad-0eef0b1fb7a6) -After opening it in Colab, switch to the folder tab. Once the Optimizer connects to Google's machine, you can right-click to upload your deck file/collection file. When exporting these files, make sure to tick "Include scheduling information" and "Support older Anki versions". +After opening it in Colab, switch to the folder tab. Once the Optimizer connects to Google's machine, you can right-click to upload your deck file/collection file. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/66f9e323-fca8-4553-bcb2-b2e511fcf559) +When exporting these files, make sure to select "Include scheduling information" and "Support older Anki versions". You don't need to include media. + ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/65da272d-7a01-4c46-a1d9-093e548f1a2d) -After it's uploaded, change the `filename` in the notebook to the name of your uploaded file. And set your `timezone` and `next_day_starts_at`. +- After uploading the file, replace the `collection-2022-09-18@13-21-58.colpkg` with the name of your uploaded file. +- Replace `Asia/Shanghai` with your timezone. The notebook has a link to the list of timezones. +- Also, replace the value of `next_day_starts_at`. To find out this value, Go to `Tools > Preferences > Review > Next day starts at` in your Anki. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/f344064c-4ccf-4884-94d0-fc0a1d3c3c24) -Then click "Run All". +Then, run the optimizer by either pressing `Ctrl+F9` or going to `Runtime > Run all`. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/77947790-6916-4a99-ba28-8da42fd5b350) -Wait for the code to finish in section 2.3, then copy the personalized parameters that were output. +Wait for the code to finish running. Then, go to section 2.2 (Result), where the optimized parameters will be available. Copy these parameters. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/8df1d210-73c3-4194-9b3b-256279c4c2fd) +
-#### Training using Hugging Face - +
+ Method 2: Training using Hugging Face + Simply upload your exported decks to this website and it will optimise it for you. https://huggingface.co/spaces/open-spaced-repetition/fsrs4anki_app ![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/a03217f0-6627-4854-971f-f2bc9d14da5c) +
After training the parameters by either of the methods above, replace the parameters in the FSRS code that you copied earlier. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/70b3b45a-f014-4574-81eb-cad6d19f93d9) -⚠️Note: when replacing these parameters, be sure not to delete the comma at the end. +⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. Yes, the code will break without them. After performing the above steps, you are ready to start using FSRS. Just start reviewing and FSRS will do its work. From fc5d9944c6b5554cd08ecdfeebf26b0f4cc593c9 Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Mon, 14 Aug 2023 22:20:50 +0530 Subject: [PATCH 04/16] Update README.md --- README.md | 57 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 41 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 74904d1..d88d416 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,10 @@ For more detail on the mechanism of the FSRS algorithm, please see my papers: [A FSRS4Anki Helper is an Anki add-on that complements the FSRS4Anki Scheduler. You can read about it here: https://github.com/open-spaced-repetition/fsrs4anki-helper -# Tutorial +# How to Get Started? 中文版请见：[FSRS4Anki 使用指北](https://zhuanlan.zhihu.com/p/636564830) -## How to Get Started? - To get started with FSRS, you'll need to follow a two-step process. - First, you'll need to enable the FSRS scheduler in your Anki application. @@ -61,22 +59,24 @@ To get started with FSRS, you'll need to follow a two-step process. Let's now discuss both of these steps in detail. -### Step 1: Enabling the FSRS Scheduler +## Step 1: Enabling the FSRS Scheduler -#### 1.1 Enable Anki's V3 Scheduler +### 1.1 Enable Anki's V3 Scheduler Go to Tools > Preferences > Review > Enable V3 Scheduler. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/8f91fba8-9b8b-405c-8aa9-42123ba5faeb) -#### 1.2 Paste FSRS Scheduler Code +### 1.2 Paste FSRS Scheduler Code - Go to the following page and copy all of the code.: https://github.com/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_scheduler.js - In Anki, open the deck options of any deck (it doesn’t matter which deck). Find the Advanced Settings column, and paste the code you copied into the Custom Scheduling field: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5c292f91-8845-4f8c-ac42-55f9a0f2946e) -Ideally, the FSRS4Anki Scheduler should be now active. If you want to confirm this, you can change this part of the code: +- Ensure that the learning and re-learning steps are not longer than 1 day in any deck that you want to use with FSRS. Other settings, such as “Graduating interval” and “Easy interval”, don’t matter. For more details about which Anki settings matter and which are obsolete, see the [FAQs](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ). + +After you perform the above steps, the FSRS4Anki Scheduler should ideally be active. If you want to confirm this, you can change this part of the code: ```javascript const display_memory_state = false; @@ -88,24 +88,35 @@ to: const display_memory_state = true; ``` -Then open any deck for review and you'll see: +Then open any deck for review and you'll see the following message: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/0a5d4561-6052-45f3-91a5-5f21dd6497b9) +If you don’t see D, S and R, and only see “FSRS enabled”, this means that the card is in the “learning” or “relearning” stage, not in the “review” stage. + This shows that the FSRS scheduler is running normally. You can then change the code back and the message will no longer display. ### Step 2: Personalizing FSRS +To ensure that FSRS suits your learning needs, you'll need to follow a two-step process. + +- First, you'll need to train the FSRS parameters for your collection, tailoring the algorithm to your learning patterns.. +- Next, you'll need to choose the desired retention rate. + +Let's now discuss both of these steps in detail. + +#### Step 2.1 Training the FSRS Parameters + For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned here (provide link).
Method 1: Training using Google Colab -Open the [optimizer's notebook](https://github.com/open-spaced-repetition/fsrs4anki/releases/latest) and click on Open in Colab to run the optimizer on Google Colab. You don't need to configure the coding environment yourself and you can use Google's machines for free (you'll need to register a Google account): +Open the [optimizer's notebook](https://colab.research.google.com/github/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_optimizer.ipynb). You don't need to configure the coding environment yourself and you can use Google's machines for free (you'll need to have a Google account): ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5f5af21b-583d-496c-9bad-0eef0b1fb7a6) -After opening it in Colab, switch to the folder tab. Once the Optimizer connects to Google's machine, you can right-click to upload your deck file/collection file. +After the Colab website opens, switch to the folder tab. Once the Optimizer connects to Google's machines, you can right-click to upload your deck file/collection file exported from Anki. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/66f9e323-fca8-4553-bcb2-b2e511fcf559) @@ -114,7 +125,7 @@ When exporting these files, make sure to select "Include scheduling information" ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/65da272d-7a01-4c46-a1d9-093e548f1a2d) - After uploading the file, replace the `collection-2022-09-18@13-21-58.colpkg` with the name of your uploaded file. -- Replace `Asia/Shanghai` with your timezone. The notebook has a link to the list of timezones. +- Replace `Asia/Shanghai` with your timezone. The notebook contains a link to the list of timezones. - Also, replace the value of `next_day_starts_at`. To find out this value, Go to `Tools > Preferences > Review > Next day starts at` in your Anki. ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/f344064c-4ccf-4884-94d0-fc0a1d3c3c24) @@ -141,11 +152,25 @@ After training the parameters by either of the methods above, replace the parame ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/70b3b45a-f014-4574-81eb-cad6d19f93d9) -⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. Yes, the code will break without them. +⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. The code will break without them. + +#### Step 2.2: Choosing the desired retention rate and maximum interval + +Now, you need to choose your `requestRetention`, which denotes the retention rate (i.e. the fraction of the cards recalled successfully) that FSRS will try to achieve. + +As an aid in deciding this value, you can view your past retention rate in Anki stats. For example, if your retention rate in the past was 90%, you can set 0.90 as your `requestRetention`. + +You can set a higher `requestRetention` but keep in mind that as you increase the `requestRetention` above 0.90, the review load (reviews/day) would increase very rapidly. For the same reason, it is not advisable to use a `requestRetention` greater than 0.97. + +After deciding the value of requestRetention, put this into the scheduler code. At the same time, decide the value of `maximumInterval`, which is the maximum interval any card is allowed to attain. The value in the FSRS scheduler code overrides the value set in Anki's deck options. + +![ Add screenshot ] After performing the above steps, you are ready to start using FSRS. Just start reviewing and FSRS will do its work. -For better results, you are advised to reschedule your existing cards using the FSRS4Anki helper add-on. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. +For better results, you are advised to reschedule your existing cards using the FSRS4Anki Helper add-on. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. + +Read about the add-on here: https://github.com/open-spaced-repetition/fsrs4anki-helper ## Configuring Different Parameters for Different Decks @@ -201,7 +226,7 @@ Please see: [FSRS4Anki Helper](https://github.com/open-spaced-repetition/fsrs4an # FAQ -Here collect some questions from issues, forums, and others: [FAQ](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ) +Here, I have collected some frequently asked questions: [FAQ](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ) # Compatibility @@ -212,9 +237,9 @@ Some add-ons modify the scheduling of Anki, which would cause conflict with FSRS |[Advanced Review Bottom Bar](https://ankiweb.net/shared/info/1136455830)|Yes✅|Please use the latest version.| |[Incremental Reading v4.11.3 (unofficial clone)](https://ankiweb.net/shared/info/999215520)|No❌|It shows the interval given by Anki's built-in scheduler, not the custom scheduler.| | [Auto Ease Factor](https://ankiweb.net/shared/info/1672712021)|Yes✅|`Ease Factor` doesn't affect the interval given by FSRS.| -| [Delay siblings](https://ankiweb.net/shared/info/1369579727) |Yes✅|Delay siblings will modify the interval give by FSRS.| +| [Delay siblings](https://ankiweb.net/shared/info/1369579727) |No❌|Delay siblings will modify the intervals given by FSRS. However, FSRS4Anki Helper add-on has a similar feature that works better with FSRS. So, you should use the FSRS4Anki Helper add-on instead.| | [autoLapseNewInterval](https://ankiweb.net/shared/info/372281481) |Yes✅|`New Interval` doesn't affect the interval given by FSRS.| -| [Straight Reward](https://ankiweb.net/shared/info/957961234) |Yes✅|`Ease Factor` doesn't affect the interval given by FSRS.| +| [Straight Reward](https://ankiweb.net/shared/info/957961234) |No❌|`Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| | [Pass/Fail](https://ankiweb.net/shared/info/876946123) |Yes✅| `Pass` is the equivalent of `Good`.| Let me know via [issues](https://github.com/open-spaced-repetition/fsrs4anki/issues) if I miss any add-ons. From bebed3f893a6ac1ebaab5108fd0062f207c34ecc Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Mon, 14 Aug 2023 22:36:45 +0530 Subject: [PATCH 05/16] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d88d416..aa7eb31 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ This shows that the FSRS scheduler is running normally. You can then change the To ensure that FSRS suits your learning needs, you'll need to follow a two-step process. - First, you'll need to train the FSRS parameters for your collection, tailoring the algorithm to your learning patterns.. -- Next, you'll need to choose the desired retention rate. +- Next, you'll need to choose the desired retention rate and maximum interval. Let's now discuss both of these steps in detail. @@ -109,6 +109,8 @@ Let's now discuss both of these steps in detail. For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned here (provide link). +However, the FSRS optimizer requires a minimum of 2000 reviews to produce accurate results. If you don't have enough data, you can skip this step and use the default parameters, which are already entered in the scheduler code. +
Method 1: Training using Google Colab From 87df1bbfcc69a7e2ea1657e7b78a3dc1f51e0455 Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Mon, 14 Aug 2023 22:38:08 +0530 Subject: [PATCH 06/16] Correct heading level --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aa7eb31..4790eb0 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ If you don’t see D, S and R, and only see “FSRS enabled”, this means that This shows that the FSRS scheduler is running normally. You can then change the code back and the message will no longer display. -### Step 2: Personalizing FSRS +## Step 2: Personalizing FSRS To ensure that FSRS suits your learning needs, you'll need to follow a two-step process. @@ -105,7 +105,7 @@ To ensure that FSRS suits your learning needs, you'll need to follow a two-step Let's now discuss both of these steps in detail. -#### Step 2.1 Training the FSRS Parameters +### Step 2.1 Training the FSRS Parameters For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned here (provide link). @@ -156,7 +156,7 @@ After training the parameters by either of the methods above, replace the parame ⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. The code will break without them. -#### Step 2.2: Choosing the desired retention rate and maximum interval +### Step 2.2: Choosing the desired retention rate and maximum interval Now, you need to choose your `requestRetention`, which denotes the retention rate (i.e. the fraction of the cards recalled successfully) that FSRS will try to achieve. From 86546d846eb00d65e5658cb4ce8a59df3b321f7e Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Mon, 14 Aug 2023 23:10:33 +0530 Subject: [PATCH 07/16] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4790eb0..9d5d899 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,9 @@ The scheduler is based on a variant of the DSR (Difficulty, Stability, Retrievab The optimizer applies *Maximum Likelihood Estimation* and *Backpropagation Through Time* to estimate the stability of memory and learn the laws of memory from time-series review logs. Then, it can find the optimal retention to minimize the repetitions via the stochastic shortest path algorithm. -For more detail on the mechanism of the FSRS algorithm, please see my papers: [A Stochastic Shortest Path Algorithm for Optimizing Spaced Repetition Scheduling (free access)](https://www.maimemo.com/paper/) and [Optimizing Spaced Repetition Schedule by Capturing the Dynamics of Memory (submit request)](https://www.researchgate.net/publication/369045947_Optimizing_Spaced_Repetition_Schedule_by_Capturing_the_Dynamics_of_Memory). +For more detail on the mechanism of the FSRS algorithm, please see my papers: +- [A Stochastic Shortest Path Algorithm for Optimizing Spaced Repetition Scheduling](https://www.maimemo.com/paper/) (free access), and +- [Optimizing Spaced Repetition Schedule by Capturing the Dynamics of Memory](https://www.researchgate.net/publication/369045947_Optimizing_Spaced_Repetition_Schedule_by_Capturing_the_Dynamics_of_Memory) (submit request). FSRS4Anki Helper is an Anki add-on that complements the FSRS4Anki Scheduler. You can read about it here: https://github.com/open-spaced-repetition/fsrs4anki-helper @@ -156,6 +158,8 @@ After training the parameters by either of the methods above, replace the parame ⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. The code will break without them. +Even after you start using FSRS, you should re-train the parameters once every month. This will ensure that FSRS works well with your current patterns of learning. + ### Step 2.2: Choosing the desired retention rate and maximum interval Now, you need to choose your `requestRetention`, which denotes the retention rate (i.e. the fraction of the cards recalled successfully) that FSRS will try to achieve. From 6381073c75f3ecebb2c60bbe103ffcff7a0c6f0f Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Tue, 15 Aug 2023 09:58:50 +0530 Subject: [PATCH 08/16] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d5d899..3c84c1a 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ Then open any deck for review and you'll see the following message: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/0a5d4561-6052-45f3-91a5-5f21dd6497b9) -If you don’t see D, S and R, and only see “FSRS enabled”, this means that the card is in the “learning” or “relearning” stage, not in the “review” stage. +If you don’t see D, S and R, and only see “FSRS enabled”, it means that the card is in the “learning” or “relearning” stage, not in the “review” stage. This shows that the FSRS scheduler is running normally. You can then change the code back and the message will no longer display. @@ -242,7 +242,7 @@ Some add-ons modify the scheduling of Anki, which would cause conflict with FSRS | ------------------------------------------------------------ |-------------------| ------- | |[Advanced Review Bottom Bar](https://ankiweb.net/shared/info/1136455830)|Yes✅|Please use the latest version.| |[Incremental Reading v4.11.3 (unofficial clone)](https://ankiweb.net/shared/info/999215520)|No❌|It shows the interval given by Anki's built-in scheduler, not the custom scheduler.| -| [Auto Ease Factor](https://ankiweb.net/shared/info/1672712021)|Yes✅|`Ease Factor` doesn't affect the interval given by FSRS.| +| [Auto Ease Factor](https://ankiweb.net/shared/info/1672712021)|No❌|`Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| | [Delay siblings](https://ankiweb.net/shared/info/1369579727) |No❌|Delay siblings will modify the intervals given by FSRS. However, FSRS4Anki Helper add-on has a similar feature that works better with FSRS. So, you should use the FSRS4Anki Helper add-on instead.| | [autoLapseNewInterval](https://ankiweb.net/shared/info/372281481) |Yes✅|`New Interval` doesn't affect the interval given by FSRS.| | [Straight Reward](https://ankiweb.net/shared/info/957961234) |No❌|`Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| From dea59d70189ac211d736b8986707e5c17aec5c4c Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Tue, 15 Aug 2023 12:27:59 +0530 Subject: [PATCH 09/16] Update README.md --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 3c84c1a..b9e71ad 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,11 @@ _✨ A modern Anki [custom scheduling](https://faqs.ankiweb.net/the-2021-schedul FSRS4Anki consists of two main parts: scheduler and optimizer. -The scheduler is based on a variant of the DSR (Difficulty, Stability, Retrievability) model, which is used to predict memory states. The scheduler aims to achieve the requested retention for each card and each review. +The scheduler replaces the Anki's built-in scheduler and schedules the cards according to the FSRS algorithm. -The optimizer applies *Maximum Likelihood Estimation* and *Backpropagation Through Time* to estimate the stability of memory and learn the laws of memory from time-series review logs. Then, it can find the optimal retention to minimize the repetitions via the stochastic shortest path algorithm. +The optimizer uses machine learning to learn your memory patterns and finds parameters that provide the best fit to your review history. -For more detail on the mechanism of the FSRS algorithm, please see my papers: +For more details about the FSRS algorithm, please read the [Wiki](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm). If you are interested, you can also read my papers: - [A Stochastic Shortest Path Algorithm for Optimizing Spaced Repetition Scheduling](https://www.maimemo.com/paper/) (free access), and - [Optimizing Spaced Repetition Schedule by Capturing the Dynamics of Memory](https://www.researchgate.net/publication/369045947_Optimizing_Spaced_Repetition_Schedule_by_Capturing_the_Dynamics_of_Memory) (submit request). @@ -94,15 +94,15 @@ Then open any deck for review and you'll see the following message: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/0a5d4561-6052-45f3-91a5-5f21dd6497b9) -If you don’t see D, S and R, and only see “FSRS enabled”, it means that the card is in the “learning” or “relearning” stage, not in the “review” stage. +This shows that the FSRS scheduler is running normally. If you don’t see D, S and R, and only see “FSRS enabled”, it means that the card is in the “learning” or “relearning” stage, not in the “review” stage. -This shows that the FSRS scheduler is running normally. You can then change the code back and the message will no longer display. +You can then change the code back and the message will no longer display. ## Step 2: Personalizing FSRS -To ensure that FSRS suits your learning needs, you'll need to follow a two-step process. +Personalizing FSRS for your learning needs involves a two-step process. -- First, you'll need to train the FSRS parameters for your collection, tailoring the algorithm to your learning patterns.. +- First, you'll need to train the FSRS parameters for your collection using the FSRS optimizer, tailoring the algorithm to your learning patterns. - Next, you'll need to choose the desired retention rate and maximum interval. Let's now discuss both of these steps in detail. @@ -111,7 +111,7 @@ Let's now discuss both of these steps in detail. For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned here (provide link). -However, the FSRS optimizer requires a minimum of 2000 reviews to produce accurate results. If you don't have enough data, you can skip this step and use the default parameters, which are already entered in the scheduler code. +Note that the FSRS optimizer requires a minimum of 2000 reviews to produce accurate results. If you don't have enough data, you can skip this step and use the default parameters instead, which are already entered into the scheduler code.
Method 1: Training using Google Colab @@ -168,13 +168,13 @@ As an aid in deciding this value, you can view your past retention rate in Anki You can set a higher `requestRetention` but keep in mind that as you increase the `requestRetention` above 0.90, the review load (reviews/day) would increase very rapidly. For the same reason, it is not advisable to use a `requestRetention` greater than 0.97. -After deciding the value of requestRetention, put this into the scheduler code. At the same time, decide the value of `maximumInterval`, which is the maximum interval any card is allowed to attain. The value in the FSRS scheduler code overrides the value set in Anki's deck options. +After deciding the value of `requestRetention`, put this into the scheduler code. At the same time, decide the value of `maximumInterval`, which is the maximum interval any card is allowed to attain. The value in the FSRS scheduler code overrides the value set in Anki's deck options. ![ Add screenshot ] After performing the above steps, you are ready to start using FSRS. Just start reviewing and FSRS will do its work. -For better results, you are advised to reschedule your existing cards using the FSRS4Anki Helper add-on. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. +However, for better results, you are advised to reschedule your existing cards using the FSRS4Anki Helper add-on. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. Read about the add-on here: https://github.com/open-spaced-repetition/fsrs4anki-helper @@ -226,10 +226,6 @@ If there are some decks you don't want to use FSRS with, you can add their names const skip_decks = ["MainDeck3", "MainDeck4::SubDeck"]; ``` -## Using the Helper Add-on - -Please see: [FSRS4Anki Helper](https://github.com/open-spaced-repetition/fsrs4anki-helper) - # FAQ Here, I have collected some frequently asked questions: [FAQ](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ) From 435cb87cbd36ad53de4142111187aa3c696e3edc Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Tue, 15 Aug 2023 13:39:45 +0530 Subject: [PATCH 10/16] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index b9e71ad..3168efd 100644 --- a/README.md +++ b/README.md @@ -23,13 +23,11 @@ _✨ A modern Anki [custom scheduling](https://faqs.ankiweb.net/the-2021-schedul # Table of contents -- [FSRS4Anki](#fsrs4anki) - [Introduction](#introduction) - [How to Get Started?](#how-to-get-started) - [Step 1: Enabling the FSRS Scheduler](#step-1-enabling-the-fsrs-scheduler) - [Step 2: Personalizing FSRS](#step-2-personalizing-fsrs) - [Configuring Different Parameters for Different Decks](#configuring-different-parameters-for-different-decks) -- [Using the Helper Add-on](#using-the-helper-add-on) - [FAQ](#faq) - [Compatibility](#compatibility) - [Contribute](#contribute) From 99f82fa9c467abe97d23e735baadb09310b13d3b Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Sun, 20 Aug 2023 17:50:05 +0530 Subject: [PATCH 11/16] Address feedback --- README.md | 44 ++++++++++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3168efd..37ab03c 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,10 @@ _✨ A modern Anki [custom scheduling](https://faqs.ankiweb.net/the-2021-schedul FSRS4Anki consists of two main parts: scheduler and optimizer. -The scheduler replaces the Anki's built-in scheduler and schedules the cards according to the FSRS algorithm. +- The scheduler replaces the Anki's built-in scheduler and schedules the cards according to the FSRS algorithm. +- The optimizer uses machine learning to learn your memory patterns and finds parameters that provide the best fit to your review history. For details about the working of the optimizer, please read [the mechanism of optimization](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-mechanism-of-optimization). -The optimizer uses machine learning to learn your memory patterns and finds parameters that provide the best fit to your review history. - -For more details about the FSRS algorithm, please read the [Wiki](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm). If you are interested, you can also read my papers: +For details about the FSRS algorithm, please read [the algorithm](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm). If you are interested, you can also read my papers: - [A Stochastic Shortest Path Algorithm for Optimizing Spaced Repetition Scheduling](https://www.maimemo.com/paper/) (free access), and - [Optimizing Spaced Repetition Schedule by Capturing the Dynamics of Memory](https://www.researchgate.net/publication/369045947_Optimizing_Spaced_Repetition_Schedule_by_Capturing_the_Dynamics_of_Memory) (submit request). @@ -69,12 +68,14 @@ Go to Tools > Preferences > Review > Enable V3 Scheduler. ### 1.2 Paste FSRS Scheduler Code -- Go to the following page and copy all of the code.: https://github.com/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_scheduler.js +- Go to the following page and copy all of the code. https://github.com/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_scheduler.js - In Anki, open the deck options of any deck (it doesn’t matter which deck). Find the Advanced Settings column, and paste the code you copied into the Custom Scheduling field: ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5c292f91-8845-4f8c-ac42-55f9a0f2946e) - Ensure that the learning and re-learning steps are not longer than 1 day in any deck that you want to use with FSRS. Other settings, such as “Graduating interval” and “Easy interval”, don’t matter. For more details about which Anki settings matter and which are obsolete, see the [FAQs](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ). +![image](https://github.com/user1823/fsrs4anki/assets/92206575/08895416-2fba-4b8d-a043-9e1f4f0a8be2) + After you perform the above steps, the FSRS4Anki Scheduler should ideally be active. If you want to confirm this, you can change this part of the code: @@ -124,6 +125,26 @@ After the Colab website opens, switch to the folder tab. Once the Optimizer conn When exporting these files, make sure to select "Include scheduling information" and "Support older Anki versions". You don't need to include media. +
+ A note on Privacy + +The decks that you upload to the optimizer can't be accessed by the author of FSRS. This can be verified by anyone who understands code because the code of the optimizer is open-source. + +Google may have access to the uploaded data. But, the risk is similar to uploading the data to your personal Google Drive folder. + +If you are too worried about privacy, you still have two options. +- Advanced users can run the script locally using the options mentioned here. (provide link) +- Other users can export their collection with blanked out fields. To do this, go through the following steps: + - Take a backup by going to `File → Create Backup` just in case anything goes wrong. + - Go to `Browse > Notes > Find and Replace`. + - Type `(.|\n)*` in the "Find" field and keep the "Replace With" field empty. + - Check (✓) the "Treat input as regular expression" option. Uncheck "Selected notes only" if you want to apply this to all notes. +![image](https://github.com/user1823/fsrs4anki/assets/92206575/33f5de25-0f3b-4ec3-9ef6-5c1338c6eec1) + - Export your collection using the steps mentioned above. + - Restore the contents of your notes by going to `Edit → Undo Find and Replace`. + +
+ ![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/65da272d-7a01-4c46-a1d9-093e548f1a2d) - After uploading the file, replace the `collection-2022-09-18@13-21-58.colpkg` with the name of your uploaded file. @@ -156,7 +177,7 @@ After training the parameters by either of the methods above, replace the parame ⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. The code will break without them. -Even after you start using FSRS, you should re-train the parameters once every month. This will ensure that FSRS works well with your current patterns of learning. +Even after you start using FSRS, you should re-train the parameters once in every two months. However, it depends on how old your collection is. Users with relatively newer collections might want to re-optimize monthly. Re-optimization will ensure that FSRS works well with your current patterns of learning. ### Step 2.2: Choosing the desired retention rate and maximum interval @@ -168,13 +189,12 @@ You can set a higher `requestRetention` but keep in mind that as you increase th After deciding the value of `requestRetention`, put this into the scheduler code. At the same time, decide the value of `maximumInterval`, which is the maximum interval any card is allowed to attain. The value in the FSRS scheduler code overrides the value set in Anki's deck options. -![ Add screenshot ] +![image](https://github.com/user1823/fsrs4anki/assets/92206575/1c807763-d769-4b5e-a1fe-1ebeb7a6d684) After performing the above steps, you are ready to start using FSRS. Just start reviewing and FSRS will do its work. -However, for better results, you are advised to reschedule your existing cards using the FSRS4Anki Helper add-on. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. - -Read about the add-on here: https://github.com/open-spaced-repetition/fsrs4anki-helper +However, for better results, you can install the [FSRS4Anki Helper add-on](https://ankiweb.net/shared/info/759844606) and use it to reschedule your existing cards. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. Read about the add-on here: https://github.com/open-spaced-repetition/fsrs4anki-helper +![image](https://github.com/user1823/fsrs4anki/assets/92206575/6cef7ec0-b094-45c8-84dc-5e27fdd27629) ## Configuring Different Parameters for Different Decks @@ -235,12 +255,12 @@ Some add-ons modify the scheduling of Anki, which would cause conflict with FSRS | Add-on | Compatible? | Comment | | ------------------------------------------------------------ |-------------------| ------- | |[Advanced Review Bottom Bar](https://ankiweb.net/shared/info/1136455830)|Yes✅|Please use the latest version.| +| [Pass/Fail](https://ankiweb.net/shared/info/876946123) |Yes✅| `Pass` is the equivalent of `Good`.| |[Incremental Reading v4.11.3 (unofficial clone)](https://ankiweb.net/shared/info/999215520)|No❌|It shows the interval given by Anki's built-in scheduler, not the custom scheduler.| | [Auto Ease Factor](https://ankiweb.net/shared/info/1672712021)|No❌|`Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| | [Delay siblings](https://ankiweb.net/shared/info/1369579727) |No❌|Delay siblings will modify the intervals given by FSRS. However, FSRS4Anki Helper add-on has a similar feature that works better with FSRS. So, you should use the FSRS4Anki Helper add-on instead.| -| [autoLapseNewInterval](https://ankiweb.net/shared/info/372281481) |Yes✅|`New Interval` doesn't affect the interval given by FSRS.| +| [autoLapseNewInterval](https://ankiweb.net/shared/info/372281481) |No❌|`New Interval` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| | [Straight Reward](https://ankiweb.net/shared/info/957961234) |No❌|`Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| -| [Pass/Fail](https://ankiweb.net/shared/info/876946123) |Yes✅| `Pass` is the equivalent of `Good`.| Let me know via [issues](https://github.com/open-spaced-repetition/fsrs4anki/issues) if I miss any add-ons. From 90ea975d06d60d0f2633e9cb450f8bb0d0782eb1 Mon Sep 17 00:00:00 2001 From: Jarrett Ye Date: Fri, 25 Aug 2023 11:35:23 +0800 Subject: [PATCH 12/16] Doc/replace image --- README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 37ab03c..abf3994 100644 --- a/README.md +++ b/README.md @@ -64,18 +64,16 @@ Let's now discuss both of these steps in detail. Go to Tools > Preferences > Review > Enable V3 Scheduler. -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/8f91fba8-9b8b-405c-8aa9-42123ba5faeb) +

image

### 1.2 Paste FSRS Scheduler Code - Go to the following page and copy all of the code. https://github.com/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_scheduler.js - In Anki, open the deck options of any deck (it doesn’t matter which deck). Find the Advanced Settings column, and paste the code you copied into the Custom Scheduling field: +

image

-![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5c292f91-8845-4f8c-ac42-55f9a0f2946e) - -- Ensure that the learning and re-learning steps are not longer than 1 day in any deck that you want to use with FSRS. Other settings, such as “Graduating interval” and “Easy interval”, don’t matter. For more details about which Anki settings matter and which are obsolete, see the [FAQs](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ). -![image](https://github.com/user1823/fsrs4anki/assets/92206575/08895416-2fba-4b8d-a043-9e1f4f0a8be2) - +- Ensure that the learning and re-learning steps are shorter than 1 day in any deck that you want to use with FSRS. Other settings, such as “Graduating interval” and “Easy interval”, don’t matter. For more details about which Anki settings matter and which are obsolete, see the [FAQs](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ). +

image

After you perform the above steps, the FSRS4Anki Scheduler should ideally be active. If you want to confirm this, you can change this part of the code: @@ -91,7 +89,7 @@ const display_memory_state = true; Then open any deck for review and you'll see the following message: -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/0a5d4561-6052-45f3-91a5-5f21dd6497b9) +

image

This shows that the FSRS scheduler is running normally. If you don’t see D, S and R, and only see “FSRS enabled”, it means that the card is in the “learning” or “relearning” stage, not in the “review” stage. @@ -117,11 +115,11 @@ Note that the FSRS optimizer requires a minimum of 2000 reviews to produce accur Open the [optimizer's notebook](https://colab.research.google.com/github/open-spaced-repetition/fsrs4anki/blob/main/fsrs4anki_optimizer.ipynb). You don't need to configure the coding environment yourself and you can use Google's machines for free (you'll need to have a Google account): -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/5f5af21b-583d-496c-9bad-0eef0b1fb7a6) +

image

After the Colab website opens, switch to the folder tab. Once the Optimizer connects to Google's machines, you can right-click to upload your deck file/collection file exported from Anki. -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/66f9e323-fca8-4553-bcb2-b2e511fcf559) +

image

When exporting these files, make sure to select "Include scheduling information" and "Support older Anki versions". You don't need to include media. @@ -138,28 +136,27 @@ If you are too worried about privacy, you still have two options. - Take a backup by going to `File → Create Backup` just in case anything goes wrong. - Go to `Browse > Notes > Find and Replace`. - Type `(.|\n)*` in the "Find" field and keep the "Replace With" field empty. - - Check (✓) the "Treat input as regular expression" option. Uncheck "Selected notes only" if you want to apply this to all notes. -![image](https://github.com/user1823/fsrs4anki/assets/92206575/33f5de25-0f3b-4ec3-9ef6-5c1338c6eec1) + - Check (✓) the "Treat input as regular expression" option. Uncheck "Selected notes only" if you want to apply this to all notes.

image

- Export your collection using the steps mentioned above. - Restore the contents of your notes by going to `Edit → Undo Find and Replace`.
-![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/65da272d-7a01-4c46-a1d9-093e548f1a2d) +

image

- After uploading the file, replace the `collection-2022-09-18@13-21-58.colpkg` with the name of your uploaded file. - Replace `Asia/Shanghai` with your timezone. The notebook contains a link to the list of timezones. - Also, replace the value of `next_day_starts_at`. To find out this value, Go to `Tools > Preferences > Review > Next day starts at` in your Anki. -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/f344064c-4ccf-4884-94d0-fc0a1d3c3c24) +

image

Then, run the optimizer by either pressing `Ctrl+F9` or going to `Runtime > Run all`. -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/77947790-6916-4a99-ba28-8da42fd5b350) +

image

Wait for the code to finish running. Then, go to section 2.2 (Result), where the optimized parameters will be available. Copy these parameters. -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/8df1d210-73c3-4194-9b3b-256279c4c2fd) +

image

@@ -168,12 +165,12 @@ Wait for the code to finish running. Then, go to section 2.2 (Result), where the Simply upload your exported decks to this website and it will optimise it for you. https://huggingface.co/spaces/open-spaced-repetition/fsrs4anki_app -![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/a03217f0-6627-4854-971f-f2bc9d14da5c) +

image

After training the parameters by either of the methods above, replace the parameters in the FSRS code that you copied earlier. -![image](https://github.com/open-spaced-repetition/fsrs4anki/assets/32575846/70b3b45a-f014-4574-81eb-cad6d19f93d9) +

image

⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. The code will break without them. @@ -189,12 +186,14 @@ You can set a higher `requestRetention` but keep in mind that as you increase th After deciding the value of `requestRetention`, put this into the scheduler code. At the same time, decide the value of `maximumInterval`, which is the maximum interval any card is allowed to attain. The value in the FSRS scheduler code overrides the value set in Anki's deck options. -![image](https://github.com/user1823/fsrs4anki/assets/92206575/1c807763-d769-4b5e-a1fe-1ebeb7a6d684) +

image

After performing the above steps, you are ready to start using FSRS. Just start reviewing and FSRS will do its work. However, for better results, you can install the [FSRS4Anki Helper add-on](https://ankiweb.net/shared/info/759844606) and use it to reschedule your existing cards. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. Read about the add-on here: https://github.com/open-spaced-repetition/fsrs4anki-helper -![image](https://github.com/user1823/fsrs4anki/assets/92206575/6cef7ec0-b094-45c8-84dc-5e27fdd27629) + +

image

+ ## Configuring Different Parameters for Different Decks @@ -215,7 +214,7 @@ const deckParams = [ // The above parameters can be optimized via FSRS4Anki optimizer. // For details about the parameters, please see: https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm // User's custom parameters for global - "requestRetention": 0.9, // recommended setting: 0.8 ~ 0.9 + "requestRetention": 0.9, // recommended setting: 0.75 ~ 0.95 "maximumInterval": 36500, // FSRS only modifies the long-term scheduling. So (re)learning steps in deck options work as usual. // I recommend setting steps shorter than 1 day. From 1c25fe1bab60eda5b4a6a438deaf93bfe4de655d Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Fri, 25 Aug 2023 20:01:19 +0530 Subject: [PATCH 13/16] Add links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index abf3994..c9376e9 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ Let's now discuss both of these steps in detail. ### Step 2.1 Training the FSRS Parameters -For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned here (provide link). +For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned [here](https://github.com/open-spaced-repetition/fsrs4anki/wiki/Advanced-methods-of-optimization). Note that the FSRS optimizer requires a minimum of 2000 reviews to produce accurate results. If you don't have enough data, you can skip this step and use the default parameters instead, which are already entered into the scheduler code. @@ -131,7 +131,7 @@ The decks that you upload to the optimizer can't be accessed by the author of FS Google may have access to the uploaded data. But, the risk is similar to uploading the data to your personal Google Drive folder. If you are too worried about privacy, you still have two options. -- Advanced users can run the script locally using the options mentioned here. (provide link) +- Advanced users can run the script locally using the options mentioned [here](https://github.com/open-spaced-repetition/fsrs4anki/wiki/Advanced-methods-of-optimization). - Other users can export their collection with blanked out fields. To do this, go through the following steps: - Take a backup by going to `File → Create Backup` just in case anything goes wrong. - Go to `Browse > Notes > Find and Replace`. From 399f8aa902c04683a82b22b25aa0e03e2432f6df Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Fri, 25 Aug 2023 20:11:30 +0530 Subject: [PATCH 14/16] Grammatical fixes --- README.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c9376e9..c24ba09 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,14 @@ _✨ A modern Anki [custom scheduling](https://faqs.ankiweb.net/the-2021-schedul # Introduction -FSRS4Anki consists of two main parts: scheduler and optimizer. +FSRS4Anki consists of two main parts: the scheduler and the optimizer. -- The scheduler replaces the Anki's built-in scheduler and schedules the cards according to the FSRS algorithm. -- The optimizer uses machine learning to learn your memory patterns and finds parameters that provide the best fit to your review history. For details about the working of the optimizer, please read [the mechanism of optimization](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-mechanism-of-optimization). +- The scheduler replaces Anki's built-in scheduler and schedules the cards according to the FSRS algorithm. +- The optimizer uses machine learning to learn your memory patterns and finds parameters that best fit your review history. For details about the working of the optimizer, please read [the mechanism of optimization](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-mechanism-of-optimization). For details about the FSRS algorithm, please read [the algorithm](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm). If you are interested, you can also read my papers: - [A Stochastic Shortest Path Algorithm for Optimizing Spaced Repetition Scheduling](https://www.maimemo.com/paper/) (free access), and -- [Optimizing Spaced Repetition Schedule by Capturing the Dynamics of Memory](https://www.researchgate.net/publication/369045947_Optimizing_Spaced_Repetition_Schedule_by_Capturing_the_Dynamics_of_Memory) (submit request). +- [Optimizing Spaced Repetition Schedule by Capturing the Dynamics of Memory](https://www.researchgate.net/publication/369045947_Optimizing_Spaced_Repetition_Schedule_by_Capturing_the_Dynamics_of_Memory) (submit a request). FSRS4Anki Helper is an Anki add-on that complements the FSRS4Anki Scheduler. You can read about it here: https://github.com/open-spaced-repetition/fsrs4anki-helper @@ -51,10 +51,10 @@ FSRS4Anki Helper is an Anki add-on that complements the FSRS4Anki Scheduler. You 中文版请见：[FSRS4Anki 使用指北](https://zhuanlan.zhihu.com/p/636564830) -To get started with FSRS, you'll need to follow a two-step process. +To get started with FSRS, you must follow a two-step process. -- First, you'll need to enable the FSRS scheduler in your Anki application. -- Next, you'll need to personalize FSRS to suit your learning patterns. +- First, you must enable the FSRS scheduler in your Anki application. +- Next, you must personalize FSRS to suit your learning patterns. Let's now discuss both of these steps in detail. @@ -72,7 +72,7 @@ Go to Tools > Preferences > Review > Enable V3 Scheduler. - In Anki, open the deck options of any deck (it doesn’t matter which deck). Find the Advanced Settings column, and paste the code you copied into the Custom Scheduling field:

image

-- Ensure that the learning and re-learning steps are shorter than 1 day in any deck that you want to use with FSRS. Other settings, such as “Graduating interval” and “Easy interval”, don’t matter. For more details about which Anki settings matter and which are obsolete, see the [FAQs](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ). +- Ensure that the learning and re-learning steps are shorter than 1 day in any deck you want to use with FSRS. Other settings, such as “Graduating interval” and “Easy interval”, don’t matter. For more details about which Anki settings matter and which are obsolete, see the [FAQs](https://github.com/open-spaced-repetition/fsrs4anki/wiki/FAQ).

image

After you perform the above steps, the FSRS4Anki Scheduler should ideally be active. If you want to confirm this, you can change this part of the code: @@ -99,8 +99,8 @@ You can then change the code back and the message will no longer display. Personalizing FSRS for your learning needs involves a two-step process. -- First, you'll need to train the FSRS parameters for your collection using the FSRS optimizer, tailoring the algorithm to your learning patterns. -- Next, you'll need to choose the desired retention rate and maximum interval. +- First, you must train the FSRS parameters for your collection using the FSRS optimizer, tailoring the algorithm to your learning patterns. +- Next, you must choose the desired retention rate and maximum interval. Let's now discuss both of these steps in detail. @@ -108,7 +108,7 @@ Let's now discuss both of these steps in detail. For most users, it is advisable to use one of the following two methods (Google Colab and Hugging Face) for training the parameters. Advanced users can explore other options mentioned [here](https://github.com/open-spaced-repetition/fsrs4anki/wiki/Advanced-methods-of-optimization). -Note that the FSRS optimizer requires a minimum of 2000 reviews to produce accurate results. If you don't have enough data, you can skip this step and use the default parameters instead, which are already entered into the scheduler code. +Note that the FSRS optimizer requires a minimum of 2,000 reviews to produce accurate results. If you don't have enough data, you can skip this step and use the default parameters instead, which are already entered into the scheduler code.
Method 1: Training using Google Colab @@ -132,7 +132,7 @@ Google may have access to the uploaded data. But, the risk is similar to uploadi If you are too worried about privacy, you still have two options. - Advanced users can run the script locally using the options mentioned [here](https://github.com/open-spaced-repetition/fsrs4anki/wiki/Advanced-methods-of-optimization). -- Other users can export their collection with blanked out fields. To do this, go through the following steps: +- Other users can export their collection with blanked-out fields. To do this, go through the following steps: - Take a backup by going to `File → Create Backup` just in case anything goes wrong. - Go to `Browse > Notes > Find and Replace`. - Type `(.|\n)*` in the "Find" field and keep the "Replace With" field empty. @@ -145,8 +145,8 @@ If you are too worried about privacy, you still have two options.

image

- After uploading the file, replace the `collection-2022-09-18@13-21-58.colpkg` with the name of your uploaded file. -- Replace `Asia/Shanghai` with your timezone. The notebook contains a link to the list of timezones. -- Also, replace the value of `next_day_starts_at`. To find out this value, Go to `Tools > Preferences > Review > Next day starts at` in your Anki. +- Replace `Asia/Shanghai` with your timezone. The notebook contains a link to the list of time zones. +- Also, replace the value of `next_day_starts_at`. To find this value, Go to `Tools > Preferences > Review > Next day starts at` in your Anki.

image

@@ -172,7 +172,7 @@ After training the parameters by either of the methods above, replace the parame

image

-⚠️Note: when replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. The code will break without them. +⚠️Note: When replacing these parameters, make sure that you don't accidentally erase the square brackets or the comma after the closing bracket. The code will break without them. Even after you start using FSRS, you should re-train the parameters once in every two months. However, it depends on how old your collection is. Users with relatively newer collections might want to re-optimize monthly. Re-optimization will ensure that FSRS works well with your current patterns of learning. @@ -182,7 +182,7 @@ Now, you need to choose your `requestRetention`, which denotes the retention rat As an aid in deciding this value, you can view your past retention rate in Anki stats. For example, if your retention rate in the past was 90%, you can set 0.90 as your `requestRetention`. -You can set a higher `requestRetention` but keep in mind that as you increase the `requestRetention` above 0.90, the review load (reviews/day) would increase very rapidly. For the same reason, it is not advisable to use a `requestRetention` greater than 0.97. +You can set a higher `requestRetention` but keep in mind that as you increase the `requestRetention` above 0.90, the review load (reviews/day) will increase very rapidly. For the same reason, it is not advisable to use a `requestRetention` greater than 0.97. After deciding the value of `requestRetention`, put this into the scheduler code. At the same time, decide the value of `maximumInterval`, which is the maximum interval any card is allowed to attain. The value in the FSRS scheduler code overrides the value set in Anki's deck options. @@ -214,7 +214,7 @@ const deckParams = [ // The above parameters can be optimized via FSRS4Anki optimizer. // For details about the parameters, please see: https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm // User's custom parameters for global - "requestRetention": 0.9, // recommended setting: 0.75 ~ 0.95 + "requestRetention": 0.9, // recommended setting: 0.75 - 0.95 "maximumInterval": 36500, // FSRS only modifies the long-term scheduling. So (re)learning steps in deck options work as usual. // I recommend setting steps shorter than 1 day. @@ -249,23 +249,23 @@ Here, I have collected some frequently asked questions: [FAQ](https://github.com # Compatibility -Some add-ons modify the scheduling of Anki, which would cause conflict with FSRS4Anki scheduler. +Some add-ons modify the scheduling of Anki, which would cause conflict with the FSRS4Anki scheduler. | Add-on | Compatible? | Comment | | ------------------------------------------------------------ |-------------------| ------- | |[Advanced Review Bottom Bar](https://ankiweb.net/shared/info/1136455830)|Yes✅|Please use the latest version.| | [Pass/Fail](https://ankiweb.net/shared/info/876946123) |Yes✅| `Pass` is the equivalent of `Good`.| |[Incremental Reading v4.11.3 (unofficial clone)](https://ankiweb.net/shared/info/999215520)|No❌|It shows the interval given by Anki's built-in scheduler, not the custom scheduler.| -| [Auto Ease Factor](https://ankiweb.net/shared/info/1672712021)|No❌|`Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| -| [Delay siblings](https://ankiweb.net/shared/info/1369579727) |No❌|Delay siblings will modify the intervals given by FSRS. However, FSRS4Anki Helper add-on has a similar feature that works better with FSRS. So, you should use the FSRS4Anki Helper add-on instead.| -| [autoLapseNewInterval](https://ankiweb.net/shared/info/372281481) |No❌|`New Interval` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| -| [Straight Reward](https://ankiweb.net/shared/info/957961234) |No❌|`Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| +| [Auto Ease Factor](https://ankiweb.net/shared/info/1672712021)|No❌|The `Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| +| [Delay siblings](https://ankiweb.net/shared/info/1369579727) |No❌|Delay siblings will modify the intervals given by FSRS. However, the FSRS4Anki Helper add-on has a similar feature that works better with FSRS. So, use the FSRS4Anki Helper add-on instead.| +| [autoLapseNewInterval](https://ankiweb.net/shared/info/372281481) |No❌|The `New Interval` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| +| [Straight Reward](https://ankiweb.net/shared/info/957961234) |No❌|The `Ease Factor` doesn't affect the interval given by FSRS. So, you won't benefit from using this add-on.| Let me know via [issues](https://github.com/open-spaced-repetition/fsrs4anki/issues) if I miss any add-ons. # Contribute -You can contribute to FSRS4Anki by beta testing, submitting code, or sharing your data. If you want to share your data with me, please fill this form: https://forms.gle/KaojsBbhMCytaA7h8 +You can contribute to FSRS4Anki by beta testing, submitting code, or sharing your data. If you want to share your data with me, please fill out this form: https://forms.gle/KaojsBbhMCytaA7h8 ## Contributors From 626518f52afd71941872ff63e22b53785b963446 Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Fri, 25 Aug 2023 20:19:07 +0530 Subject: [PATCH 15/16] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c24ba09..c94cb18 100644 --- a/README.md +++ b/README.md @@ -51,10 +51,10 @@ FSRS4Anki Helper is an Anki add-on that complements the FSRS4Anki Scheduler. You 中文版请见：[FSRS4Anki 使用指北](https://zhuanlan.zhihu.com/p/636564830) -To get started with FSRS, you must follow a two-step process. +To get started with FSRS, you'll need to follow a two-step process. -- First, you must enable the FSRS scheduler in your Anki application. -- Next, you must personalize FSRS to suit your learning patterns. +- First, you'll need to enable the FSRS scheduler in your Anki application. +- Next, you'll need to personalize FSRS to suit your learning patterns. Let's now discuss both of these steps in detail. @@ -99,8 +99,8 @@ You can then change the code back and the message will no longer display. Personalizing FSRS for your learning needs involves a two-step process. -- First, you must train the FSRS parameters for your collection using the FSRS optimizer, tailoring the algorithm to your learning patterns. -- Next, you must choose the desired retention rate and maximum interval. +- First, you'll need to train the FSRS parameters for your collection using the FSRS optimizer, tailoring the algorithm to your learning patterns. +- Next, you'll need to choose the desired retention rate and maximum interval. Let's now discuss both of these steps in detail. From c79a136f5bfb12bbc1a37f29da8f83e8c529e26e Mon Sep 17 00:00:00 2001 From: user1823 <92206575+user1823@users.noreply.github.com> Date: Fri, 25 Aug 2023 21:07:04 +0530 Subject: [PATCH 16/16] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c94cb18..47d1b53 100644 --- a/README.md +++ b/README.md @@ -190,7 +190,8 @@ After deciding the value of `requestRetention`, put this into the scheduler code After performing the above steps, you are ready to start using FSRS. Just start reviewing and FSRS will do its work. -However, for better results, you can install the [FSRS4Anki Helper add-on](https://ankiweb.net/shared/info/759844606) and use it to reschedule your existing cards. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. Read about the add-on here: https://github.com/open-spaced-repetition/fsrs4anki-helper +### Using the FSRS4Anki Helper add-on to reschedule existing cards +After setting up FSRS in your Anki, you can install the [FSRS4Anki Helper add-on](https://ankiweb.net/shared/info/759844606) and use it to reschedule your existing cards. This is a one-time measure to reschedule the cards that were previously scheduled according to Anki's built-in algorithm. The add-on also offers many other useful features. Read more about the add-on here: https://github.com/open-spaced-repetition/fsrs4anki-helper

image