Add TinyTeach: PDF-based curiosity-driven tutor app - #7
Open
Ad-gh-26 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is TinyTeach?
TinyTeach is a standalone Python/Streamlit app that turns any programming-language
PDF (Python, Java, C++, Rust, Go, etc.) into a personal tutor. It parses and indexes
the book locally with FAISS, then uses a small LLM to generate 5–8 progressive case
studies plus a learning roadmap for any topic the user asks about.
Key features
prompt template registry, so the retrieval core stays language-agnostic
expected output, progressive hints, and a fact check
and Ollama
instead of making something up
Why it's added as a separate folder
TinyTeach runs on a different stack (Python/Streamlit) than the existing
client//server/app in this repo, so it's added as a self-contained projectunder
/tinyteachrather than merged into the existing structure.What's included
src/) — parsing, chunking, embedding, retrieval, generation,and UI layers
tests/) — unit and integration testsdocs/,README.md,PROJECT_BLUEPRINT.md,context.md).env.examplefor configuration (no real secrets included)What's excluded
.env(contains local secrets)data/(FAISS indices — regenerated automatically at runtime from uploaded PDFs)__pycache__,.pytest_cache,*.log)