Upload folder using huggingface_hub

.github/workflows/update_space.yml

@@ -0,0 +1,28 @@
+name: Run Python script
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+
+    - name: Install Gradio
+      run: python -m pip install gradio
+
+    - name: Log in to Hugging Face
+      run: python -c 'import huggingface_hub; huggingface_hub.login(token="${{ secrets.hf_token }}")'
+
+    - name: Deploy to Spaces
+      run: gradio deploy

.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# VSCode / Misc
+.vscode
+.ruff_cache
+flagged
+*.csv

LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2024, justin
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,12 +1,6 @@
 ---
-title: Ankigen
-emoji: 🐨
-colorFrom: indigo
-colorTo: red
-sdk: gradio
-sdk_version: 4.44.1
+title: ankigen
 app_file: app.py
-pinned: false
+sdk: gradio
+sdk_version: 4.44.0
 ---
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -0,0 +1,272 @@
+from openai import OpenAI
+from pydantic import BaseModel
+from typing import List, Optional
+import gradio as gr
+
+
+class Step(BaseModel):
+    explanation: str
+    output: str
+
+
+class Subtopics(BaseModel):
+    steps: List[Step]
+    result: List[str]
+
+
+class Topics(BaseModel):
+    result: List[Subtopics]
+
+
+class CardFront(BaseModel):
+    question: Optional[str] = None
+
+
+class CardBack(BaseModel):
+    answer: Optional[str] = None
+    explanation: str
+    example: str
+
+
+class Card(BaseModel):
+    front: CardFront
+    back: CardBack
+
+
+class CardList(BaseModel):
+    topic: str
+    cards: List[Card]
+
+
+def structured_output_completion(
+    client, model, response_format, system_prompt, user_prompt
+):
+    try:
+        completion = client.beta.chat.completions.parse(
+            model=model,
+            messages=[
+                {"role": "system", "content": system_prompt.strip()},
+                {"role": "user", "content": user_prompt.strip()},
+            ],
+            response_format=response_format,
+        )
+
+    except Exception as e:
+        print(f"An error occurred during the API call: {e}")
+        return None
+
+    try:
+        if not hasattr(completion, "choices") or not completion.choices:
+            print("No choices returned in the completion.")
+            return None
+
+        first_choice = completion.choices[0]
+        if not hasattr(first_choice, "message"):
+            print("No message found in the first choice.")
+            return None
+
+        if not hasattr(first_choice.message, "parsed"):
+            print("Parsed message not available in the first choice.")
+            return None
+
+        return first_choice.message.parsed
+
+    except Exception as e:
+        print(f"An error occurred while processing the completion: {e}")
+        raise gr.Error(f"Processing error: {e}")
+
+
+def generate_cards(
+    api_key_input,
+    subject,
+    topic_number=1,
+    cards_per_topic=2,
+    preference_prompt="assume I'm a beginner",
+):
+    """
+    Generates flashcards for a given subject.
+
+    Parameters:
+    - subject (str): The subject to generate cards for.
+    - topic_number (int): Number of topics to generate.
+    - cards_per_topic (int): Number of cards per topic.
+    - preference_prompt (str): User preferences to consider.
+
+    Returns:
+    - List[List[str]]: A list of rows containing
+    [topic, question, answer, explanation, example].
+    """
+
+    gr.Info("Starting process")
+
+    if not api_key_input:
+        return gr.Error("Error: OpenAI API key is required.")
+
+    client = OpenAI(api_key=api_key_input)
+    model = "gpt-4o-mini"
+
+    all_card_lists = []
+
+    system_prompt = f"""
+    You are an expert in {subject}, assisting the user to master the topic while 
+    keeping in mind the user's preferences: {preference_prompt}.
+    """
+
+    topic_prompt = f"""
+    Generate the top {topic_number} important subjects to know on {subject} in 
+    order of ascending difficulty.
+    """
+
+    try:
+        topics_response = structured_output_completion(
+            client, model, Topics, system_prompt, topic_prompt
+        )
+        if topics_response is None:
+            print("Failed to generate topics.")
+            return []
+        if not hasattr(topics_response, "result") or not topics_response.result:
+            print("Invalid topics response format.")
+            return []
+        topic_list = [
+            item for subtopic in topics_response.result for item in subtopic.result
+        ][:topic_number]
+    except Exception as e:
+        raise gr.Error(f"Topic generation failed due to {e}")
+
+    for topic in topic_list:
+        card_prompt = f"""
+        You are to generate {cards_per_topic} cards on {subject}: "{topic}" 
+        keeping in mind the user's preferences: {preference_prompt}.
+        
+        Questions should cover both sample problems and concepts.
+
+        Use the explanation field to help the user understand the reason behind things 
+        and maximize learning. Additionally, offer tips (performance, gotchas, etc.).
+        """
+
+        try:
+            cards = structured_output_completion(
+                client, model, CardList, system_prompt, card_prompt
+            )
+            if cards is None:
+                print(f"Failed to generate cards for topic '{topic}'.")
+                continue
+            if not hasattr(cards, "topic") or not hasattr(cards, "cards"):
+                print(f"Invalid card response format for topic '{topic}'.")
+                continue
+            all_card_lists.append(cards)
+        except Exception as e:
+            print(f"An error occurred while generating cards for topic '{topic}': {e}")
+            continue
+
+    flattened_data = []
+
+    for card_list_index, card_list in enumerate(all_card_lists, start=1):
+        try:
+            topic = card_list.topic
+            # Get the total number of cards in this list to determine padding
+            total_cards = len(card_list.cards)
+            # Calculate the number of digits needed for padding
+            padding = len(str(total_cards))
+            
+            for card_index, card in enumerate(card_list.cards, start=1):
+                # Format the index with zero-padding
+                index = f"{card_list_index}.{card_index:0{padding}}"
+                question = card.front.question
+                answer = card.back.answer
+                explanation = card.back.explanation
+                example = card.back.example
+                row = [index, topic, question, answer, explanation, example]
+                flattened_data.append(row)
+        except Exception as e:
+            print(f"An error occurred while processing card {index}: {e}")
+            continue
+
+    return flattened_data
+
+
+def export_csv(d):
+    MIN_ROWS = 2
+
+    if len(d) < MIN_ROWS:
+        gr.Warning(f"The dataframe has fewer than {MIN_ROWS} rows. Nothing to export.")
+        return None
+
+    gr.Info("Exporting...")
+    d.to_csv("anki_deck.csv", index=False)
+    return gr.File(value="anki_deck.csv", visible=True)
+
+
+with gr.Blocks(
+    gr.themes.Soft(), title="AnkiGen", css="footer{display:none !important}"
+) as ankigen:
+    gr.Markdown("# 📚 AnkiGen - Anki Card Generator")
+    gr.Markdown(
+        """
+        #### Generate an Anki comptible .csv using LLMs based on your subject and preferences.
+        """
+    )
+
+    with gr.Row():
+        with gr.Column(scale=1):
+            gr.Markdown("### Configuration")
+
+            api_key_input = gr.Textbox(
+                label="OpenAI API Key",
+                type="password",
+                placeholder="Enter your OpenAI API key",
+            )
+            subject = gr.Textbox(
+                label="Subject",
+                placeholder="Enter the subject, e.g., 'Basic SQL Concepts'",
+            )
+            topic_number = gr.Slider(
+                label="Number of Topics", minimum=2, maximum=20, step=1, value=2
+            )
+            cards_per_topic = gr.Slider(
+                label="Cards per Topic", minimum=2, maximum=30, step=1, value=3
+            )
+            preference_prompt = gr.Textbox(
+                label="Preference Prompt",
+                placeholder="Any preferences? e.g., 'Assume I'm a beginner'",
+            )
+            generate_button = gr.Button("Generate Cards")
+        with gr.Column(scale=2):
+            gr.Markdown("### Generated Cards")
+            gr.Markdown(
+                """
+                Subject to change: currently exports a .csv with the following fields, you can
+                create a new note type with these fields to handle importing.: 
+                <b>Index, Topic, Question, Answer, Explanation, Example</b>
+                """)
+            output = gr.Dataframe(
+                headers=[
+                    "Index",
+                    "Topic",
+                    "Question",
+                    "Answer",
+                    "Explanation",
+                    "Example",
+                ],
+                interactive=False,
+                height=800,
+            )
+            export_button = gr.Button("Export to CSV")
+            download_link = gr.File(interactive=False, visible=False)
+
+    generate_button.click(
+        fn=generate_cards,
+        inputs=[
+            api_key_input,
+            subject,
+            topic_number,
+            cards_per_topic,
+            preference_prompt,
+        ],
+        outputs=output,
+    )
+
+    export_button.click(fn=export_csv, inputs=output, outputs=download_link)
+
+if __name__ == "__main__":
+    ankigen.launch(share=False, favicon_path="./favicon.ico")

pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "ankigen"
+version = "0.1.0"
+description = ""
+authors = ["Justin <9146678+brickfrog@users.noreply.github.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+polars = "^1.0.0"
+openai = "^1.35.10"
+python-dotenv = "^1.0.1"
+gradio = "^4.44.0"
+
+[tool.poetry.group.dev.dependencies]
+ipykernel = "^6.29.5"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

requirements.txt

@@ -0,0 +1,63 @@
+aiofiles==23.2.1 ; python_version >= "3.12" and python_version < "4.0"
+annotated-types==0.7.0 ; python_version >= "3.12" and python_version < "4.0"
+anyio==4.6.0 ; python_version >= "3.12" and python_version < "4.0"
+certifi==2024.8.30 ; python_version >= "3.12" and python_version < "4.0"
+charset-normalizer==3.3.2 ; python_version >= "3.12" and python_version < "4.0"
+click==8.1.7 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+colorama==0.4.6 ; python_version >= "3.12" and python_version < "4.0" and platform_system == "Windows"
+contourpy==1.3.0 ; python_version >= "3.12" and python_version < "4.0"
+cycler==0.12.1 ; python_version >= "3.12" and python_version < "4.0"
+distro==1.9.0 ; python_version >= "3.12" and python_version < "4.0"
+fastapi==0.115.0 ; python_version >= "3.12" and python_version < "4.0"
+ffmpy==0.4.0 ; python_version >= "3.12" and python_version < "4.0"
+filelock==3.16.1 ; python_version >= "3.12" and python_version < "4.0"
+fonttools==4.53.1 ; python_version >= "3.12" and python_version < "4.0"
+fsspec==2024.9.0 ; python_version >= "3.12" and python_version < "4.0"
+gradio-client==1.3.0 ; python_version >= "3.12" and python_version < "4.0"
+gradio==4.44.0 ; python_version >= "3.12" and python_version < "4.0"
+h11==0.14.0 ; python_version >= "3.12" and python_version < "4.0"
+httpcore==1.0.5 ; python_version >= "3.12" and python_version < "4.0"
+httpx==0.27.2 ; python_version >= "3.12" and python_version < "4.0"
+huggingface-hub==0.25.0 ; python_version >= "3.12" and python_version < "4.0"
+idna==3.10 ; python_version >= "3.12" and python_version < "4.0"
+importlib-resources==6.4.5 ; python_version >= "3.12" and python_version < "4.0"
+jinja2==3.1.4 ; python_version >= "3.12" and python_version < "4.0"
+jiter==0.5.0 ; python_version >= "3.12" and python_version < "4.0"
+kiwisolver==1.4.7 ; python_version >= "3.12" and python_version < "4.0"
+markdown-it-py==3.0.0 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+markupsafe==2.1.5 ; python_version >= "3.12" and python_version < "4.0"
+matplotlib==3.9.2 ; python_version >= "3.12" and python_version < "4.0"
+mdurl==0.1.2 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+numpy==2.1.1 ; python_version >= "3.12" and python_version < "4.0"
+openai==1.47.0 ; python_version >= "3.12" and python_version < "4.0"
+orjson==3.10.7 ; python_version >= "3.12" and python_version < "4.0"
+packaging==24.1 ; python_version >= "3.12" and python_version < "4.0"
+pandas==2.2.3 ; python_version >= "3.12" and python_version < "4.0"
+pillow==10.4.0 ; python_version >= "3.12" and python_version < "4.0"
+polars==1.7.1 ; python_version >= "3.12" and python_version < "4.0"
+pydantic-core==2.23.4 ; python_version >= "3.12" and python_version < "4.0"
+pydantic==2.9.2 ; python_version >= "3.12" and python_version < "4.0"
+pydub==0.25.1 ; python_version >= "3.12" and python_version < "4.0"
+pygments==2.18.0 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+pyparsing==3.1.4 ; python_version >= "3.12" and python_version < "4.0"
+python-dateutil==2.9.0.post0 ; python_version >= "3.12" and python_version < "4.0"
+python-dotenv==1.0.1 ; python_version >= "3.12" and python_version < "4.0"
+python-multipart==0.0.10 ; python_version >= "3.12" and python_version < "4.0"
+pytz==2024.2 ; python_version >= "3.12" and python_version < "4.0"
+pyyaml==6.0.2 ; python_version >= "3.12" and python_version < "4.0"
+requests==2.32.3 ; python_version >= "3.12" and python_version < "4.0"
+rich==13.8.1 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+ruff==0.6.7 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+semantic-version==2.10.0 ; python_version >= "3.12" and python_version < "4.0"
+shellingham==1.5.4 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+six==1.16.0 ; python_version >= "3.12" and python_version < "4.0"
+sniffio==1.3.1 ; python_version >= "3.12" and python_version < "4.0"
+starlette==0.38.6 ; python_version >= "3.12" and python_version < "4.0"
+tomlkit==0.12.0 ; python_version >= "3.12" and python_version < "4.0"
+tqdm==4.66.5 ; python_version >= "3.12" and python_version < "4.0"
+typer==0.12.5 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+typing-extensions==4.12.2 ; python_version >= "3.12" and python_version < "4.0"
+tzdata==2024.1 ; python_version >= "3.12" and python_version < "4.0"
+urllib3==2.2.3 ; python_version >= "3.12" and python_version < "4.0"
+uvicorn==0.30.6 ; python_version >= "3.12" and python_version < "4.0" and sys_platform != "emscripten"
+websockets==12.0 ; python_version >= "3.12" and python_version < "4.0"