pushpam14 commited on
Commit
8d396e9
Β·
verified Β·
1 Parent(s): 7bef84f

Sync README.md (technical architecture doc + cross-links)

Browse files
Files changed (1) hide show
  1. README.md +4 -1
README.md CHANGED
@@ -25,7 +25,9 @@ pinned: false
25
 
26
  An OpenEnv RL environment that trains agents to do what senior platform engineers do when an API breaks in production: **detect the violation, trace which downstream services are affected, propose a backward-compatible fix, and verify the fix doesn't cascade**.
27
 
28
- > πŸ“– **Read this first**: [`ENTERPRISE_CONTRACT_GUARDIAN_STORY.md`](ENTERPRISE_CONTRACT_GUARDIAN_STORY.md) β€” full product narrative + technical guide with diagrams, two real-world incident walkthroughs, complete reward criteria, and the training loop.
 
 
29
 
30
  ## The Story
31
 
@@ -401,6 +403,7 @@ This is a genuinely underexplored domain in RL/LLM training β€” no prior benchma
401
  | Training proof + full logs | [`results/TRAINING_RUN_PROOF.md`](results/TRAINING_RUN_PROOF.md) |
402
  | Training Notebook (Colab) | [`training/grpo_colab.ipynb`](training/grpo_colab.ipynb) |
403
  | Story + Technical Guide | [`ENTERPRISE_CONTRACT_GUARDIAN_STORY.md`](ENTERPRISE_CONTRACT_GUARDIAN_STORY.md) |
 
404
  | GitHub repo | https://github.com/kumarpushpam17-personal/Hackathon |
405
  | HF mini-blog writeup (separate MD in Space) | [`BLOG.md`](BLOG.md) |
406
  | Trained adapter model card | https://huggingface.co/pushpam14/api-contract-validator-grpo-7b |
 
25
 
26
  An OpenEnv RL environment that trains agents to do what senior platform engineers do when an API breaks in production: **detect the violation, trace which downstream services are affected, propose a backward-compatible fix, and verify the fix doesn't cascade**.
27
 
28
+ > πŸ“– **Read these first**:
29
+ > - [`ENTERPRISE_CONTRACT_GUARDIAN_STORY.md`](ENTERPRISE_CONTRACT_GUARDIAN_STORY.md) β€” product narrative + 20-section walkthrough, mermaid diagrams, two worked incident examples
30
+ > - [`TECHNICAL_ARCHITECTURE.md`](TECHNICAL_ARCHITECTURE.md) β€” every tool documented, build flow, runtime sequence diagrams, why-each-decision interview Q&A, reproducibility checklist
31
 
32
  ## The Story
33
 
 
403
  | Training proof + full logs | [`results/TRAINING_RUN_PROOF.md`](results/TRAINING_RUN_PROOF.md) |
404
  | Training Notebook (Colab) | [`training/grpo_colab.ipynb`](training/grpo_colab.ipynb) |
405
  | Story + Technical Guide | [`ENTERPRISE_CONTRACT_GUARDIAN_STORY.md`](ENTERPRISE_CONTRACT_GUARDIAN_STORY.md) |
406
+ | Tech Architecture & Build Flow | [`TECHNICAL_ARCHITECTURE.md`](TECHNICAL_ARCHITECTURE.md) |
407
  | GitHub repo | https://github.com/kumarpushpam17-personal/Hackathon |
408
  | HF mini-blog writeup (separate MD in Space) | [`BLOG.md`](BLOG.md) |
409
  | Trained adapter model card | https://huggingface.co/pushpam14/api-contract-validator-grpo-7b |