Skip to content

Commit

Permalink
Added a "Short Summary" section right under FSRS (#286)
Browse files Browse the repository at this point in the history
* Added a "Short Summary" section right under FSRS

Rationale: most users skim rather than read everything, and a lot of users just want a TLDR.
@brishtibheja @user1823 @dae feel free to change the wording

* Update deck-options.md

* Bold

* Update deck-options.md

* Desired retention
  • Loading branch information
Expertium authored Oct 11, 2024
1 parent 4abd633 commit c78ee6d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/deck-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,18 @@ become available, and SM-2 specific options, such as **Graduating interval**,
- If you previously used the 'custom scheduling' version of FSRS, please make
sure you clear out the custom scheduling section before enabling FSRS.

### A Short Guide

- Enable FSRS under the "FSRS" section, at the bottom of the deck options page. FSRS can only be enabled globally; you cannot enable it for some presets and disable it for others.
- Ensure that all your learning and re-learning steps are shorter than 1d and can be completed on the same day. 23h is not recommended even though it's less than one day because you won't be able to finish this step on the same day as your first review. Steps such as 10m or 30m are good.
- Click the "Optimize" button under the "FSRS parameters" field. If you see a message that says "The FSRS parameters currently appear to be optimal", that's fine.
- Choose a value of desired retention: the proportion of cards recalled successfully when they are due. **This is the most important setting in FSRS. Higher retention leads to shorter intervals and more reviews per day.** The default is 90%, which offers a good balance of retention and workload. Above 90% the workload increases very quickly, and above 97% the workload can be overwhelming. You can use ["Compute minimum recommended retention"](#compute-minimum-recommended-retention) to help you choose the value of desired retention.
Parameters and desired retention are preset-specific, you can make multiple presets with different parameters and desired retention.

FSRS can adapt to almost any habit, except for one: pressing "Hard" instead of "Again" when you forget the information. When you press "Hard", FSRS assumes you have recalled the information correctly (though with hesitation and a lot of mental effort). If you press "Hard" when you have failed to recall the information, all intervals will be unreasonably high. So, if you have this habit, please change it and use "Again" when you forget the information.

Regarding add-on compatibility, as a general rule of thumb, if an add-on affects intervals and scheduling in some way, it shouldn't be used with FSRS.

### Desired Retention

Desired retention controls how likely you are to remember cards when they are scheduled for a review.
Expand Down

1 comment on commit c78ee6d

@dae
Copy link
Member

@dae dae commented on c78ee6d Oct 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(please avoid tagging people in commit messages, as they get notified every time this commit gets pushed to a branch)

Please sign in to comment.