support csv

app.py

@@ -1,18 +1,22 @@
 import gradio as gr
 import pytz
 import os
+import shutil
+import re
 import matplotlib.pyplot as plt
 from datetime import datetime
 from markdown import instructions_markdown, faq_markdown
 from fsrs_optimizer import Optimizer
 from pathlib import Path
 from utilities import cleanup
-import re
 
 with open("./requirements.txt", "r") as f:
     txt = f.read().strip()
     version = re.search(r"FSRS-Optimizer==(.*)", txt).group(1)
 
+home_path = os.getcwd()
+
+
 def get_w_markdown(w):
     return f"""
     # Updated Parameters
@@ -26,33 +30,64 @@ def get_w_markdown(w):
     """
 
 
-def anki_optimizer(file: gr.File, timezone, next_day_starts_at, revlog_start_date, filter_out_suspended_cards, requestRetention,
-                   progress=gr.Progress(track_tqdm=True)):
-    os.chdir('/home/user/app')                
-    if file is None or (not file.name.endswith(".apkg") and not file.name.endswith(".colpkg")):
-        raise ValueError("Please upload a deck/collection file.")
+def optimizer(
+    file: gr.File,
+    timezone,
+    next_day_starts_at,
+    revlog_start_date,
+    filter_out_suspended_cards,
+    requestRetention,
+    progress=gr.Progress(track_tqdm=True),
+):
+    os.chdir(home_path)
+    if file is None:
+        raise ValueError("Please upload a deck/collection/csv file.")
+    if file.name.endswith(".apkg") or file.name.endswith(".colpkg"):
+        mode = "anki"
+    elif file.name.endswith(".csv"):
+        mode = "csv"
+    else:
+        raise ValueError(
+            "File must be an Anki deck/collection file (.apkg or .colpkg) or a csv file."
+        )
     if timezone == "":
         raise ValueError("Please select a timezone.")
     now = datetime.now()
-    files = ['prediction.tsv', 'revlog.csv', 'revlog_history.tsv', 'stability_for_analysis.tsv',
-             'expected_time.csv', 'evaluation.tsv']
-    prefix = now.strftime(f'%Y_%m_%d_%H_%M_%S')
-    suffix = file.name.split('/')[-1].replace(".", "_").replace("@", "_")
-    proj_dir = Path(f'projects/{prefix}/{suffix}')
+    files = [
+        "prediction.tsv",
+        "revlog.csv",
+        "revlog_history.tsv",
+        "stability_for_analysis.tsv",
+        "expected_time.csv",
+        "evaluation.tsv",
+    ]
+    prefix = now.strftime(f"%Y_%m_%d_%H_%M_%S")
+    suffix = file.name.split("/")[-1].replace(".", "_").replace("@", "_")
+    proj_dir = Path(f"projects/{prefix}/{suffix}")
     proj_dir.mkdir(parents=True, exist_ok=True)
     os.chdir(proj_dir)
     optimizer = Optimizer()
-    optimizer.anki_extract(file.name, filter_out_suspended_cards)
-    analysis_markdown = optimizer.create_time_series(timezone, revlog_start_date, next_day_starts_at).replace("\n", "\n\n")
+    if mode == "anki":
+        optimizer.anki_extract(file.name, filter_out_suspended_cards)
+    else:
+        print(file.name)
+        shutil.copyfile(file.name, "./revlog.csv")
+    analysis_markdown = optimizer.create_time_series(
+        timezone, revlog_start_date, next_day_starts_at
+    ).replace("\n", "\n\n")
     optimizer.define_model()
     optimizer.pretrain(verbose=False)
     optimizer.train(verbose=False)
     print(optimizer.w)
     w_markdown = get_w_markdown(optimizer.w)
     optimizer.predict_memory_states()
-    difficulty_distribution = optimizer.difficulty_distribution.to_string().replace("\n", "\n\n")
+    difficulty_distribution = optimizer.difficulty_distribution.to_string().replace(
+        "\n", "\n\n"
+    )
     plot_output = optimizer.find_optimal_retention()[0]
-    suggested_retention_markdown = f"""# Suggested Retention: `{optimizer.optimal_retention:.2f}`"""
+    suggested_retention_markdown = (
+        f"""# Suggested Retention: `{optimizer.optimal_retention:.2f}`"""
+    )
     rating_markdown = optimizer.preview(requestRetention).replace("\n", "\n\n")
     loss_before, loss_after = optimizer.evaluate()
     loss_markdown = f"""
@@ -73,15 +108,15 @@ def anki_optimizer(file: gr.File, timezone, next_day_starts_at, revlog_start_dat
 # Ratings
 {rating_markdown}
 """
-    os.chdir('/home/user/app')
+    os.chdir(home_path)
     files_out = [proj_dir / file for file in files if (proj_dir / file).exists()]
     cleanup(proj_dir, files)
-    plt.close('all')
+    plt.close("all")
     return w_markdown, markdown_out, plot_output, files_out
 
 
 description = f"""
-# FSRS4Anki Optimizer App - v{version}
+# FSRS Optimizer - v{version}
 Based on the [tutorial](https://medium.com/@JarrettYe/how-to-use-the-next-generation-spaced-repetition-algorithm-fsrs-on-anki-5a591ca562e2) 
 of [Jarrett Ye](https://github.com/L-M-Sherlock). This application can give you personalized anki parameters without having to code.
 
@@ -89,25 +124,34 @@ Read the `Instructions` if its your first time using the app.
 """
 
 with gr.Blocks() as demo:
