Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #231

Merged
merged 1 commit into from
Oct 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,23 @@ to `.git/hooks/pre-commit`, then `chmod +x .git/hooks/pre-commit`
## Bindings

- python <https://github.com/open-spaced-repetition/fsrs-rs-python>

## Q&A

- What is the difference with [rs-fsrs](https://github.com/open-spaced-repetition/rs-fsrs)

If you want to schedule the card, use \[lang\]-fsrs or the [bindings](https://github.com/open-spaced-repetition/rs-fsrs?tab=readme-ov-file#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`.
Loading