Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.95 KB

README.md

File metadata and controls

76 lines (47 loc) · 2.95 KB
Raw

FSRS for Rust

crates.io

This crate contains a Rust API for training FSRS parameters, and for using them to schedule cards.

The Free Spaced Repetition Scheduler (FSRS) is a modern spaced repetition algorithm. It is based on the DSR model proposed by Piotr Wozniak, the creator of SuperMemo.

FSRS-rs is a Rust implementation of FSRS. It is designed to be used in Anki, a popular spaced repetition software. Anki 23.10 has already integrated FSRS as an alternative scheduler.

For more information about the algorithm, please refer to the wiki page of FSRS.

Quickstart

Read up this to determine the optimal retention for your use case.

// Pick to your liking (see above)
let optimal_retention = 0.75;
// Use default parameters/Weights for scheduler
let fsrs = FSRS::new(Some(&[]))?;

// Create a completely new card
let day1_states = fsrs.next_states(None, optimal_retention, 0)?;

// Rate as `hard` on first day
let day1 = day1_states.hard;
dbg!(&day1); // scheduled as `in 4 days`

// Now we review the card 2 days later
let day3_states = fsrs.next_states(Some(day1.memory), optimal_retention, 2)?;

// Rate as `good` this time
let day3 = day3_states.good;
dbg!(day3);

Development

add

#!/bin/sh
cargo fmt
cargo clippy -- -D warnings
git add .

to .git/hooks/pre-commit, then chmod +x .git/hooks/pre-commit

Bindings

Q&A

  • What is the difference with rs-fsrs

    If you want to schedule the card, use [lang]-fsrs or the bindings,

    If you do the optimization, use this crate or its bindings.

  • Why not in one crate but two?

    Calculating the weight involves tensor operations. So the initial data type is different(Tensor vs Vec/Slice). In one crate means use cfg to change type, which is tedious, so here we keep two versions.

    Another reason is, other languages will be hard to port their version when Tensor is used.

  • What about the name?

    At first, there are go-fsrs and other libraries, so rs-fsrs is used.

    Then we want to port the torch version to rust so everyone can calculate on their own devices (tch-rs use libtorch which is too heavy), since the algorithm is called fsrs, add -rs.