GeetaAIVisionary commited on
Commit
525dd67
·
verified ·
1 Parent(s): aefc6cb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +2 -55
README.md CHANGED
@@ -12,59 +12,6 @@ pinned: false
12
 
13
  # Spelling Bee Tutor — tiny NeMo Guardrails demo
14
 
15
- This is a super small, offline spelling-bee CLI.
16
- It runs on your laptop, reads from a CSV, and **does not call any external LLMs**.
17
  I included a minimal NeMo Guardrails folder so I can talk about flows/config during interviews.
18
-
19
- ## Why this exists
20
- - I wanted a **clean, deterministic** demo I can screen-share.
21
- - Shows I understand the **Guardrails structure** (flows + rails.yaml) even if the runtime isn’t wired.
22
- - No keys, no setup drama. Just run it.
23
-
24
- ## Try it
25
- ```bash
26
- python3 -m venv .venv && source .venv/bin/activate
27
- pip install -r requirements.txt
28
- python app.py
29
- Then type in the app:
30
-
31
- vbnet
32
- Copy
33
- Edit
34
- start
35
- definition | origin | sentence
36
- <your spelling attempt>
37
- next
38
- stop
39
- What’s inside
40
- app.py — the tiny CLI tutor (hardest → easiest, hints on demand).
41
-
42
- words.csv — sample word list; swap with your own easily.
43
-
44
- rails/colang/v2/flows.co — simple Guardrails flows (v1-style syntax).
45
-
46
- rails/rails.yaml — minimal config stub (for discussion).
47
-
48
- Notes for NVIDIA folks
49
- Deterministic and offline by design (easy to demo).
50
-
51
- Guardrails folders included to explain how I’d wire tools/actions.
52
-
53
- Easy upgrade path to NeMo Guardrails runtime or Gradio UI.
54
-
55
- Upgrade ideas (later)
56
- Add a tiny custom “dummy LLM” provider and run with Guardrails 0.15.
57
-
58
- Wrap with Gradio and publish a Hugging Face Space.
59
-
60
- Add unit tests + pre-commit (black/ruff).
61
-
62
- Screenshots
63
- Drop PNGs in screenshots/ and embed like:
64
-
65
- arduino
66
- Copy
67
- Edit
68
- ![Terminal run](screenshots/terminal-run.png)
69
- License
70
- MIT
 
12
 
13
  # Spelling Bee Tutor — tiny NeMo Guardrails demo
14
 
15
+ This is a super small, offline spelling-bee CLI.
16
+ It runs on your laptop, reads from a CSV, and does not call any external LLMs.
17
  I included a minimal NeMo Guardrails folder so I can talk about flows/config during interviews.