Skip to content

Commit

Permalink
document removal of advanced statistics
Browse files Browse the repository at this point in the history
  • Loading branch information
david-allison authored and mikehardy committed Feb 14, 2024
1 parent a9b8d20 commit 24fda7f
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 38 deletions.
37 changes: 0 additions & 37 deletions manual.asc
Original file line number Diff line number Diff line change
Expand Up @@ -796,9 +796,6 @@ Collection path :: Change the location where AnkiDroid's data is stored (not rec
Force full sync ::
Tap this item to force a full upload or download on the next sync (for example, because you accidentally deleted a deck on one side and want to restore the deck rather than having its deletion synchronized).

Advanced Statistics ::
Take into account the effect of future reviews in the 'Forecast' graph. More info <<advancedStatistics,here>>.

==== Workarounds
Type answer into the card ::
If you have set up your cards to ask you to type in the answer (as explained in https://docs.ankiweb.net/templates/intro.html#card-templates[this section of the desktop manual]), AnkiDroid will display a keyboard on such cards and allow you to check your answer.
Expand Down Expand Up @@ -987,40 +984,6 @@ containing the comparison on the answer side. This class can be used
to show the type prompt or to hide the typing comparison in
this case.

[[advancedStatistics]]
=== Advanced Statistics

If Advanced Statistics are enabled, it changes the 'Forecast' graph so that it shows the estimated number of reviews that will be due on a given day in the future taking into account future reviews, learning new cards and failing cards. The bars and the left axis show the number of cards due on each day if you study all cards each day, while the line and the right axis show the number of unseen (shown as 'learn'), young and mature cards your deck or collection will consist of if you study all cards each day. The forecast graph does count reviews that are currently overdue. It assumes that the overdue cards will be reviewed according to the 'maximum reviews/day' deck option.

Advanced Statistics can be enabled in Settings -> Advanced -> Advanced Statistics (in plugin section).

The outcome of future reviewing, learning or failing cards affects reviews after that future review. To take this into account, the probability of each outcome is computed from the review log. Then the outcome is randomly chosen, such that an outcome which is more likely according to the review log is more likely to be chosen than an outcome which is less likely according to the review log. The settings all affect how the effect of the outcome of future reviews on subsequent reviews is taken into account.

Compute first n days, simulate remainder ::
If this setting is set to a number greater than 0, instead of randomly choosing an outcome, each possible outcome is taken into account in the simulation, together with its probability. The probability is taken into account for the graph and for future reviews in which it results, which also affect the graph.
One review has a couple of possible outcomes (say 4), which all result in a review. That review also has a couple of possible outcomes and so on. If many reviews are simulated this way, many reviews (4 x 4 x 4 x ... ) have to be taken into account which increases the time it takes to compose the graph.
Therefore, for reviews later than n days from now are simulated by randomly choosing an outcome.

+
In summary, higher n gives a more accurate graph, but it takes more time to compose the graph.

Precision of computation ::

Reviews which occur with a probability smaller than 100% minus the configured precision of the computation are simulated by randomly choosing an outcome rather than taking into account each possible outcome. This setting is only applicable if the first n days are computed.
If Advanced Statistics are disabled, the 'Forecast' graph shows the estimated number of reviews that will be due on a given day in the future if you do not review cards, learn no new cards and fail no cards.

+
In summary, higher precision gives a more accurate graph, but it takes more time to compose the graph.

Number of iterations of the simulation ::
Composes the graph several times and then displays the average of these graphs.
Each time the graph is composed, another outcome might be randomly chosen. If we average many outcomes which are randomly chosen taking into account the probabilities from the review log, the average outcome will likely be close to the average of the probabilities from the review log.
If we average many graphs, the average graph will likely be close to the graph which is generated by taking into account all possible outcomes.
If the number of graphs which are averaged is not too high, it will be faster than taking into account all possible outcomes.

+
In summary, a higher number of iterations gives a more accurate graph, but it takes more time to compose the graph.

[[reminders]]
=== Reminders
AnkiDroid can remind you to devote some time to reviewing cards every day at a specific time via Android's notification framework.
Expand Down
53 changes: 52 additions & 1 deletion removed-features.asc
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,55 @@ Previous versions of the Anki Scheduler had a variable number of buttons. The V3

=== Action to take

The functionality is now equivalent to 'Answer good', either reassign the action, or remove it.
The functionality is now equivalent to 'Answer good', either reassign the action, or remove it.

[[advancedStatistics]]
== Advanced Statistics

NOTE: Removed in AnkiDroid 2.17

=== Feature Description

Take into account the effect of future reviews in the 'Forecast' graph.


If Advanced Statistics are enabled, it changes the 'Forecast' graph so that it shows the estimated number of reviews that will be due on a given day in the future taking into account future reviews, learning new cards and failing cards. The bars and the left axis show the number of cards due on each day if you study all cards each day, while the line and the right axis show the number of unseen (shown as 'learn'), young and mature cards your deck or collection will consist of if you study all cards each day. The forecast graph does count reviews that are currently overdue. It assumes that the overdue cards will be reviewed according to the 'maximum reviews/day' deck option.

Advanced Statistics can be enabled in Settings -> Advanced -> Advanced Statistics (in plugin section).

The outcome of future reviewing, learning or failing cards affects reviews after that future review. To take this into account, the probability of each outcome is computed from the review log. Then the outcome is randomly chosen, such that an outcome which is more likely according to the review log is more likely to be chosen than an outcome which is less likely according to the review log. The settings all affect how the effect of the outcome of future reviews on subsequent reviews is taken into account.

Compute first n days, simulate remainder ::
If this setting is set to a number greater than 0, instead of randomly choosing an outcome, each possible outcome is taken into account in the simulation, together with its probability. The probability is taken into account for the graph and for future reviews in which it results, which also affect the graph.
One review has a couple of possible outcomes (say 4), which all result in a review. That review also has a couple of possible outcomes and so on. If many reviews are simulated this way, many reviews (4 x 4 x 4 x ... ) have to be taken into account which increases the time it takes to compose the graph.
Therefore, for reviews later than n days from now are simulated by randomly choosing an outcome.

+
In summary, higher n gives a more accurate graph, but it takes more time to compose the graph.

Precision of computation ::

Reviews which occur with a probability smaller than 100% minus the configured precision of the computation are simulated by randomly choosing an outcome rather than taking into account each possible outcome. This setting is only applicable if the first n days are computed.
If Advanced Statistics are disabled, the 'Forecast' graph shows the estimated number of reviews that will be due on a given day in the future if you do not review cards, learn no new cards and fail no cards.

+
In summary, higher precision gives a more accurate graph, but it takes more time to compose the graph.

Number of iterations of the simulation ::
Composes the graph several times and then displays the average of these graphs.
Each time the graph is composed, another outcome might be randomly chosen. If we average many outcomes which are randomly chosen taking into account the probabilities from the review log, the average outcome will likely be close to the average of the probabilities from the review log.
If we average many graphs, the average graph will likely be close to the graph which is generated by taking into account all possible outcomes.
If the number of graphs which are averaged is not too high, it will be faster than taking into account all possible outcomes.

+
In summary, a higher number of iterations gives a more accurate graph, but it takes more time to compose the graph.


=== Reason for Removal

AnkiDroid 2.17 uses Anki Desktop's code to render statistics. Advanced Statistics is not compatible with this

=== Action to take

If you are missing features in the new statistics page, discuss contributing them to Anki Desktop, and we will ingest
these changes.

0 comments on commit 24fda7f

Please sign in to comment.