Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexErrant committed Mar 2, 2024
1 parent 0f62a5a commit 35ef33f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

This project runs [fsrs-rs](https://github.com/open-spaced-repetition/fsrs-rs) in the browser with support for training FSRS parameters.

It git submodules [fsrs-rs](https://github.com/AlexErrant/fsrs-rs/tree/fsrs-browser) and [burn](https://github.com/AlexErrant/burn/tree/fsrs-browser) for reasons given [here](https://github.com/Tracel-AI/burn/pull/938#issuecomment-1925913866). As such, it will not be up to date with the latest fsrs-rs. fsrs-browser's major and minor version numbers will match the version of fsrs-rs used. The patch version number is reserved for this package's use and may drift out of sync with fsrs-rs.
## Versioning

We git submodule [`fsrs-rs`](https://github.com/AlexErrant/fsrs-rs/tree/fsrs-browser) and [`burn`](https://github.com/AlexErrant/burn/tree/fsrs-browser) for reasons given [here](https://github.com/Tracel-AI/burn/pull/938#issuecomment-1925913866). As such, it will not be up to date with the latest `fsrs-rs`. `fsrs-browser`'s major and minor version numbers will match the version of `fsrs-rs` used. The patch version number is reserved for `fsrs-browser`'s' use and may drift out of sync with `fsrs-rs`.

## Building and demoing

Run `./dev.sh` for fast builds or `./prod.sh` for fast runs.

Run the `/sandbox` project to demo various behavior.

I highly encourage `./prod.sh` if you intend to run training. On my machine training 24,394 FSRS items/revlogs on `./dev` takes days, while `./prod.sh` takes 3.5 seconds.
I highly encourage `./prod.sh` if you intend to run training. On my machine training 24,394 revlogs on `./dev` takes days, while `./prod.sh` takes 3.5 seconds.

0 comments on commit 35ef33f

Please sign in to comment.