Update model card metadata and improve description for HeartCodec

README.md

@@ -1,47 +1,56 @@
 ---
-license: cc-by-nc-4.0
 language:
 - zh
 - en
 - ja
 - ko
 - es
-pipeline_tag: text-to-audio
+license: cc-by-nc-4.0
+pipeline_tag: audio-to-audio
 tags:
 - music
 - art
+arxiv: 2601.10547
 ---
 
+# HeartCodec-oss
 
-## Model Details
+HeartCodec-oss is a high-fidelity music codec tokenizer introduced in the paper [HeartMuLa: A Family of Open Sourced Music Foundation Models](https://huggingface.co/papers/2601.10547).
 
-### Model Description
+HeartCodec is a low-frame-rate (12.5 Hz) yet high-fidelity music codec tokenizer that captures long-range musical structure while preserving fine-grained acoustic details and enabling efficient autoregressive modeling. It serves as a core component for the HeartMuLa song generation models.
 
-<!-- Provide a longer summary of what this model is. -->
-
-- **Developed by:** [Ario Scale Global]
-- **License:** [CC-BY-NC 4.0]
+## Model Details
 
-### Model Sources
+- **Developed by:** Ario Scale Global
+- **Model Type:** Music Codec / Tokenizer
+- **License:** [CC-BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)
+- **Paper:** [HeartMuLa: A Family of Open Sourced Music Foundation Models](https://huggingface.co/papers/2601.10547)
+- **Project Page:** [https://heartmula.github.io/](https://heartmula.github.io/)
+- **GitHub Repository:** [https://github.com/HeartMuLa/heartlib](https://github.com/HeartMuLa/heartlib)
 
-<!-- Provide the basic links for the model. -->
+## Authors
+[Dongchao Yang](https://huggingface.co/Dongchao), [Yuxin Xie](https://huggingface.co/bverxie), Yuguo Yin, Zheyu Wang, Xiaoyu Yi, [Gongxi Zhu](https://huggingface.co/Gongxizhu), Xiaolong Weng, Zihan Xiong, Yingzhe Ma, Dading Cong, Jingliang Liu, Zihang Huang, Jinghan Ru, Rongjie Huang, Haoran Wan, Peixu Wang, Kuoxi Yu, Helin Wang, Liming Liang, Xianwei Zhuang, [Yuanyuan Wang](https://huggingface.co/YuanyuanWang), [Haohan Guo](https://huggingface.co/hhguo), Junjie Cao, Zeqian Ju, Songxiang Liu, Yuewen Cao, Heming Weng, Yuexian Zou.
 
-- **Github Repo:** https://github.com/HeartMuLa/heartlib
-- **Paper:** https://arxiv.org/abs/2601.10547
-- **Demo:** https://heartmula.github.io/
-- **HeartMuLa-oss-3B:** https://huggingface.co/HeartMuLa/HeartMuLa-oss-3B
-- **HeartCodec-oss:** https://huggingface.co/HeartMuLa/HeartCodec-oss
-- **HeartTranscriptor-oss:** https://huggingface.co/HeartMuLa/HeartTranscriptor-oss
+## Get Started
 
+Check the GitHub repository [HeartMuLa/heartlib](https://github.com/HeartMuLa/heartlib) for environment setup and local deployment instructions.
 
-## Get Started
+### Installation
+```bash
+git clone https://github.com/HeartMuLa/heartlib.git
+cd heartlib
+pip install -e .
+```
 
-Check our github repo https://github.com/HeartMuLa/heartlib for a quickstart and local deployment of HeartMuLa.
+### Download Checkpoints
+```bash
+# Using huggingface-cli
+hf download --local-dir './ckpt/HeartCodec-oss' 'HeartMuLa/HeartCodec-oss'
+```
 
 ## Citation
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-If you find HeartMuLa useful, please cite:
+If you find HeartMuLa or HeartCodec useful, please cite:
 
 ```bibtex
 @misc{yang2026heartmulafamilyopensourced,
@@ -55,6 +64,5 @@ If you find HeartMuLa useful, please cite:
 }
 ```
 
-
 ## Contact
-If you are interested in HeartMuLa, feel free to reach us at heartmula.ai@gmail.com
+If you are interested in HeartMuLa, feel free to reach us at heartmula.ai@gmail.com