Update README.md

README.md

@@ -22,4 +22,44 @@ configs:
         path: "data/ptmint_all_with_splits.csv"
       - split: ptmint_phospho_interfaces
         path: "data/ptmint_interface_phospho_with_splits.csv"
----
+---
+
+# PTMint
+
+This dataset is derived from **PTMint** (https://ptmint.sjtu.edu.cn/), (Post Translational Modifications that are associated with Protein-Protein Interactions) that contains manually curated complete experimental evidence of the PTM effecting on protein-protein interactions in multiple organisms, including H. sapines, A. thaliana, C. elegans, D. melanogaster, S. cerevisiae and S. pombe.
+This Hugging Face dataset repository provides PTMint-derived tables including a precomputed split column for cluster-aware precomputed splits. Clusters were determined by consensus site identity.
+
+## Dataset Summary
+
+- **Domain:** protein biology / interactomics / PTM regulation
+- **Description:** PTM event mapped to a PPI and its effect on said PPI (Enhance: Increase affinity and Inhibit: Decrease affinity).
+- **Primary uses:**
+  - Benchmarking models that predict PTM-dependent PPI regulation (enhance/inhibit)
+  - PTM sites mapped to structural interfaces
+
+## Citation
+
+When referring to **PTMint**, please cite:
+
+Hong X, Li N, Lv J, Zhang Y, Li J, Zhang J, Chen HF. *PTMint database of experimentally verified PTM regulation on protein-protein interaction.* **Bioinformatics.** 2023;39(1):btac823. doi:10.1093/bioinformatics/btac823. PMID: 36548389.
+
+## Data Files
+
+This repo exposes two splits under a single config (`main`):
+
+1. **ptmint_general**  
+   - Path: `data/ptmint_all_with_splits.csv`  
+   - Contents: PTMint-derived records (all PTM types included and sites both in the PPI interface and outside the interface).
+
+2. **ptmint_phospho_interfaces**  
+   - Path: `data/ptmint_interface_phospho_with_splits.csv`  
+   - Contents: a phosphorylation-focused subset restricted to records where the PTM site is mapped to a protein–protein **interface** (as defined by your preprocessing pipeline in src).
+
+## License
+
+- **This dataset repository:** MIT License for educational purposes only.
+- **Underlying PTMint database/publication:** please cite the PTMint paper when using these data.
+
+## Contact
+
+For Huggingface database: Lina Maria Pena Pardo / linamp (at) umich.edu