-    with gr.Tab("FSRS4Anki Optimizer"):
+    with gr.Tab("FSRS Optimizer"):
         with gr.Box():
             gr.Markdown(description)
         with gr.Box():
             with gr.Row():
                 with gr.Column():
-                    file = gr.File(label='Review Logs (Step 1)')
+                    file = gr.File(label="Review Logs (Step 1)")
                 with gr.Column():
-                    next_day_starts_at = gr.Number(value=4,
-                                                   label="Next Day Starts at (Step 2)",
-                                                   precision=0)
-                    timezone = gr.Dropdown(label="Timezone (Step 3.1)", choices=pytz.all_timezones)
-                    filter_out_suspended_cards = gr.Checkbox(value=False, label="Filter out suspended cards")
+                    next_day_starts_at = gr.Number(
+                        value=4, label="Next Day Starts at (Step 2)", precision=0
+                    )
+                    timezone = gr.Dropdown(
+                        label="Timezone (Step 3.1)", choices=pytz.all_timezones
+                    )
+                    filter_out_suspended_cards = gr.Checkbox(
+                        value=False, label="Filter out suspended cards"
+                    )
                     with gr.Accordion(label="Advanced Settings (Step 3.2)", open=False):
-                        requestRetention = gr.Number(value=.9, label="Desired Retention: Recommended to set between 0.8  0.9")
-                        revlog_start_date = gr.Textbox(value="2006-10-05",
-                                                       label="Revlog Start Date: Optimize review logs after this date.")
+                        requestRetention = gr.Number(
+                            value=0.9,
+                            label="Desired Retention: Recommended to set between 0.8  0.9",
+                        )
+                        revlog_start_date = gr.Textbox(
+                            value="2006-10-05",
+                            label="Revlog Start Date: Optimize review logs after this date.",
+                        )
         with gr.Row():
-            btn_plot = gr.Button('Optimize your Anki!')
+            btn_plot = gr.Button("Optimize!")
         with gr.Row():
             w_output = gr.Markdown()
     with gr.Tab("Instructions"):
@@ -122,8 +166,17 @@ with gr.Blocks() as demo:
     with gr.Tab("FAQ"):
         gr.Markdown(faq_markdown)
 
-    btn_plot.click(anki_optimizer,
-                   inputs=[file, timezone, next_day_starts_at, revlog_start_date, filter_out_suspended_cards, requestRetention],
-                   outputs=[w_output, markdown_output, plot_output, files_output])
+    btn_plot.click(
+        optimizer,
+        inputs=[
+            file,
+            timezone,
+            next_day_starts_at,
+            revlog_start_date,
+            filter_out_suspended_cards,
+            requestRetention,
+        ],
+        outputs=[w_output, markdown_output, plot_output, files_output],
+    )
 
 demo.queue().launch(show_error=True)

markdown.py

@@ -1,7 +1,7 @@
 instructions_markdown = """
-# How to get personalized FSRS Anki parameters
+# How to get personalized FSRS parameters
 If you have been using Anki for some time and have accumulated a lot of review logs, you can try this 
-FSRS4Anki optimizer app to generate parameters for you.
+FSRS optimizer app to generate parameters for you.
 
 This is based on the amazing work of [Jarrett Ye](https://github.com/L-M-Sherlock). My goal is to further 
 democratize this technology so anyone can use it!
@@ -41,4 +41,4 @@ You can find it here: [https://www.maimemo.com/paper/](https://www.maimemo.com/p
 What is the original author's research story?
 
 You can find it here: [https://medium.com/@JarrettYe/how-did-i-publish-a-paper-in-acmkdd-as-an-undergraduate-c0199baddf31](https://medium.com/@JarrettYe/how-did-i-publish-a-paper-in-acmkdd-as-an-undergraduate-c0199baddf31)
-"""
+"""

utilities.py

@@ -5,12 +5,15 @@ from pathlib import Path
 
 # Extract the collection file or deck file to get the .anki21 database.
 def extract(file, prefix):
-    proj_dir = Path(f'projects/{prefix}_{file.orig_name.replace(".", "_").replace("@", "_")}')
-    with ZipFile(file, 'r') as zip_ref:
+    proj_dir = Path(
+        f'projects/{prefix}_{file.orig_name.replace(".", "_").replace("@", "_")}'
+    )
+    with ZipFile(file, "r") as zip_ref:
         zip_ref.extractall(proj_dir)
         # print(f"Extracted {file.orig_name} successfully!")
     return proj_dir
 
+
 def cleanup(proj_dir: Path, files):
     """
     Delete all files in prefix that dont have filenames in files
@@ -18,7 +21,6 @@ def cleanup(proj_dir: Path, files):
     :param files:
     :return:
     """
-    for file in proj_dir.glob('*'):
+    for file in proj_dir.glob("*"):
         if file.name not in files:
             os.remove(file)
-