Skip to content

Commit

Permalink
📃 Doc/(CLI optimizer): describe new arguments (#401)
Browse files Browse the repository at this point in the history
* 📃 docs(CLI optimizer): describe arguments

This commit documents recent enhancements
which were made to the input arguments that the optimizer accepts.
The added headlines make the section a bit clearer and easier to navigate.

Based on open-spaced-repetition/fsrs-optimizer#4 (comment)

* 📃 docs(CLI optimizer): unify package names
  • Loading branch information
galantra authored Aug 1, 2023
1 parent 2b9bf26 commit 5eb3461
Showing 1 changed file with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,22 +142,44 @@ https://huggingface.co/spaces/open-spaced-repetition/fsrs4anki_app

### 2.1c Command Line

There is a python package for the optimizer. This package has torch as a dependency so note it might take about half a gigabyte of space.
There is a python package for the optimizer. This package has torch as a dependency, so note it might take about half a gigabyte of space.

Install this package with the command:
#### Installation

Install the package with the command:

```
python -m pip install FSRS-Optimizer
python -m pip install fsrs-optimizer
```

Export your deck and cd into the folder in which you exported it.
You should upgrade regularly to make sure you have the most recent version of FSRS-Optimizer:

```
python -m pip install fsrs-optimizer --upgrade
```

#### Usage

Export your deck and cd into the folder to which you exported it.
Then you can run:

```
python -m fsrs_optimizer "package.(colpkg/apkg)"
python -m fsrs-optimizer "package.(colpkg/apkg)"
```

You can also list multiple files, e.g.:

```
python -m fsrs-optimizer "file1.akpg" "file2.apkg"
```

Wildcards are supported:

```
python -m fsrs-optimizer *.apkg
```

There are certain options which are as follows
There are certain options which are as follows:

```
options:
Expand All @@ -166,7 +188,7 @@ options:
-o OUT, --out OUT File to APPEND the automatically generated profile to.
```

#### Expected Functionality:
#### Expected Functionality

![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/ac2e8ae0-726c-46fd-b110-0701fa87cb66)
![image](https://github.com/Luc-mcgrady/fsrs4anki/assets/63685643/1fe8b0bb-7ac0-4a31-b594-465239ea3a1e)
Expand Down

0 comments on commit 5eb3461

Please sign in to comment.