This folder is the documentation index for the EduScale research monorepo, model training pipeline, benchmark evidence, and Android app.
| Goal | Read |
|---|---|
| Understand the whole study | ../README.md |
| First-time setup | user-guide/installation.md |
| Quick repo orientation | user-guide/quick-start.md |
| Workflow map | guides/README.md |
| Missing project details to answer | RESEARCH_QUESTIONS.md |
| Troubleshooting | user-guide/troubleshooting.md |
| Evidence type | Source |
|---|---|
| Training history | ../TRAINING_REPORT.md |
| Dataset manifests | ../datasets/manifests |
| Dataset workflow | ../datasets/README.md |
| Model workflow | ../models/README.md |
| Benchmark workflow | ../benchmarks/README.md |
| Benchmark outputs | ../benchmarks/results |
| Android model packaging | ../android/app/src/main/assets/README.md |
| Thesis source files | ../thesis/README.md |
| Section | What it covers |
|---|---|
| user-guide | Installation, quick start, FAQ, and troubleshooting |
| guides | Practical workflows for datasets, models, Android, benchmarks, experiments, and tools |
| architecture | Android and pipeline design notes |
| development | Setup and testing notes |
| api | Internal API notes for app subsystems |
- ../README.md
- user-guide/installation.md
- guides/datasets.md
- guides/models.md
- guides/benchmarks.md
- guides/android.md
- RESEARCH_QUESTIONS.md
Keep stable explanations here:
- setup and repeatable workflows
- metric definitions and interpretation
- architecture notes
- Android packaging and deployment notes
- research assumptions that are not tied to a single experiment
Keep raw generated outputs, temporary exports, and large media outside this folder.