Update README.md

README.md

@@ -61,129 +61,66 @@ configs:
     path: data/JsonSchemaStore-*
   - split: Glaiveai2K
     path: data/Glaiveai2K-*
+pretty_name: J
 ---
 
-# JSON Schema Witness Generation Dataset
+# JSONSchemaBench
 
-## Overview
+[![Paper](https://img.shields.io/badge/Paper-arXiv-blue)](https://arxiv.org/abs/2501.10868)  
 
-This dataset is a collection of JSON schema witnesses generated from various sources, aimed at facilitating the study and evaluation of JSON schema transformations, validations, and other related operations. The dataset consists of several subsets, each derived from a different domain or source, and is structured to allow for comprehensive testing and benchmarking of tools and algorithms dealing with JSON schemas.
+JSONSchemaBench is a benchmark of **real-world JSON schemas** designed to evaluate **structured output generation** for Large Language Models (LLMs). It contains approximately **10,000 JSON schemas**, capturing diverse constraints and complexities.
 
-## Dataset Structure
+## 📌 Dataset Overview
+- **Purpose:** Evaluate the **efficiency** and **coverage** of structured output generation.
+- **Sources:** GitHub, Kubernetes, API specifications, curated collections.
+- **Schemas:** Categorized based on complexity and domain.
 
-The dataset is organized into the following subsets:
+### 📊 Dataset Breakdown
+| Dataset         | Category            | Count |
+| --------------- | ------------------- | ----- |
+| GlaiveAI-2K     | Function Call       | 1707  |
+| Github-Trivial  | Misc                | 444   |
+| Github-Easy     | Misc                | 1943  |
+| Snowplow        | Operational API     | 403   |
+| Github-Medium   | Misc                | 1976  |
+| Kubernetes      | Kubernetes API      | 1064  |
+| Washington Post | Resource Access API | 125   |
+| Github-Hard     | Misc                | 1240  |
+| JSONSchemaStore | Misc                | 492   |
+| Github-Ultra    | Misc                | 164   |
+| **Total**       |                     | 9558  |
 
-### 1. Washington Post (wp)
-- **Samples**: 125
-- **Description**: This subset contains JSON schema witnesses from the Washington Post dataset. The schemas have been processed and formatted for easy integration and analysis.
-- **Original Directory**: [Washington Post](https://github.com/sdbs-uni-p/JSONSchemaWitnessGeneration/tree/main/artifacts/JSONAlgebra/JsonSchema_To_Algebra/expDataset/wp)
+## 📥 Loading the Dataset
 
-### 2. Snowplow (dg)
-- **Samples**: 420
-- **Description**: The Snowplow subset includes 420 JSON schema witnesses, each representing a structured data format used within the Snowplow event data pipeline.
-- **Original Directory**: [Snowplow](https://github.com/sdbs-uni-p/JSONSchemaWitnessGeneration/tree/main/artifacts/JSONAlgebra/JsonSchema_To_Algebra/expDataset/snowplow/dg)
+```python
+from datasets import load_dataset
 
-### 3. Kubernetes (sat)
-- **Samples**: 1087
-- **Description**: This subset contains JSON schema witnesses from the Kubernetes ecosystem. It is particularly useful for analyzing configuration and deployment schemas.
-- **Original Directory**: [Kubernetes](https://github.com/sdbs-uni-p/JSONSchemaWitnessGeneration/tree/main/artifacts/JSONAlgebra/JsonSchema_To_Algebra/expDataset/kubernetes/sat)
+dataset = load_dataset("epfl-dlab/JSONSchemaBench")
+print(dataset)
+```
 
-### 4. Github (sat)
-- **Samples**: 6335
-- **Description**: The largest subset in the dataset, containing 6335 samples from GitHub repositories. These schemas are ideal for studying open-source project configurations and automation.
-- **Original Directory**: [Github](https://github.com/sdbs-uni-p/JSONSchemaWitnessGeneration/tree/main/artifacts/JSONAlgebra/JsonSchema_To_Algebra/expDataset/github/sat)
+## 🔍 Data Structure
+Each dataset split contains:
+- `"json_schema"`: The schema definition.
+- `"unique_id"`: A unique identifier for the schema.
 
-### 5. Handwritten (sat)
-- **Samples**: 197
-- **Description**: The Handwritten subset consists of 197 manually crafted JSON schema witnesses, designed to test edge cases and complex schema configurations.
-- **Original Directory**: [Handwritten](https://github.com/sdbs-uni-p/JSONSchemaWitnessGeneration/tree/main/artifacts/JSONAlgebra/JsonSchema_To_Algebra/expDataset/handwritten/sat)
 
-### 6. Synthesized (sat)
-- **Samples**: 450
-- **Description**: This subset is synthesized from various sources to cover a broad range of JSON schema use cases, particularly focusing on containment and validation.
-- **Original Directory**: [Synthesized](https://github.com/sdbs-uni-p/JSONSchemaWitnessGeneration/tree/main/artifacts/JSONAlgebra/JsonSchema_To_Algebra/expDataset/containment/sat)
+🚀 **For more details, check out the [paper](https://arxiv.org/abs/2501.10868).**
 
-### 7. Github Trivial
-- **Samples**: 570
-- **Description**: Contains GitHub JSON schemas categorized as "trivial" with sizes less than 10. This split is designed to handle extremely simple and minimal schemas.
+## 📚 Citation
+If you use this dataset, please cite:
+```bibtex
+@misc{geng2025jsonschemabench,
+      title={Generating Structured Outputs from Language Models: Benchmark and Studies},
+      author={Saibo Geng et al.},
+      year={2025},
+      eprint={2501.10868},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2501.10868}
+}
+```
 
-### 8. Github Easy
-- **Samples**: 2035
-- **Description**: Contains GitHub JSON schemas categorized as "easy," with sizes between 10 and 30. These schemas offer moderate complexity and are useful for testing general tools.
-
-### 9. Github Medium
-- **Samples**: 2121
-- **Description**: Contains GitHub JSON schemas categorized as "medium," with sizes between 30 and 100. These schemas reflect intermediate complexity.
-
-### 10. Github Hard
-- **Samples**: 1405
-- **Description**: Contains GitHub JSON schemas categorized as "hard," with sizes between 100 and 500. These are complex schemas that are challenging to process and validate.
-
-### 11. Github Ultra
-- **Samples**: 204
-- **Description**: Contains GitHub JSON schemas categorized as "ultra," with sizes greater than 500. These schemas represent the most complex and large-scale structures, ideal for stress testing tools.
-
-### 12. JSON Schema Store (JsonSchemaStore)
-- **Samples**: 650
-- **Description**: This new subset includes 650 JSON schemas derived from the JSON Schema Store, comprising both training and validation data. The schemas cover a wide range of use cases and domains, making them a valuable addition to the dataset for evaluating JSON schema-related tasks such as validation, transformation, and optimization.
-- **Original Source**: [dataunitylab/json-schema-store](https://huggingface.co/datasets/dataunitylab/json-schema-store)
-
-
-## Dataset Validation and Filtering
-
-To ensure the quality and validity of the JSON schemas in each split, a filtering process was applied to remove invalid schemas. The following statistics summarize the filtering results for each subset:
-
-- **Washington Post**: 
-  - Dropped: 0/125 invalid schemas
-  - Kept: 125/125 valid schemas
-
-- **Snowplow**: 
-  - Dropped: 6/420 invalid schemas
-  - Kept: 414/420 valid schemas
-
-- **Kubernetes**: 
-  - Dropped: 0/1087 invalid schemas
-  - Kept: 1087/1087 valid schemas
-
-- **Github**: 
-  - Dropped: 380/6335 invalid schemas
-  - Kept: 5955/6335 valid schemas
-
-- **Handwritten**: 
-  - Dropped: 50/197 invalid schemas
-  - Kept: 147/197 valid schemas
-
-- **Synthesized**: 
-  - Dropped: 35/450 invalid schemas
-  - Kept: 415/450 valid schemas
-
-- **Github Trivial**: 
-  - Dropped: 37/570 invalid schemas
-  - Kept: 533/570 valid schemas
-
-- **Github Easy**: 
-  - Dropped: 59/2035 invalid schemas
-  - Kept: 1976/2035 valid schemas
-
-- **Github Medium**: 
-  - Dropped: 112/2121 invalid schemas
-  - Kept: 2009/2121 valid schemas
-
-- **Github Hard**: 
-  - Dropped: 139/1405 invalid schemas
-  - Kept: 1266/1405 valid schemas
-
-- **Github Ultra**: 
-  - Dropped: 33/204 invalid schemas
-  - Kept: 171/204 valid schemas
-
-- **JSON Schema Store (JsonSchemaStore)**: 
-  - Dropped: 59/650 invalid schemas
-  - Kept: 591/650 valid schemas
-
-## Citation
-
-The datasets listed above are featured in the paper "Witness Generation for JSON Schema." We extend our gratitude to the authors for their valuable contributions. For more detailed information about the datasets and the methods used, please refer to the paper: [Witness Generation for JSON Schema](https://arxiv.org/abs/2202.12849).
 
 ## License
 
@@ -191,4 +128,4 @@ This dataset is provided under the [MIT License](https://opensource.org/licenses
 
 ## Acknowledgements
 
-We would like to thank the contributors and maintainers of the JSON schema projects and the open-source community for their invaluable work and support.
+We would like to thank the contributors and maintainers of the JSON schema projects and the open-source community for their invaluable work and support.