Update README.md

README.md

@@ -1,3 +1,99 @@
----
-license: mit
----
+# 🌌 SpecCLIP: Cross-Survey Spectral Foundation Model
+
+[![arXiv](https://img.shields.io/badge/arXiv-2507.01939-b31b1b.svg)](https://arxiv.org/abs/2507.01939)
+[![GitHub](https://img.shields.io/badge/GitHub-Repo-black)](https://github.com/Xiaosheng-Zhao/SpecCLIP)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**SpecCLIP** is a contrastive + domain-preserving foundation model designed to align **LAMOST LRS** spectra with **Gaia XP** spectrophotometric data.
+It learns a **general-purpose spectral embedding (768-dim)** that supports:
+
+* **Stellar parameter estimation**
+* **Cross-survey spectral translation** (LAMOST ⟷ Gaia XP)
+* **Similarity retrieval** across 10M+ LRS and 220M+ XP spectra
+
+For full documentation, installation instructions, examples, and end-to-end usage, please visit the **GitHub repository**:
+👉 [https://github.com/Xiaosheng-Zhao/SpecCLIP](https://github.com/Xiaosheng-Zhao/SpecCLIPe)
+
+---
+
+## 🔧 Available Models (Weights Only)
+
+The following pretrained weights are included in this model repository:
+
+| File                                         | Description                           | Embedding Dim |
+| -------------------------------------------- | ------------------------------------- | ------------- |
+| `encoders/lrs_encoder.ckpt`                  | LAMOST LRS masked transformer encoder | 768           |
+| `encoders/xp_encoder.ckpt`                   | Gaia XP masked transformer encoder    | 768           |
+| `encoders/xp_encoder_mlp.ckpt`               | Gaia XP autoencoder (MLP head)        | 768           |
+| `specclip/specclip_model_predrecon_mlp.ckpt` | CLIP alignment + pred+recon           | 768           |
+| `specclip/specclip_model_split_mlp.ckpt`     | CLIP alignment + split pred/recon     | 768           |
+
+---
+
+## 📥 Load a Model Weight
+
+```python
+from huggingface_hub import hf_hub_download
+
+path = hf_hub_download(
+    repo_id="astroshawn/SpecCLIP",
+    filename="encoders/xp_encoder.ckpt"
+)
+
+print("Downloaded to:", path)
+```
+
+---
+
+## 🧠 What the Model Does
+
+SpecCLIP consists of:
+
+* **Two masked transformer encoders**
+  – LAMOST LRS
+  – Gaia XP
+* **Contrastive alignment loss (CLIP-style)**
+* **Domain-preserving prediction & reconstruction heads**
+* **Cross-modal decoder** for spectrum translation
+
+It produces **shared embeddings** enabling multi-survey astrophysical analysis.
+
+---
+
+## 📄 Full Documentation
+
+To keep the Hugging Face card concise, **all detailed instructions**, including:
+
+* Installation
+* Parameter prediction
+* Spectral translation
+* Retrieval
+* Full examples (Python + figures)
+* Acknowledgments
+
+are available at the GitHub repo:
+
+👉 **[https://github.com/Xiaosheng-Zhao/SpecCLIP](https://github.com/Xiaosheng-Zhao/SpecCLIP)**
+
+---
+
+## 📊 Citation
+
+```bibtex
+@article{Zhao2025SpecCLIP,
+  author        = {Xiaosheng Zhao et al.},
+  title         = {SpecCLIP: Aligning and Translating Spectroscopic Measurements for Stars},
+  year          = {2025},
+  eprint        = {2507.01939},
+  archivePrefix = {arXiv},
+  primaryClass  = {astro-ph.IM}
+}
+```
+
+---
+
+## 📬 Contact
+
+* GitHub Issues: [https://github.com/Xiaosheng-Zhao/SpecCLIP/issues](https://github.com/Xiaosheng-Zhao/SpecCLIP/issues)
+* Email: [xzhao113@jh.edu](mailto:xzhao113@jh.edu)
+