AnkiAIUtils  by thiswillbeyourgithub

AI-powered tools for enhancing Anki flashcards with explanations, mnemonics, and illustrations

created 1 year ago
772 stars

Top 46.1% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides AI-powered tools to enhance Anki flashcards, targeting students and lifelong learners who want to improve their study efficiency. It automates the creation of explanations, mnemonics, and illustrations for flashcards, particularly for complex subjects like medicine.

How It Works

The suite leverages Large Language Models (LLMs) and image generation models to augment Anki cards. It analyzes card content, generates relevant mnemonics using techniques like the Major System and memory anchors, creates visual aids with AI image generation (DALL-E, Stable Diffusion), and reformulates card text for clarity and conciseness. It supports provider-agnostic LLM usage via LiteLLM and aims for universal Anki compatibility.

Quick Start & Requirements

  • Install: Clone the repository (git clone https://github.com/thiswillbeyourgithub/AnkiAIUtils/).
  • Prerequisites: Python (3.11 or 3.12 recommended), virtual environment.
  • Dependencies: LiteLLM, AnkiConnect (for Anki interaction).
  • Setup: Create a virtual environment and install dependencies.
  • Usage: Run individual Python scripts (e.g., python reformulator.py, python illustrator.py) with specified arguments for Anki queries, LLM models, and dataset paths.
  • Docs: Usage / Getting started

Highlighted Details

  • Adaptive Learning: Uses semantic similarity to match cards with relevant examples from training datasets.
  • Personalized Memory Hooks: Supports custom mnemonics and memory anchors.
  • Automation Ready: Scripts can be automated (e.g., via cron jobs) to process failed cards.
  • Provider Agnostic: Works with any LLM provider supported by LiteLLM.
  • Extensible: Supports adding custom datasets for tailored results.

Maintenance & Community

The project is actively seeking contributors to package the scripts into Anki add-ons and improve code quality. A roadmap and TODO list are available.

Licensing & Compatibility

The repository does not explicitly state a license in the README. Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

The project is described as a collection of scripts that are not yet packaged as a user-friendly Anki add-on. Some documentation might be imprecise, and scripts could have minor issues due to a hasty release. Code duplication exists across tools, and the developer is seeking help with packaging, PyPI installation, and code cleanup.

Health Check
Last commit

5 months ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
44 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.