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

Doc/improving the tutorial for setting up FSRS #424

Merged
merged 18 commits into from
Aug 25, 2023

Conversation

user1823
Copy link
Collaborator

This is a draft. I will improve it further if you like the way things are being changed.

@L-M-Sherlock
Copy link
Member

@Expertium, have you read this version? I think it is concise.

@user1823 user1823 marked this pull request as ready for review August 14, 2023 16:56
@user1823
Copy link
Collaborator Author

I have improved this further.

README.md Outdated Show resolved Hide resolved
@user1823
Copy link
Collaborator Author

user1823 commented Aug 20, 2023

@L-M-Sherlock @Expertium
In the latest commit, I have tried to address most of the feedback received on the Reddit post.
Things to do before merging:

The optimizer applies Maximum Likelihood Estimation and Backpropagation Through Time to estimate the stability of memory and learn the laws of memory from time-series review logs. Then, it can find the optimal retention to minimize the repetitions via the stochastic shortest path algorithm.

The FSRS algorithm is based on a variant of the DSR (Difficulty, Stability, Retrievability) model, which is used to predict memory states.

  • Replace the day-mode screenshots in my version of the README with dark-mode screenshots from a Mac (for consistency).

@user1823
Copy link
Collaborator Author

@Expertium, please review this PR so that we can complete this task as soon as possible.

@user1823
Copy link
Collaborator Author

@L-M-Sherlock, this PR has been approved by Expertium. So, I think that you should do a final review and get the TODOs in #424 (comment) completed so that this PR can be merged as soon as possible.

If you are not sure about the simulator, we can peel it off into a new issue and deal with it later.

@L-M-Sherlock
Copy link
Member

Sorry for the delay. A bug costed me a night. I will check this PR tomorrow.

@L-M-Sherlock
Copy link
Member

L-M-Sherlock commented Aug 25, 2023

  • Add information about the simulator. I don't know much about the simulator. So, I would appreciate help in this regard. Also, if @L-M-Sherlock is planning to incorporate the simulator into the helper add-on soon, we can skip this step.

I suggest skipping this step. Because I write a new simulator: https://huggingface.co/spaces/open-spaced-repetition/fsrs4anki_simulator

  • Create a page for the advanced methods of optimization and add links to the readme (at two places).

What's the advanced methods?

  • Replace the day-mode screenshots in my version of the README with dark-mode screenshots from a Mac (for consistency).

Done in user1823@90ea975

@user1823
Copy link
Collaborator Author

What's the advanced methods?

By advanced methods, I mean

  • optimization through command line
  • optimizer using @Luc-Mcgrady's version of the helper add-on (with in-built optimizer).

In this PR, there are two places where a link to the page describing these advanced methods should be added. I have mentioned "provide link" there.

@user1823
Copy link
Collaborator Author

By the way, why does the text in the following screenshot have such a low contrast?

Screenshot

@L-M-Sherlock
Copy link
Member

L-M-Sherlock commented Aug 25, 2023

By the way, why does the text in the following screenshot have such a low contrast?

It could be affected by my card template's CSS.

  • optimization through command line
  • optimizer using @Luc-Mcgrady's version of the helper add-on (with in-built optimizer).

I will add a wiki page for them.

@L-M-Sherlock
Copy link
Member

In this PR, there are two places where a link to the page describing these advanced methods should be added. I have mentioned "provide link" there.

Done: https://github.com/open-spaced-repetition/fsrs4anki/wiki/Advanced-methods-of-optimization

README.md Outdated Show resolved Hide resolved
@user1823
Copy link
Collaborator Author

If you don't have any further comments, you can merge this branch now.

README.md Outdated Show resolved Hide resolved
@L-M-Sherlock L-M-Sherlock added this pull request to the merge queue Aug 25, 2023
Merged via the queue into open-spaced-repetition:main with commit 771d4d0 Aug 25, 2023
@L-M-Sherlock L-M-Sherlock changed the title Improving the tutorial for setting up FSRS Doc/improving the tutorial for setting up FSRS Aug 25, 2023
@L-M-Sherlock L-M-Sherlock linked an issue Aug 25, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Introduction for FSRS v4
3 participants