Upload README.md with huggingface_hub

README.md

@@ -1,29 +1,62 @@
 ---
-dataset_info:
-  features:
-  - name: Filename
-    dtype: string
-  - name: Svg
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 5591367209
-    num_examples: 2169710
-  - name: val
-    num_bytes: 280378795
-    num_examples: 108456
-  - name: test
-    num_bytes: 14742278
-    num_examples: 5709
-  download_size: 3011558868
-  dataset_size: 5886488282
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: val
-    path: data/val-*
-  - split: test
-    path: data/test-*
+{}
 ---
+
+<a href="" target="_blank">
+    <img alt="arXiv" src="https://img.shields.io/badge/arXiv-StarVector-red?logo=arxiv" height="20" />
+</a>
+<a href="https://starvector.github.io/" target="_blank">
+    <img alt="Website" src="https://img.shields.io/badge/🌎_Website-StarVector-blue.svg" height="20" />
+</a>
+<a href="https://github.com/joanrod/star-vector" target="_blank" style="display: inline-block; margin-right: 10px;">
+    <img alt="GitHub Code" src="https://img.shields.io/badge/Code-StarVector-white?&logo=github&logoColor=white" />
+</a>
+
+# Dataset Card for svg-stack
+
+## Dataset Description
+
+This dataset contains SVG code examples for training and evaluating SVG models for image vectorization.
+
+## Dataset Structure
+
+
+### Features
+
+The dataset contains the following fields:
+
+| Field Name | Description |
+| :--------- | :---------- |
+| `Filename` | Unique ID for each SVG |
+| `Svg` | SVG code |
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("starvector/svg-stack")
+```
+
+## Benchmark Evaluation
+
+To evaluate your model on this dataset, please refer to the [README.md](https://github.com/joanrod/star-vector/blob/main/README.md) file in the [StarVector GitHub repository](https://github.com/joanrod/star-vector).
+
+
+## Citation
+
+```bibtex
+@article{rodriguez2023starvector,
+    title={{StarVector: Generating Scalable Vector Graphics Code from Images and Text}},
+    author={Juan A. Rodriguez and Abhay Puri and Shubham Agarwal and Issam H. Laradji and Pau Rodriguez and Sai Rajeswar and David Vazquez and Christopher Pal and Marco Pedersoli},
+    year={2023},
+    journal={arXiv preprint arXiv:2312.11556},
+}
+```
+
+## Tags
+
+- scalable vector graphics (SVG)
+- vision language models
+- multimodal
+- code