Update README.md
Browse files
README.md
CHANGED
|
@@ -1,10 +1,56 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# CanisAI
|
| 2 |
+
|
| 3 |
+
Open, practical AI for learning and teaching — from data tools to fine‑tuned tutors.
|
| 4 |
+
|
| 5 |
+
- Mission: Build transparent, modular AI that educators can understand, improve, and trust.
|
| 6 |
+
- Projects:
|
| 7 |
+
- Canis.teach — subject‑tuned tutors
|
| 8 |
+
- Canis.lab — dataset and tooling suite for building tutors
|
| 9 |
+
- Values: Classroom‑first design, privacy awareness, reproducibility, and open collaboration
|
| 10 |
+
|
| 11 |
+
## Projects
|
| 12 |
+
|
| 13 |
+
### Canis.teach
|
| 14 |
+
Fine‑tuned Qwen3‑based models for subject‑aware tutoring dialogs, optimized for clarity, hints, and step‑by‑step support.
|
| 15 |
+
|
| 16 |
+
- Base: Qwen/Qwen3‑4B‑Instruct‑2507
|
| 17 |
+
- Variants: math, science, humanities, language, and “all” (blended)
|
| 18 |
+
- Artifacts: LoRA adapters (lightweight) and optionally merged checkpoints
|
| 19 |
+
- Cards: Model cards include dataset provenance, training setup, and usage guidance
|
| 20 |
+
- Tag: `canis-teach`
|
| 21 |
+
|
| 22 |
+
Why: Students need didactic dialogue, not just short answers. Our models emphasize teaching structure, metacognitive hints, and rubrics‑aligned responses.
|
| 23 |
+
|
| 24 |
+
### Canis.lab
|
| 25 |
+
A lightweight toolchain to generate, transform, and validate tutoring datasets and pipelines.
|
| 26 |
+
|
| 27 |
+
- Capabilities:
|
| 28 |
+
- Generate and refine dialogue data with role‑structured turns
|
| 29 |
+
- Apply chat templates and unify formatting for HF datasets
|
| 30 |
+
- Output: Ready‑to‑train datasets for Expert Language Models (ELM)
|
| 31 |
+
|
| 32 |
+
Why: Good tutors start with good data. Canis.lab standardizes data flow so educators and researchers can iterate quickly and reproducibly.
|
| 33 |
+
|
| 34 |
+
## Get started
|
| 35 |
+
|
| 36 |
+
- Try a Canis.teach model:
|
| 37 |
+
1) Load base model: `Qwen/Qwen3-4B-Instruct-2507`
|
| 38 |
+
2) Apply the chosen subject’s LoRA adapter
|
| 39 |
+
3) Or use the ggufs provided inside of Ollama
|
| 40 |
+
- Build with Canis.lab:
|
| 41 |
+
- Check out the Github page: https://github.com/crasyK/Canis.lab
|
| 42 |
+
|
| 43 |
+
## Safety and limitations
|
| 44 |
+
|
| 45 |
+
- Intended for educational support with human oversight.
|
| 46 |
+
- May hallucinate or oversimplify; verify critical facts.
|
| 47 |
+
- Use RAG or curriculum documents for fact‑heavy topics.
|
| 48 |
+
- Comply with local privacy and data‑handling policies.
|
| 49 |
+
|
| 50 |
+
## Contribute
|
| 51 |
+
|
| 52 |
+
- Educators: share tasks, rubrics, and feedback to improve tutoring quality.
|
| 53 |
+
- Researchers: extend datasets, add evals, or submit fine‑tuned adapters.
|
| 54 |
+
- Partners: contact us for pilots, evaluations, or deployments.
|
| 55 |
+
|
| 56 |
+
Teach boldly. Build openly. 🐾
|