fsrs

README

go-fsrs

Go module implements Free Spaced Repetition Scheduler algorithm

Install

go get -u github.com/open-spaced-repetition/go-fsrs@latest

Usage

Please see GoDoc and Wiki for documents.

Contributing

Please feel free to submit any Pull Requests. Just be sure not to introduce any breaking changes and do not any functionality excess the scope of the algorithm implementation.

For algorithm problems or discussions, please go open-spaced-repetition/free-spaced-repetition-scheduler.

Documentation

Index

• type Card
  • func NewCard() Card
• type Parameters
  • func DefaultParam() Parameters
  • func (p *Parameters) Repeat(card Card, now time.Time) map[Rating]SchedulingInfo
• type Rating
  • func (s Rating) String() string
• type ReviewLog
• type SchedulingInfo
• type State
• type Weights
  • func DefaultWeights() Weights

Types

type Card

type Card struct {
	Due           time.Time `json:"Due"`
	Stability     float64   `json:"Stability"`
	Difficulty    float64   `json:"Difficulty"`
	ElapsedDays   uint64    `json:"ElapsedDays"`
	ScheduledDays uint64    `json:"ScheduledDays"`
	Reps          uint64    `json:"Reps"`
	Lapses        uint64    `json:"Lapses"`
	State         State     `json:"State"`
	LastReview    time.Time `json:"LastReview"`
}

func NewCard

func NewCard() Card

type Parameters

type Parameters struct {
	RequestRetention float64 `json:"RequestRetention"`
	MaximumInterval  float64 `json:"MaximumInterval"`
	W                Weights `json:"Weights"`
	Decay            float64 `json:"Decay"`
	Factor           float64 `json:"Factor"`
}

func DefaultParam

func DefaultParam() Parameters

func (*Parameters) Repeat

func (p *Parameters) Repeat(card Card, now time.Time) map[Rating]SchedulingInfo

type Rating

type Rating int8

const (
	Again Rating = iota + 1
	Hard
	Good
	Easy
)

func (Rating) String

func (s Rating) String() string

type ReviewLog

type ReviewLog struct {
	Rating        Rating    `json:"Rating"`
	ScheduledDays uint64    `json:"ScheduledDays"`
	ElapsedDays   uint64    `json:"ElapsedDays"`
	Review        time.Time `json:"Review"`
	State         State     `json:"State"`
}

type SchedulingInfo

type SchedulingInfo struct {
	Card      Card
	ReviewLog ReviewLog
}

type State

type State int8

const (
	New State = iota
	Learning
	Review
	Relearning
)

type Weights

type Weights [17]float64

func DefaultWeights

func DefaultWeights() Weights