Create README.md

README.md

@@ -0,0 +1,39 @@
+# GGUF Header Edit Benchmark
+
+Benchmark script for measuring how long it takes to **edit GGUF headers in-place** on Hugging Face with streaming blobs (xet) and create a **pull request** per file.  
+It fetches metadata, rebuilds the header with a small change, commits an edit (header slice only), and records timings to a CSV.
+
+> **Rule of thumb (linear fit):**  
+> time_minutes ≈ `0.36 × size_GB + 0.25`
+
+---
+
+## ✨ What this does
+
+For each `*.gguf` file in a model repo:
+
+1. **Discover files** via the Hugging Face model tree API.
+2. **Fetch GGUF + typed metadata** with `@huggingface/gguf`.
+3. **Rebuild the header** using `buildGgufHeader` (preserving endianness, alignment, and tensor info range).
+4. **Commit a slice edit** (header bytes only) using `commitIter` with `useXet: true` to avoid full re-uploads.
+5. **Create a PR** titled `benchmark`.
+6. **Record timing** (wall-clock) to `benchmark-results.csv`.
+
+---
+
+## 🧱 Requirements
+
+- Node 18+
+- A Hugging Face token with **read + write** on the target repo: `HF_TOKEN`
+- NPM packages:
+  - `@huggingface/gguf`
+  - `@huggingface/hub`
+- Network access to `huggingface.co`
+
+---
+
+## 🔧 Setup
+
+```bash
+pnpm add @huggingface/gguf @huggingface/hub
+# or: npm i @huggingface/gguf @huggingface/hub