Hermes Bot Oz commited on
Commit
2144ff0
·
unverified ·
2 Parent(s): 973f4b7750a091

Release develop → main

Browse files

Merge DOX-structured docs with v0.7 content (TinyBard context-aware,
featherless-ai provider, Anishinaabe aesthetic section).

Co-Authored-By: Oz <oz-agent@warp.dev>

Files changed (1) hide show
  1. llms.txt +106 -14
llms.txt CHANGED
@@ -7,7 +7,7 @@ Three Gradio apps targeting all tracks + maximum badges + sponsor prizes. Hack w
7
  ## Ownership
8
 
9
  - **Name:** Build Small Hackathon 2026 — Team nbiish
10
- - **Version:** 0.5.0 — Cedar-Copper Edition (HF Inference API)
11
  - **Operator:** nbiish
12
 
13
  ## Local Contracts
@@ -64,17 +64,20 @@ Cedar-copper visual language — sky-to-sunrise palette (water-blue → cedar
64
  - HF README metadata: `colorTo` must be one of `[red, yellow, green, blue, indigo, purple, pink, gray]` (no `emerald`/`amber`).
65
  - HF README metadata: `emoji` must match `/\p{Extended_Pictographic}/u` — only the standard emoji block is allowed. Use a real emoji.
66
 
67
- ### Inference Architecture (v0.5+)
68
 
69
  - **All LLM inference** via the **Hugging Face Inference API** (serverless). No local GGUF, no `llama-cpp-python` compile step.
70
- - Shared module: `shared/inference_client.py` provides `cooldown_status()`, `cooldown_active()`, `generate()`, and `chat_messages()`.
71
- - Default model: `Qwen/Qwen2.5-1.5B-Instruct` (free tier, fast, well-suited to chat). Override via `INFERENCE_MODEL`.
 
72
  - Per-project model override: `TINYBARD_MODEL`, `FOCUSFRIEND_MODEL`, `CRITTERCALM_MODEL`.
 
73
  - **Cooldowns** enforce a per-project minimum gap between inference calls (protects HF/Modal credit budget):
74
  - `tinybard`: 6s
75
  - `focusfriend`: 10s
76
  - `crittercalm`: 12s
77
  - Override via `TINYBARD_COOLDOWN_SECONDS`, etc., or global `INFERENCE_COOLDOWN_SECONDS`.
 
78
  - **Always-fallback:** every LLM call falls back to procedural / template output if inference fails or is in cooldown. No LLM call ever blocks the UX.
79
  - HF Spaces are the dev/test environment — iterate live at `huggingface.co/spaces/nbiish/{tinybard,focusfriend,crittercalm}` rather than localhost.
80
 
@@ -93,12 +96,13 @@ Cedar-copper visual language — sky-to-sunrise palette (water-blue → cedar
93
 
94
  ### Short-term Goals
95
 
96
- - Iterate on the live HF Spaces
97
- - Set HF_TOKEN + INFERENCE_MODEL Space secrets to enable real LLM-backed adventures
98
- - Record demo videos and post to social media
99
- - Write and publish Field Notes blog posts
100
  - Share agent traces for Sharing is Caring badge
101
  - Polish UIs for demo appeal
 
 
102
 
103
  ## Verification
104
 
@@ -107,6 +111,43 @@ Cedar-copper visual language — sky-to-sunrise palette (water-blue → cedar
107
  - Cedar-copper aesthetic consistent across all UIs
108
  - No hardcoded secrets; no cloud API calls in production path
109
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
110
  ## TODO
111
 
112
  ### In Progress
@@ -131,12 +172,63 @@ Cedar-copper visual language — sky-to-sunrise palette (water-blue → cedar
131
  - [x] HF CLI installed + skills configured
132
  - [x] llama-cpp-python installed — for reference; v0.5+ uses HF Inference API
133
  - [x] Local verification: all 3 apps run on ports 7861/7862/7863
134
- - [x] TinyBard end-to-end game loop verified
135
- - [x] FocusFriend chat verified
136
- - [x] CritterCalm UI navigation verified
137
- - [x] v0.5: HF Inference API wired into all 3 apps
138
- - [x] v0.5: Cooldown system in shared/inference_client.py
139
- - [x] v0.5: TinyBard local test — procedural fallback + cooldown UI
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
140
 
141
  ## Child DOX Index
142
 
 
7
  ## Ownership
8
 
9
  - **Name:** Build Small Hackathon 2026 — Team nbiish
10
+ - **Version:** 0.7.0 — Cedar-Copper Edition (Context-Aware LLM)
11
  - **Operator:** nbiish
12
 
13
  ## Local Contracts
 
64
  - HF README metadata: `colorTo` must be one of `[red, yellow, green, blue, indigo, purple, pink, gray]` (no `emerald`/`amber`).
65
  - HF README metadata: `emoji` must match `/\p{Extended_Pictographic}/u` — only the standard emoji block is allowed. Use a real emoji.
66
 
67
+ ### Inference Architecture (v0.7+)
68
 
69
  - **All LLM inference** via the **Hugging Face Inference API** (serverless). No local GGUF, no `llama-cpp-python` compile step.
70
+ - Shared module: `shared/inference_client.py` provides `cooldown_status()`, `cooldown_active()`, `generate()`, `chat_messages()`, and `force_clear_cooldown()`.
71
+ - **TinyBard model:** `meta-llama/Llama-3.2-1B-Instruct` via `featherless-ai` provider (only provider supporting this model).
72
+ - **Other projects:** `Qwen/Qwen2.5-1.5B-Instruct` (free tier, fast, well-suited to chat). Override via `INFERENCE_MODEL`.
73
  - Per-project model override: `TINYBARD_MODEL`, `FOCUSFRIEND_MODEL`, `CRITTERCALM_MODEL`.
74
+ - **Provider override:** `INFERENCE_PROVIDER` (default: `featherless-ai` for TinyBard, auto for others).
75
  - **Cooldowns** enforce a per-project minimum gap between inference calls (protects HF/Modal credit budget):
76
  - `tinybard`: 6s
77
  - `focusfriend`: 10s
78
  - `crittercalm`: 12s
79
  - Override via `TINYBARD_COOLDOWN_SECONDS`, etc., or global `INFERENCE_COOLDOWN_SECONDS`.
80
+ - **force_clear_cooldown()**: Clears cooldown before each function call — prevents cooldown from blocking story generation after choices.
81
  - **Always-fallback:** every LLM call falls back to procedural / template output if inference fails or is in cooldown. No LLM call ever blocks the UX.
82
  - HF Spaces are the dev/test environment — iterate live at `huggingface.co/spaces/nbiish/{tinybard,focusfriend,crittercalm}` rather than localhost.
83
 
 
96
 
97
  ### Short-term Goals
98
 
99
+ - Record demo videos (2-3 min each) — show unique story generation, verb-based choices, context-aware narrative
100
+ - Post to social media
101
+ - Write Field Notes blog posts (3 one per project)
 
102
  - Share agent traces for Sharing is Caring badge
103
  - Polish UIs for demo appeal
104
+ - Test CritterCalm voice cloning end-to-end
105
+ - Test FocusFriend all 4 modes (Chat, Focus, Breathe, Meditate) with real model
106
 
107
  ## Verification
108
 
 
111
  - Cedar-copper aesthetic consistent across all UIs
112
  - No hardcoded secrets; no cloud API calls in production path
113
 
114
+ ### 1. CritterCalm (Backyard AI)
115
+
116
+ - **Status:** Code complete. Deployed. HF Inference API + cooldowns wired for script generation. OmniVoice voice cloning still requires local install.
117
+ - **Stack:** OmniVoice (0.6B, local optional) + Kokoro TTS (82M, local optional) + Qwen2.5-7B (default) via HF Inference API
118
+ - **Badges:** Off the Grid, Well-Tuned (TBD), Field Notes, Off-Brand
119
+ - **GitHub:** github.com/nbiish/crittercalm
120
+ - **HF Space:** huggingface.co/spaces/nbiish/crittercalm
121
+ - **Standalone repo:** /Volumes/1tb-sandisk/code-external/crittercalm-repo
122
+
123
+ ### 2. FocusFriend (Thousand Token Wood)
124
+
125
+ - **Status:** Code complete. Deployed. HF Inference API + cooldowns wired. Gradio 6 Chatbot dict-format fixed.
126
+ - **Stack:** Qwen2.5-7B (default) via HF Inference API
127
+ - **Badges:** Off-Brand (sun-amber custom theme), Field Notes, Cooldowns badge
128
+ - **GitHub:** github.com/nbiish/focusfriend
129
+ - **HF Space:** huggingface.co/spaces/nbiish/focusfriend
130
+ - **Standalone repo:** /Volumes/1tb-sandisk/code-external/focusfriend-repo
131
+
132
+ ### 3. TinyBard (Thousand Token Wood + Tiny Titan + Llama Champion)
133
+
134
+ - **Status:** COMPLETE. Deployed. Context-aware LLM generation verified live.
135
+ - **Concept:** ≤4B LLM generates unique interactive text adventures in a CRT terminal aesthetic. Nanaboozhoo trickster narrator.
136
+ - **Stack:** Llama-3.2-1B-Instruct via HF Inference API (featherless-ai provider) + procedural fallback engine
137
+ - **Features Implemented:**
138
+ - **Context-aware story generation**: Last 3 story steps feed into next generation for narrative continuity
139
+ - **Verb-based action choices**: Always 3 action-oriented choices (not descriptive noun phrases)
140
+ - **LLM-rated health decisions**: LLM evaluates risk (-15/0/+10), falls back to random.choice
141
+ - **Player choice integration**: Selected choice text feeds into next story + health evaluation
142
+ - **Robust choice parsing**: 3 strategies (pipe, newline, comma) + bare-line format + fallback padding
143
+ - **Always returns 3 choices**: `_parse_choices` pads with procedural fallbacks if LLM returns <3
144
+ - **Unique every time**: Temperature 0.6, max_new_tokens 150 — never repeats
145
+ - **Nanaboozhoo narrator**: Trickster/transformer voice in all LLM prompts
146
+ - **Game loop verified**: Start → LLM story → select choice → Make Choice → LLM advances story → 3 new choices
147
+ - **HF Space:** https://nbiish-tinybard.hf.space (RUNNING, SHA: 94d7081)
148
+ - **Provider:** featherless-ai (only provider supporting Llama-3.2-1B-Instruct)
149
+ - **Environment Variables:** INFERENCE_MODEL=meta-llama/Llama-3.2-1B-Instruct, INFERENCE_PROVIDER=featherless-ai
150
+
151
  ## TODO
152
 
153
  ### In Progress
 
172
  - [x] HF CLI installed + skills configured
173
  - [x] llama-cpp-python installed — for reference; v0.5+ uses HF Inference API
174
  - [x] Local verification: all 3 apps run on ports 7861/7862/7863
175
+ - [x] TinyBard end-to-end game loop verified (start → choose → next scene)
176
+ - [x] FocusFriend chat verified (user message → Pip reply)
177
+ - [x] CritterCalm UI navigation verified (all 3 tabs render)
178
+ - [x] **v0.5: HF Inference API wired into all 3 apps** (no local GGUF, no build step)
179
+ - [x] **v0.5: Cooldown system** in `shared/inference_client.py` to protect HF/Modal credit budget
180
+ - [x] **v0.5: TinyBard local test** — procedural fallback works when no HF_TOKEN; cooldown UI shows in footer
181
+ - [x] **v0.6: TinyBard context-aware generation** — last 3 story steps feed into next generation
182
+ - [x] **v0.6: Verb-based action choices** — always 3 action-oriented choices (not descriptive noun phrases)
183
+ - [x] **v0.6: LLM-rated health decisions** — LLM evaluates risk (-15/0/+10)
184
+ - [x] **v0.6: Player choice integration** — selected choice text feeds into next story + health evaluation
185
+ - [x] **v0.6: Robust choice parsing** — 3 strategies (pipe, newline, comma) + bare-line format + fallback padding
186
+ - [x] **v0.6: Nanaboozhoo narrator** — trickster/transformer voice in all LLM prompts
187
+ - [x] **v0.6: featherless-ai provider** — only provider supporting Llama-3.2-1B-Instruct
188
+ - [x] **v0.7: Game loop verified live** — Start → LLM story → select choice → Make Choice → LLM advances story → 3 new choices
189
+ - [x] **v0.7: Git workflow** — worktree isolation, develop→main merge, HF Space deployment
190
+ - [x] **v0.7: Stale worktrees/branches cleaned up** — all merged branches deleted
191
+
192
+ ## Anishinaabe Solarpunk Aesthetic
193
+
194
+ All three apps share a unified visual language rooted in Anishinaabe culture.
195
+
196
+ ### Visual Identity
197
+
198
+ - **Palette:** sky-to-sunrise — water-blue (`#1B4965`) → cedar-bark (`#3D2A2A`) → copper (`#8B3A1F`) → sun-amber (`#F2A93B`) → birch-cream (`#F5F1E8`)
199
+ - **Syllabics:** Canadian Aboriginal ᐴ / ᔔ used as section framings
200
+ - **Symbols:** sun · clover · florette · circuit diamonds
201
+ - **Typography:** EB Garamond serif headers + Inter sans + JetBrains Mono for terminal/UI
202
+ - **CRT Terminal:** Scanline effects, phosphor glow, monospace terminal for TinyBard
203
+
204
+ ### Cultural Elements
205
+
206
+ - **Nanaboozhoo narrator**: Trickster/transformer voice in all TinyBard LLM prompts
207
+ - **Anishinaabemowin labels**: NOOSISKAAZOWIN (Health), DIBIK (Step), AADIZOOKAAN (Story), INAABANDA'IWIN (Choose)
208
+ - **Biophilic motifs**: Cedar bark textures, birch cream backgrounds, water-blue accents
209
+ - **Solarpunk optimism**: Technology in harmony with nature, not against it
210
+
211
+ ### Implementation
212
+
213
+ - **Tokens module:** `shared/cedar_copper_tokens.py` — CSS variables, color palette, typography
214
+ - **TinyBard CRT:** Custom CSS with scanline animation, phosphor glow, terminal green accents
215
+ - **Shared across apps**: Consistent section framings, button styles, card layouts
216
+
217
+ ## Reference
218
+
219
+ - CritterCalm: projects/crittercalm/ + github.com/nbiish/crittercalm
220
+ - FocusFriend: projects/focusfriend/ + github.com/nbiish/focusfriend
221
+ - TinyBard: projects/tinybard/ + github.com/nbiish/tinybard
222
+ - Aesthetic module: shared/cedar_copper_tokens.py
223
+ - Inference client: shared/inference_client.py
224
+ - ML Intern: github.com/huggingface/ml-intern
225
+ - HF Agents CLI: huggingface.co/docs/hub/en/agents-cli
226
+ - Gradio MCP: gradio.app/guides/model-context-protocol
227
+ - TinyBard HF Space: https://nbiish-tinybard.hf.space
228
+ - TinyBard App: projects/tinybard/app.py (FastAPI + Gradio + game logic)
229
+ - TinyBard Key Functions: `_run_turn`, `_llm_health_delta`, `generate_llm_story`, `generate_llm_choices`, `_parse_messages`, `_parse_choices`, `_fallback_choices`
230
+ - TinyBard Provider: featherless-ai (only provider supporting Llama-3.2-1B-Instruct)
231
+ - TinyBard Working URL: https://router.huggingface.co/featherless-ai/v1/chat/completions
232
 
233
  ## Child DOX Index
234