Skip to content

Commit

Permalink
Doc/average retention (#280)
Browse files Browse the repository at this point in the history
  • Loading branch information
L-M-Sherlock authored Oct 25, 2023
1 parent e1c69e8 commit 3eb7498
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Interpretation:

- Total **burden**, as defined by Piotr Woźniak here: https://supermemo.guru/wiki/Burden
- The [three component of the memory model](https://supermemo.guru/wiki/Three_component_model_of_memory) used by FSRS:
- Average **retention** reflects the percentage of cards that you would recall correctly if you were tested today.
- Average predicted **retention** reflects the percentage of cards that you would recall correctly if you were tested today.
- Average (memory) **stability** reflects how fast you forget (forgetting rate). The greater the stability, the slower the forgetting rate.
- **Difficulty** reflects how hard it is to increase or maintain the stability of a memory. Its relative distribution within the deck/collection can be viewed at the bottom of the statistics interface:
![image](https://user-images.githubusercontent.com/32575846/260213063-9b18fbaa-6b92-4392-8984-03b85f3fcedd.png)
Expand Down
8 changes: 4 additions & 4 deletions stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def get_fsrs_stats(self: CollectionStats):
note_cnt,
) = retention_stability_burden(lim)
i = []
_line_now(i, "Average retention", f"{retention * 100: .2f}%")
_line_now(i, "Average predicted retention", f"{retention * 100: .2f}%")
_line_now(i, "Average stability", f"{round(stability)} days")
_line_now(i, "Burden", f"{round(burden)} reviews/day")
i.append(
Expand Down Expand Up @@ -139,9 +139,9 @@ def get_fsrs_stats(self: CollectionStats):
)
stats_data = _lineTbl_now(i)
interpretation = (
"<details><summary>Interpretation</summary>"
+ "<ul>"
+ "<li><b>Average retention</b>: the average probability of recalling a card today. In most cases, it is higher than requested retention because requested retention refers to retention at the time of a review, whereas average retention is calculated based on all cards, including undue cards. <b>This is calculated using FSRS formulas and depends on your parameters</b>.</li>"
"<p>In most cases, the average predicted retention is higher than your requested retention. For details, read the interpretation section.</p>"
+ "<details><summary>Interpretation</summary><ul>"
+ "<li><b>Average predicted retention</b>: the average probability of recalling a card today. In most cases, it is higher than requested retention because requested retention refers to retention at the time of a review, whereas average retention is calculated based on all cards, including undue cards. Not all cards are due, that's why these two values are different. <b>The average predicted retention is calculated using FSRS formulas and depends on your parameters.</b> True retention is not an algorithmic prediction, so changing FSRS parameters won't affect it.</li>"
+ "<li><b>Stability</b>: the number of days it takes for the retention to decay from 100% to 90%.</li>"
+ "<li><b>Burden</b>: an estimate of the average number of cards that have to be reviewed daily (assuming review at the scheduled time without advancing or postponing). Burden = 1/I<sub>1</sub> + 1/I<sub>2</sub> + 1/I<sub>3</sub> +...+ 1/I<sub>n</sub> where I<sub>n</sub> - current interval of the n-th card.</li>"
+ "<li><b>Count</b>: the number of cards with custom data, in other words, cards that are affected by FSRS (this does not include cards in the (re)learning stage).</li> "
Expand Down

0 comments on commit 3eb7498

Please sign in to comment.