Improve model card for MELP: add paper link, description, and pipeline tag
Browse filesThis PR improves the model card for the MELP model by:
- Adding the `pipeline_tag: audio-text-to-text` to the metadata, ensuring the model can be found at https://huggingface.co/models?pipeline_tag=audio-text-to-text.
- Populating the model description and direct use cases with information from the paper abstract.
- Adding a direct link to the paper at https://huggingface.co/papers/2506.21803.
- Adding the `license: apache-2.0` to the metadata.
- Including a basic `transformers` usage example.
- Adding the BibTeX and APA citations for the paper.
Please review and merge.
README.md
CHANGED
|
@@ -1,37 +1,39 @@
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
tags: []
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
-
# Model Card for
|
| 7 |
|
| 8 |
<!-- Provide a quick summary of what the model is/does. -->
|
| 9 |
-
|
| 10 |
-
|
| 11 |
|
| 12 |
## Model Details
|
| 13 |
|
| 14 |
### Model Description
|
| 15 |
|
| 16 |
<!-- Provide a longer summary of what this model is. -->
|
|
|
|
| 17 |
|
| 18 |
-
|
| 19 |
|
| 20 |
-
-
|
| 21 |
-
-
|
| 22 |
-
-
|
| 23 |
-
-
|
| 24 |
-
-
|
| 25 |
-
-
|
| 26 |
-
-
|
| 27 |
|
| 28 |
### Model Sources [optional]
|
| 29 |
|
| 30 |
<!-- Provide the basic links for the model. -->
|
| 31 |
|
| 32 |
-
-
|
| 33 |
-
-
|
| 34 |
-
-
|
| 35 |
|
| 36 |
## Uses
|
| 37 |
|
|
@@ -40,14 +42,12 @@ This is the model card of a 🤗 transformers model that has been pushed on the
|
|
| 40 |
### Direct Use
|
| 41 |
|
| 42 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 43 |
-
|
| 44 |
-
[More Information Needed]
|
| 45 |
|
| 46 |
### Downstream Use [optional]
|
| 47 |
|
| 48 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 49 |
-
|
| 50 |
-
[More Information Needed]
|
| 51 |
|
| 52 |
### Out-of-Scope Use
|
| 53 |
|
|
@@ -71,7 +71,22 @@ Users (both direct and downstream) should be made aware of the risks, biases and
|
|
| 71 |
|
| 72 |
Use the code below to get started with the model.
|
| 73 |
|
| 74 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 75 |
|
| 76 |
## Training Details
|
| 77 |
|
|
@@ -92,7 +107,7 @@ Use the code below to get started with the model.
|
|
| 92 |
|
| 93 |
#### Training Hyperparameters
|
| 94 |
|
| 95 |
-
-
|
| 96 |
|
| 97 |
#### Speeds, Sizes, Times [optional]
|
| 98 |
|
|
@@ -144,11 +159,11 @@ Use the code below to get started with the model.
|
|
| 144 |
|
| 145 |
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
| 146 |
|
| 147 |
-
-
|
| 148 |
-
-
|
| 149 |
-
-
|
| 150 |
-
-
|
| 151 |
-
-
|
| 152 |
|
| 153 |
## Technical Specifications [optional]
|
| 154 |
|
|
@@ -174,11 +189,18 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
| 174 |
|
| 175 |
**BibTeX:**
|
| 176 |
|
| 177 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 178 |
|
| 179 |
**APA:**
|
| 180 |
|
| 181 |
-
|
| 182 |
|
| 183 |
## Glossary [optional]
|
| 184 |
|
|
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
tags: []
|
| 4 |
+
license: apache-2.0
|
| 5 |
+
pipeline_tag: audio-text-to-text
|
| 6 |
---
|
| 7 |
|
| 8 |
+
# Model Card for MELP
|
| 9 |
|
| 10 |
<!-- Provide a quick summary of what the model is/does. -->
|
| 11 |
+
MELP (Multi-scale ECG-Language Pretraining) is a novel model presented in the paper "From Token to Rhythm: A Multi-Scale Approach for ECG-Language Pretraining". It aims to overcome limitations in traditional ECG analysis by leveraging hierarchical supervision from ECG-text pairs to align ECG signals with textual reports.
|
|
|
|
| 12 |
|
| 13 |
## Model Details
|
| 14 |
|
| 15 |
### Model Description
|
| 16 |
|
| 17 |
<!-- Provide a longer summary of what this model is. -->
|
| 18 |
+
Electrocardiograms (ECGs) play a vital role in monitoring cardiac health and diagnosing heart diseases. However, traditional deep learning approaches for ECG analysis rely heavily on large-scale manual annotations, which are both time-consuming and resource-intensive to obtain. To overcome this limitation, self-supervised learning (SSL) has emerged as a promising alternative, enabling the extraction of robust ECG representations that can be efficiently transferred to various downstream tasks.
|
| 19 |
|
| 20 |
+
MELP introduces a novel Multi-scale ECG-Language Pretraining (MELP) model that fully leverages hierarchical supervision from ECG-text pairs. MELP first pretrains a cardiology-specific language model to enhance its understanding of clinical text. It then applies three levels of cross-modal supervision—at the token, beat, and rhythm levels—to align ECG signals with textual reports, capturing structured information across different time scales. Experimental results demonstrate that MELP outperforms existing SSL methods, underscoring its effectiveness and adaptability across diverse clinical applications.
|
| 21 |
|
| 22 |
+
- **Developed by:** The authors of the paper.
|
| 23 |
+
- **Funded by [optional]:** [More Information Needed]
|
| 24 |
+
- **Shared by [optional]:** [More Information Needed]
|
| 25 |
+
- **Model type:** Multimodal ECG-Language Pretraining Model
|
| 26 |
+
- **Language(s) (NLP):** English (clinical text)
|
| 27 |
+
- **License:** Apache-2.0
|
| 28 |
+
- **Finetuned from model [optional]:** [More Information Needed]
|
| 29 |
|
| 30 |
### Model Sources [optional]
|
| 31 |
|
| 32 |
<!-- Provide the basic links for the model. -->
|
| 33 |
|
| 34 |
+
- **Repository:** The code is available as mentioned in the paper's abstract. Please refer to the paper for the exact URL.
|
| 35 |
+
- **Paper [optional]:** [From Token to Rhythm: A Multi-Scale Approach for ECG-Language Pretraining](https://huggingface.co/papers/2506.21803)
|
| 36 |
+
- **Demo [optional]:** [More Information Needed]
|
| 37 |
|
| 38 |
## Uses
|
| 39 |
|
|
|
|
| 42 |
### Direct Use
|
| 43 |
|
| 44 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 45 |
+
MELP can be directly used for self-supervised learning of robust ECG representations. These representations can be efficiently transferred to various downstream tasks, such as zero-shot ECG classification, linear probing, and other transfer learning applications on ECG data.
|
|
|
|
| 46 |
|
| 47 |
### Downstream Use [optional]
|
| 48 |
|
| 49 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 50 |
+
The model can be fine-tuned for diverse clinical applications, including but not limited to tasks that require aligning ECG signals with textual reports, thereby assisting in cardiac health monitoring and heart disease diagnosis.
|
|
|
|
| 51 |
|
| 52 |
### Out-of-Scope Use
|
| 53 |
|
|
|
|
| 71 |
|
| 72 |
Use the code below to get started with the model.
|
| 73 |
|
| 74 |
+
```python
|
| 75 |
+
from transformers import AutoConfig, AutoModel
|
| 76 |
+
|
| 77 |
+
# This is a placeholder for the actual model ID on the Hugging Face Hub.
|
| 78 |
+
# Replace "your_model_id" with the correct model identifier.
|
| 79 |
+
model_id = "your_model_id" # e.g., "org/melp-model"
|
| 80 |
+
|
| 81 |
+
# Load configuration
|
| 82 |
+
config = AutoConfig.from_pretrained(model_id)
|
| 83 |
+
|
| 84 |
+
# Load model
|
| 85 |
+
model = AutoModel.from_pretrained(model_id, config=config)
|
| 86 |
+
|
| 87 |
+
# For detailed usage instructions and examples, please refer to the paper's
|
| 88 |
+
# official code repository mentioned in the abstract.
|
| 89 |
+
```
|
| 90 |
|
| 91 |
## Training Details
|
| 92 |
|
|
|
|
| 107 |
|
| 108 |
#### Training Hyperparameters
|
| 109 |
|
| 110 |
+
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 111 |
|
| 112 |
#### Speeds, Sizes, Times [optional]
|
| 113 |
|
|
|
|
| 159 |
|
| 160 |
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
| 161 |
|
| 162 |
+
- **Hardware Type:** [More Information Needed]
|
| 163 |
+
- **Hours used:** [More Information Needed]
|
| 164 |
+
- **Cloud Provider:** [More Information Needed]
|
| 165 |
+
- **Compute Region:** [More Information Needed]
|
| 166 |
+
- **Carbon Emitted:** [More Information Needed]
|
| 167 |
|
| 168 |
## Technical Specifications [optional]
|
| 169 |
|
|
|
|
| 189 |
|
| 190 |
**BibTeX:**
|
| 191 |
|
| 192 |
+
```bibtex
|
| 193 |
+
@article{zhou2025token,
|
| 194 |
+
title={From Token to Rhythm: A Multi-Scale Approach for ECG-Language Pretraining},
|
| 195 |
+
author={Zhou, Zijian and Liu, Shikun and Han, Xiao and Liu, Haozhe and Ng, Kam Woh and Xie, Tian and Cong, Yuren and Li, Hang and Xu, Mengmeng and P{\'e}rez-R{\'u}a, Juan-Manuel and Patel, Aditya and Xiang, Tao and Shi, Miaojing and He, Sen},
|
| 196 |
+
journal={arXiv preprint arXiv:2506.21803},
|
| 197 |
+
year={2025}
|
| 198 |
+
}
|
| 199 |
+
```
|
| 200 |
|
| 201 |
**APA:**
|
| 202 |
|
| 203 |
+
Zhou, Z., Liu, S., Han, X., Liu, H., Ng, K. W., Xie, T., Cong, Y., Li, H., Xu, M., Pérez-Rúa, J.-M., Patel, A., Xiang, T., Shi, M., & He, S. (2025). *From Token to Rhythm: A Multi-Scale Approach for ECG-Language Pretraining*. arXiv preprint arXiv:2506.21803.
|
| 204 |
|
| 205 |
## Glossary [optional]
|
| 206 |
|