Upload README.md

README.md

@@ -1,3 +1,54 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+---
+# M4Heights: Benchmark Dataset for Building Height Estimation
+
+## 📻 overview
+This is the official dataset repository for M4Heights dataset, a multi-modal, multi-resolution, and multi-temporal dataset designed for building height estimation.
+The dataset contains approximately 1 million images comprising time series of Sentinel-1 SAR and Sentinel-2 MSI satellite data, high-resolution aerial orthophotos, and high-quality building height reference maps. 
+Additionally, M4Heights provides the largest associated multi-image super-resolution dataset to enhance height estimation accuracy. 
+Our open-source dataset supports a range of modeling approaches, offering extensibility to new geographic regions and advancing the development of DL models for building height estimation.
+<!-- <img src="./assets/data_collection.jpg" alt="Data Collection" style="width:60%;"> -->
+
+<!-- - **Code Repository:** [More Information Needed]
+- **Paper:** [More Information Needed]
+- **Project WebPage:** [More Information Needed] -->
+**Paper** : TO BE UPDATED POST PUBLICATION
+
+## 🚀 usage
+We have tested the dataset on several deep learning models. The code for the models, dataset usage along with the instructions are provided on our Github Repository.
+
+Codebase on Github : https://github.com/RituYadav92/M4Heights
+
+## 🎯 stats and data samples
+<img src="./assets/data_stats.jpg" alt="Data Stats" style="width:80%;">
+<img src="./assets/samples.jpg" alt="Data Stats" style="width:80%;">
+
+## ⬇️ Data Size:
+
+```
+  dataset (zip)    |      size
+  ---------------------------------
+  Train            |   ≈250.0GB
+  Test             |     28.6GB
+  Sample Data      |    300.0MB
+
+  Unzipped dataset size is ≈900GB
+```
+
+## 🎓 Citation:
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+```
+@misc{M4Heights_2024,
+	author       = { {Yadav, R., Nascetti, A. & Ban, Y.} },
+	title        = { M4Heights dataset },
+	year         = 2025,
+	url          = { https://huggingface.co/datasets/ritu/M4Heights },
+	doi          = { https://doi.org/10.57967/hf/3967 },
+	publisher    = { Hugging Face }
+}
+```
+
+### 👋 Contact Info.:
+Ritu Yadav (email: [email protected])
+