Upload README.md with huggingface_hub

README.md

@@ -34,17 +34,31 @@ tags:
 | **KL divergence** | 0.0506 | 0 *(by definition)* |
 | **Refusals** | 1/100 | 95/100 |
 
------
+## Transformers 5.x Compatibility
+
+This model uses custom modeling code (`trust_remote_code=True`) that requires a one-time patch when using **transformers >= 5.0**. Without the patch, the model fails to load due to a RoPE positional encoding incompatibility.
+
+**After downloading the model, run:**
+
+```bash
+python patch_iquestcoder.py
+```
+
+The script auto-finds and patches all cached `modeling_iquestcoder.py` files. It is safe to run multiple times — if the fix is already applied, it simply skips.
 
+> **What the patch fixes:** The custom `IQuestCoderRotaryEmbedding` references a `"default"` rope type that was removed from the transformers 5.x rope registry, and imports `SlidingWindowCache` which was renamed. The patch adds the missing rope initialization function and updates the cache import.
 
+If you prefer to apply the fix manually, see the [patch script source](./patch_iquestcoder.py) for details.
+
+-----
 
 ![Evaluation Results](./papers/iquest-coder-v1-logo.png)
 
 <p align="center">
-  📘 <a href="https://iquestlab.github.io">Blog</a >
+  📘 <a href="https://iquestlab.github.io">Blog</a>
   &nbsp;•&nbsp;
-  📄 <a href="https://github.com/IQuestLab/IQuest-Coder-V1/blob/main/papers/IQuest_Coder_Technical_Report.pdf">Technical Report</a >
-</p >
+  📄 <a href="https://github.com/IQuestLab/IQuest-Coder-V1/blob/main/papers/IQuest_Coder_Technical_Report.pdf">Technical Report</a>
+</p>
 
 # IQuest-Coder-V1 Model Family
 
@@ -204,4 +218,4 @@ If you find our work helpful, please cite:
   journal={arXiv preprint arXiv:2512.22087},
   year={2025}
 }
-```
+```