generated from obsidianmd/obsidian-sample-plugin
-
Notifications
You must be signed in to change notification settings - Fork 184
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# Conflicts: # src/gui/flashcard-review-view.tsx
- Loading branch information
Showing
284 changed files
with
11,279 additions
and
7,585 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,21 @@ | ||
| name: Lint and Test | ||
| name: Lint PR | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [master] | ||
| pull_request_target: | ||
| types: | ||
| - opened | ||
| - edited | ||
| - synchronize | ||
| - reopened | ||
|
|
||
| env: | ||
| COREPACK_ENABLE_STRICT: 0 | ||
| permissions: | ||
| pull-requests: read | ||
|
|
||
| jobs: | ||
| lint_and_test: | ||
| lint_pr: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Setup Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20" | ||
|
|
||
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Install Dependencies | ||
| run: npm install -g pnpm && pnpm install | ||
|
|
||
| - name: Lint | ||
| run: pnpm lint | ||
|
|
||
| - name: Test | ||
| run: pnpm test | ||
| - uses: amannn/action-semantic-pull-request@v5 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: Lint and Test Code | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [master] | ||
|
|
||
| env: | ||
| COREPACK_ENABLE_STRICT: 0 | ||
|
|
||
| jobs: | ||
| lint_and_test_code: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Setup Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20" | ||
|
|
||
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Install Dependencies | ||
| run: npm install -g pnpm && pnpm install | ||
|
|
||
| - name: Lint | ||
| run: pnpm lint | ||
|
|
||
| - name: Test | ||
| run: pnpm test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| use-node-version=20.1.0 | ||
| use-node-version=20.17.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,6 @@ | ||
| build | ||
| coverage | ||
| node_modules | ||
| .yarn | ||
| .pnp.cjs | ||
| .pnp.loader.mjs | ||
| pnpm-lock.yaml | ||
| tests/e2e/vault/ | ||
| docs/vaults/ | ||
| tests/vaults/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| docs/changelog.md | ||
| docs/docs/changelog.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| docs/en/contributing.md | ||
| docs/docs/en/contributing.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Learning Algorithms | ||
|
|
||
| A learning algorithm is a formula that determines when a note or flashcard should next be reviewed. | ||
|
|
||
| | Algorithm | Status | | ||
| | --------------------------------------------------- | ----------- | | ||
| | [SM-2-OSR](#sm-2-osr) | Implemented | | ||
| | [FSRS](#fsrs) | Planned | | ||
| | [User Defined Intervals](#user-specified-intervals) | Planned | | ||
|
|
||
| ## SM-2-OSR | ||
|
|
||
| - The `SM-2-OSR` algorithm is a variant of [Anki's algorithm](https://faqs.ankiweb.net/what-spaced-repetition-algorithm.html) which is based on the [SM-2 algorithm](https://www.supermemo.com/en/archives1990-2015/english/ol/sm2). | ||
| - It supports ternary reviews i.e. a concept is either hard, good, or easy at the time of review. | ||
| - initial ease is weighted (using max_link_factor) depending on the average ease of linked notes, note importance, and the base ease. | ||
| - Anki also applies a small amount of random “fuzz” to prevent cards that were introduced at the same time and given the same ratings from sticking together and always coming up for review on the same day." | ||
| - The algorithm is essentially the same for both notes and flashcards - apart from the PageRanks | ||
|
|
||
| ### Algorithm Details | ||
|
|
||
| !!! warning | ||
|
|
||
| Note that this hasn't been updated in a while, | ||
| please see the [code](https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/master/src/algorithms/osr/srs-algorithm-osr.ts). | ||
|
|
||
| - `if link_count > 0: initial_ease = (1 - link_contribution) * base_ease + link_contribution * average_ease` - `link_contribution = max_link_factor * min(1.0, log(link_count + 0.5) / log(64))` (cater for uncertainty) | ||
| - The importance of the different concepts/notes is determined using the PageRank algorithm (not all notes are created equal xD) | ||
| - On most occasions, the most fundamental concepts/notes have higher importance | ||
| - If the user reviews a concept/note as: | ||
| - easy, the ease increases by `20` and the interval changes to `old_interval * new_ease / 100 * 1.3` (the 1.3 is the easy bonus) | ||
| - good, the ease remains unchanged and the interval changes to `old_interval * old_ease / 100` | ||
| - hard, the ease decreases by `20` and the interval changes to `old_interval * 0.5` | ||
| - The `0.5` can be modified in settings | ||
| - `minimum ease = 130` | ||
| - For `8` or more days: | ||
| - `interval += random_choice({-fuzz, 0, +fuzz})` | ||
| - where `fuzz = ceil(0.05 * interval)` | ||
| - [Anki docs](https://faqs.ankiweb.net/what-spaced-repetition-algorithm.html): | ||
| > "[...] Anki also applies a small amount of random “fuzz” to prevent cards that were introduced at the same time and given the same ratings from sticking together and always coming up for review on the same day." | ||
| - The scheduling information is stored in the YAML front matter | ||
|
|
||
| --- | ||
|
|
||
| ## FSRS | ||
|
|
||
| The algorithm is detailed at: | ||
| [fsrs4anki](https://github.com/open-spaced-repetition/fsrs4anki/wiki) | ||
|
|
||
| Incorporation of the FSRS algorithm into this plugin has not yet occurred. For progress see: | ||
| [ [FEAT] sm-2 is outdated, can you please replace it with the fsrs algorithm? #748 ](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/748) | ||
|
|
||
| --- | ||
|
|
||
| ## User Specified Intervals | ||
|
|
||
| This is the simplest "algorithm" possible. There are fixed intervals configured by the user for each of the possible review outcomes. | ||
|
|
||
| For example, `hard` might be configured for an interval of 1 day. | ||
|
|
||
| Implementation of this technique has not yet occurred. For progress see: | ||
| [ [FEAT] user defined "Easy, Good, Hard" values instead of or in addition to the algorithm defined one. #741 ](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/741) |
Oops, something went wrong.