MukulRay commited on
Commit
e4ec4e1
Β·
1 Parent(s): f8bccb8

fix: add HF Spaces yaml front-matter

Browse files
Files changed (1) hide show
  1. README.md +20 -24
README.md CHANGED
@@ -1,3 +1,13 @@
 
 
 
 
 
 
 
 
 
 
1
  <div align="center">
2
 
3
  <img src="Images\Banner.png" alt="Irminsul Banner" width="100%">
@@ -334,33 +344,19 @@ Full RAG pipeline evaluation (context recall, answer relevance) is a planned add
334
 
335
  ---
336
 
337
- ## Screenshots
338
-
339
- <!-- PLACEHOLDER: Add screenshots once you have them.
340
- Save to assets/ and uncomment these lines:
341
-
342
- ![Irminsul UI](assets/ui_main.png)
343
- ![Response with sources](assets/ui_response.png)
344
- ![MLflow experiment runs](assets/mlflow_runs.png)
345
-
346
- Tips:
347
- - ui_main.png: screenshot of http://localhost:8000 before any query
348
- - ui_response.png: run a query so the answer + sources section is visible
349
- - mlflow_runs.png: Colab experiment comparison table showing 3 runs + metrics
350
- -->
351
-
352
- *Screenshots coming soon β€” [try the live demo](https://huggingface.co/spaces/MukulRay/Irminsul) to see it in action.*
353
-
354
- ---
355
 
356
  ## What's Next
357
 
358
- - [ ] **RAGAS evaluation** β€” systematic RAG eval (faithfulness, context recall, answer relevance) on a held-out question set
359
- - [ ] **MarkdownHeaderTextSplitter** β€” replace naive word chunker for section-aware chunking that respects document structure
360
- - [ ] **Metadata filtering** β€” filter Pinecone queries by character, content tier, or topic category
361
- - [ ] **Streaming responses** β€” SSE for lower perceived latency on long answers
362
- - [ ] **CI/CD pipeline** β€” GitHub Actions β†’ ACR build β†’ `az containerapp update` on push to main
363
- - [ ] **Corpus expansion** β€” constellation effects, rotation guides, and ER/EM thresholds per character
 
 
 
364
 
365
  ---
366
 
 
1
+ ---
2
+ title: Irminsul
3
+ emoji: 🌿
4
+ colorFrom: green
5
+ colorTo: green
6
+ sdk: docker
7
+ app_port: 7860
8
+ pinned: false
9
+ ---
10
+
11
  <div align="center">
12
 
13
  <img src="Images\Banner.png" alt="Irminsul Banner" width="100%">
 
344
 
345
  ---
346
 
347
+ ## What's Next
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
348
 
349
  ## What's Next
350
 
351
+ - [ ] **End-to-end RAG evaluation** β€” RAGAS pipeline measuring faithfulness, context recall,
352
+ and answer relevance on a held-out Genshin question set; results logged to MLflow
353
+ alongside fine-tuning metrics for a single unified eval story
354
+ - [ ] **Smarter chunking** β€” swap word-level splitter for `MarkdownHeaderTextSplitter`
355
+ so retrieval respects document structure (character sections stay together,
356
+ stat tables don't get split mid-row)
357
+ - [ ] **Streaming responses** β€” SSE endpoint for lower perceived latency on long answers
358
+ - [ ] **CI/CD on push** β€” GitHub Actions β†’ ACR build β†’ `az containerapp update --image`
359
+ for zero-downtime rolling deploys to Azure on every merge to main
360
 
361
  ---
362