Giter Club home page Giter Club logo

thyagoluciano / sm2 Goto Github PK

View Code? Open in Web Editor NEW
176.0 6.0 21.0 106 KB

SM-2 is a simple spaced repetition algorithm. It calculates the number of days to wait before reviewing a piece of information based on how easily the the information was remembered today.

License: GNU General Public License v3.0

Dart 64.23% Kotlin 2.88% Swift 8.51% Objective-C 0.80% HTML 23.58%
dart dart2 flutter package sm2 spaced repetition supermemo supermemo2 algorithm

sm2's Introduction

Implementation of SM-2 in DART.

SM-2 is a simple spaced repetition algorithm. It calculates the number of days to wait before reviewing a piece of information based on how easily the information was remembered today.

Links

The algorithm requires four inputs

The algorithm requires four inputs: quality, repetitions, previous ease factor, and previous interval. The last three inputs are taken from the output of a previous call to SM-2. (On the first call, default values are used.)

Quality

An integer from 0-5 indicating how easily the information was remembered today. This could correspond to a button such as "Difficult" or "Very Easy."

The official algorithm description explains the meaning of each number:

5 - perfect response
4 - correct response after a hesitation
3 - correct response recalled with serious difficulty
2 - incorrect response; where the correct one seemed easy to recall
1 - incorrect response; the correct one remembered
0 - complete blackout.

Repetitions (integer)

The number of times the information has been reviewed prior to this review. repetitions should equal zero for the first review.

SM-2 uses this value to define specific intervals for the first and second reviews. SM-2 will also reset this value to zero when quality is less than 3.

Previous ease factor (float)

A floating point number (≥ 1.3) generated by the last iteration of the SM-2 algorithm. previous ease factor should equal 2.5 for the first review.

The ease factor is used to determine the number of days to wait before reviewing again. Each call to SM-2 adjusts this number up or down based on quality.

Previous interval (integer)

Generated by the last iteration of the SM-2 algorithm. Indicates the number of days to wait between reviews.

This previous interval is used when calculating the new interval. previous interval should equal zero for the first review.

Outputs

The algorithm returns three outputs: interval, repetitions, and ease factor. All three values should be saved and passed to the next call to SM-2 as inputs.

Interval (integer)

An integer number indicating the number of days to wait before the next review.

Repetitions (integer)

The number of times the information has been reviewed as of this review.

This value is maintained between calls to the algorithm and used for calculating interval. The number increments after each successful review. SM-2 will reset repetitions to zero if quality is less than 3.

Ease factor

A floating point number (≥ 1.3) which is adjusted up or down based on how easily the information was remembered.

This value is maintained between calls to the algorithm and is used for calculating interval.

Steps

If quality is greater than or equal to 3, indicating a correct response:

  1. If repetitions is 0 (first review), set interval to 1 day.
  2. If repetitions is 1 (second review), set interval to 6 days.
  3. If repetitions is greater than 1 (subsequent reviews), set interval to previous interval * previous ease factor. (See note about recursion below.)
  4. Round interval up to the next whole number.
  5. Increment repetitions by 1.
  6. Set ease factor to previous ease factor + (0.1 - (5 - quality) * (0.08 + (5 - quality ) * 0.02)). (See formula description below.)

If quality is less than 3, indicating an incorrect response:

  1. Set repetitions to 0.
  2. Set interval to 1.
  3. Set ease factor to previous ease factor (no change).

If ease factor is less than 1.3:

  1. Set ease factor to 1.3.

Return interval, repetitions and ease factor.

Ease factor formula

After the first two reviews, ease factor is adjusted using this formula:

previous ease factor + (0.1 - (5 - quality) * (0.08 + (5 - quality) * 0.02))

The magic numbers come from the official algorithm description.

This increases ease factor when quality is 5, makes no change when quality is 4, and decreases ease factor by varying amounts when quality is lower than 4. The lower quality is, the more ease factor is decreased.

sm2's People

Contributors

stoyandimov avatar thyagoluciano avatar tomaszsluszniak avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

sm2's Issues

Dart pub

Hello, you wrote a great package, and as I understand it, this is your package pub.dev/packages/sm2
Can you set the correct links in pub.dev? Because at the moment the buttons “Repository (GitHub)” and “View/report problems” refer to github.com/thyagoluciano/flutter_radio

New Ease Factor only calculated when q >=3

sm2/lib/sm.dart

Lines 25 to 26 in 5a7081f

easeFactor = previousEaseFactor +
(0.1 - (5 - quality) * (0.08 + (5 - quality) * 0.02));

I think the SM-2 algorithm is not implemented correctly here because EF is not calculated on every review. When a q below 3 is given, the EF is not calculated. This means that when q is between 0-2 it has no effect on the EF what so ever, which is not how the algorithm is intended to work.

The algorithm is intended to lower the EF when the user keeps answering incorrectly (q 0-2). In the current code base, the Ease Factor can never go below 2.5 which is the default value.

How to use this algorithm?

Hi, your code looks interessant but i can’t figure out how to use it. I can see that it’s written in Dart but i don’t really know this langage.
Can you pls provide some guidance on how to run this github repo?

Thanks

PreviousInterval shoud be an integer not double

According to the readme, previousInterval should be an integer, not double.

double previousInterval,

And there is also a bug in example:

    SmResponse smResponse = sm.calc(
      quality: 0,
      repetitions: 0,
      previousInterval: 2.5,
      previousEaseFactor: 0
    );

default value for previousInterval should be zero, and previousEaseFactor should be 2.5 not zero.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.