Upload README.md with huggingface_hub

README.md

@@ -20,6 +20,7 @@ WriteViT is a one-shot handwritten text synthesis framework that learns a writer
   <a href="https://arxiv.org/abs/2505.13235"><img alt="arXiv" src="https://img.shields.io/badge/arXiv-2505.13235-b31b1b.svg"></a>
   <a href="https://colab.research.google.com/drive/15Lswqr-aQwI-fF6yRoGYt-2pxSlC2L-R"><img alt="Open in Colab" src="https://colab.research.google.com/assets/colab-badge.svg"></a>
   <img alt="License" src="https://img.shields.io/badge/license-MIT-blue.svg">
+  <a href="https://huggingface.co/DAIR-Group/WriteViT"><img alt="Hugging Face downloads" src="https://img.shields.io/huggingface/dt/DAIR-Group/WriteViT?label=downloads"></a>
 </p>
 
 <p align="center">
@@ -97,6 +98,52 @@ Install PyTorch for your CUDA version first, then install the project dependenci
 pip install -r requirements.txt
 ```
 
+## Download Checkpoints and Artifacts
+
+The released checkpoints, prepared data files, lexicons, and font resources are hosted in this Hugging Face repository. Clone the full release with Git LFS:
+
+```bash
+git lfs install
+git clone https://huggingface.co/DAIR-Group/WriteViT
+cd WriteViT
+```
+
+If you want to download the artifacts into another local copy of this codebase, use `huggingface_hub`:
+
+```bash
+pip install -U huggingface_hub
+python - <<'PY'
+from huggingface_hub import snapshot_download
+
+snapshot_download(
+    repo_id="DAIR-Group/WriteViT",
+    repo_type="model",
+    local_dir=".",
+    allow_patterns=[
+        "File/*.pth",
+        "File/*.pickle",
+        "File/*.txt",
+        "config.json",
+        "README.md",
+    ],
+)
+PY
+```
+
+The default IAM setup expects these files under `File/`:
+
+```text
+File/
+├── IAM.pickle
+├── VN.pickle
+├── eng_ckpt.pth
+├── vn_ckpt.pth
+├── vgg19.pth
+├── english_words.txt
+├── vn_words.txt
+└── unifont.pickle
+```
+
 ## Configuration
 
 Experiment settings are defined in `params.py`.
@@ -165,6 +212,25 @@ Prepared dataset pickle files contain writer-split handwriting samples:
 
  
 
+## Download Tracking
+
+Hugging Face shows the `Downloads last month` value in the model metadata panel when downloads of tracked repository files are detected. This repository includes `config.json` so Hugging Face can track downloads for the model page in addition to the downloadable checkpoint files under `File/`.
+
+The badge at the top of this model card shows the cumulative download count reported by Hugging Face:
+
+```text
+https://img.shields.io/huggingface/dt/DAIR-Group/WriteViT?label=downloads
+```
+
+If you publish under a different Hugging Face namespace or repository name, update both the badge link and image URL to use:
+
+```text
+https://huggingface.co/<your-namespace>/<your-repo-name>
+https://img.shields.io/huggingface/dt/<your-namespace>/<your-repo-name>?label=downloads
+```
+
+After pushing `config.json`, the `Downloads are not tracked for this model` message should disappear once Hugging Face refreshes the repository metadata and download events are recorded.
+
 ## Resources
 
 - Paper: https://arxiv.org/abs/2505.13235