Update README.md

README.md

@@ -1,45 +1,119 @@
 ---
-dataset_info:
-  features:
-  - name: subject
-    dtype: string
-  - name: grade
-    dtype: string
-  - name: skill
-    dtype: string
-  - name: pic_choice
-    dtype: bool
-  - name: pic_prob
-    dtype: bool
-  - name: problem
-    dtype: string
-  - name: problem_pic
-    dtype: binary
-  - name: choices
-    sequence: string
-  - name: choices_pic
-    sequence: binary
-  - name: answer_idx
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 28874513377
-    num_examples: 644797
-  - name: valid
-    num_bytes: 9606268196
-    num_examples: 214272
-  - name: test
-    num_bytes: 9539195843
-    num_examples: 214077
-  download_size: 47733024813
-  dataset_size: 48019977416
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: valid
-    path: data/valid-*
-  - split: test
-    path: data/test-*
+license: apache-2.0
+language:
+- en
+pretty_name: STEM
+size_categories:
+- 1M<n<10M
+tags:
+- stem
+- benchmark
 ---
+# STEM Dataset
+This dataset is proposed in the ICLR 2024 paper: [Measuring Vision-Language STEM Skills of Neural Models](https://arxiv.org/abs/2402.17205). The problems in the real world often require solutions, combining knowledge from STEM (science, technology, engineering, and math). Unlike existing datasets, our dataset requires the understanding of multimodal vision-language information of STEM. Our dataset features one of the largest and most comprehensive datasets for the challenge. It includes 448 skills and 1,073,146 questions spanning all STEM subjects. Compared to existing datasets that often focus on examining expert-level ability, our dataset includes fundamental skills and questions designed based on the K-12 curriculum. We also add state-of-the-art foundation models such as CLIP and GPT-3.5-Turbo to our benchmark. Results show that the recent model advances only help master a very limited number of lower grade-level skills (2.5% in the third grade) in our dataset. In fact, these models are still well below (averaging 54.7%) the performance of elementary students, not to mention near expert-level performance. To understand and increase the performance on our dataset, we teach the models on a training split of our dataset. Even though we observe improved performance, the model performance remains relatively low compared to average elementary students. To solve STEM problems, we will need novel algorithmic innovations from the community.
+
+## Authors
+Jianhao Shen*, Ye Yuan*, Srbuhi Mirzoyan, Ming Zhang, Chenguang Wang
+
+## Dataset Sources
+- **Repository:** https://github.com/stemdataset/STEM
+- **Paper:** https://arxiv.org/abs/2402.17205
+- **Leaderboard:** To be released
+
+## Dataset Structure
+
+The dataset is splitted into train, valid and test sets. The choice labels in test set are not released and everyone can submit the test set predictions to the [leaderboard](TBR). The basic statistics of the dataset are as follows:
+
+| Subject     | #Skills | #Questions | Avg. #A    | #Train   | #Valid   | #Test    |
+|-------------|---------|------------|------------|----------|----------|----------|
+| Science     | 82      | 186,740    | 2.8        | 112,120  | 37,343   | 37,277   |
+| Technology  | 9       | 8,566      | 4.0        | 5,140    | 1,713    | 1,713    |
+| Engineering | 6       | 18,981     | 2.5        | 12,055   | 3,440    | 3,486    |
+| Math        | 351     | 858,859    | 2.8        | 515,482  | 171,776  | 171,601  |
+| Total       | 448     | 1,073,146  | 2.8        | 644,797  | 214,272  | 214,077  |
+
+The dataset is in the following format:
+```python
+DatasetDict({
+    train: Dataset({
+        features: ['subject', 'grade', 'skill', 'pic_choice', 'pic_prob', 'problem', 'problem_pic', 'choices', 'choices_pic', 'answer_idx'],
+        num_rows: 644797
+    })
+    valid: Dataset({
+        features: ['subject', 'grade', 'skill', 'pic_choice', 'pic_prob', 'problem', 'problem_pic', 'choices', 'choices_pic', 'answer_idx'],
+        num_rows: 214272
+    })
+    test: Dataset({
+        features: ['subject', 'grade', 'skill', 'pic_choice', 'pic_prob', 'problem', 'problem_pic', 'choices', 'choices_pic', 'answer_idx'],
+        num_rows: 214077
+    })
+})
+```
+And the detailed description of the features are as follows:
+- `subject`: `str`
+  - The subject of the question, one of `science`, `technology`, `engineer`, `math`.
+- `grade`: `str`
+  - The grade of the question.
+- `skill`: `str`
+  - The skill of the question.
+- `pic_choice`: `bool`
+  - Whether the choices are images.
+- `pic_prob`: `bool`
+  - Whether the problem has an image.
+- `problem`: `str`
+  - The problem description.
+- `problem_pic`: `bytes`
+  - The problem image.
+- `choices`: `Optional[List[str]]`
+  - The choices of the question. If `pic_choice` is `True`, the choices are images and will be saved into `choices_pic`, and the `choices` with be set to `None`.
+- `choices_pic`: `Optional[List[bytes]]`
+  - The choices images. If `pic_choice` is `False`, the choices are strings and will be saved into `choices`, and the `choices_pic` with be set to `None`.
+- `answer_idx`: `int`
+  - The index of the correct answer in the `choices` or `choices_pic`. If the split is `test`, the `answer_idx` will be set to `-1`.
+
+The bytes can be read by the following code:
+```python
+from PIL import Image
+def bytes_to_image(img_bytes: bytes) -> Image:
+    img = Image.open(io.BytesIO(img_bytes))
+    return img
+```
+
+## Dataset Example
+### Problem picture example
+***Question***: *What is the domain of this function?*
+
+***Picture***:
+![problem_pic](assets/example_problem_pic.png)
+
+***Choices***: *["{x | x <= -6}", "all real numbers", "{x | x > 3}", "{x | x >= 0}"]*
+
+***Answer***: *1*
+
+### Choices picture example
+***Question***: *The three scatter plots below show the same data set. Choose the scatter plot in which the outlier is highlighted.*
+
+***Choices***:
+<div style="display: flex; justify-content: space-between;">
+  <img src="assets/example_choice_pic_0.png" style="width: 30%" />
+  <img src="assets/example_choice_pic_1.png" style="width: 30%" /> 
+  <img src="assets/example_choice_pic_2.png" style="width: 30%" />
+</div>
+
+***Answer***: *1*
+
+## How to use
+Please refer to our [code](https://github.com/stemdataset/STEM) for the usage of training and evaluation on the dataset.
+
+## Citation
+```bibtex
+@article{shen2024measuring,
+  title={Measuring Vision-Language STEM Skills of Neural Models},
+  author={Shen, Jianhao and Yuan, Ye and Mirzoyan, Srbuhi and Zhang, Ming and Wang, Chenguang},
+  journal={arXiv preprint arXiv:2402.17205},
+  year={2024}
+}
+```
+
+## Dataset Card Contact
+[email protected]