Update README.md

README.md

@@ -1,3 +1,32 @@
----
-license: cc-by-4.0
----
+---
+license: apache-2.0
+tags:
+- vit
+- ecg
+- self-supervised
+- contrastive-learning
+---
+
+# ViT-MAE ECG Encoder
+
+This repository contains a Vision Transformer (ViT-MAE) model pretrained on ECG signals using masked autoencoding. It is a forked and modified version of the Hugging Face `transformers` library.
+
+## Model Files
+
+- `model.safetensors`: Model weights (~77MB) saved in `safetensors` format.
+- `config.json`: Model architecture and configuration.
+
+## Usage
+
+To use this model, make sure to install the forked version of `transformers` (see below), which includes modifications for ECG input handling.
+
+```bash
+git clone git@github.com:Alsalivan/ecgcmr.git
+cd ecgcmr
+pip install -e .
+
+
+from transformers import ViTMAEModel
+
+# Load model from the Hugging Face Hub
+model = ViTMAEModel.from_pretrained("alsalivan/vitmae-ecg")