Update README.md

README.md

@@ -1,34 +1,61 @@
 ---
-license: mit
+license: cc-by-4.0
 task_categories:
-  - text-generation
-  - question-answering
+- text-generation
+- question-answering
 language:
-  - en
+- en
 pretty_name: StackMathQA
 size_categories:
-  - 1B<n<10B
+- 1B<n<10B
 configs:
 - config_name: stackmathqa1600k
-  data_files: "data/stackmathqa1600k/all.jsonl"
+  data_files: data/stackmathqa1600k/all.jsonl
   default: true
 - config_name: stackmathqa800k
-  data_files: "data/stackmathqa800k/all.jsonl"
+  data_files: data/stackmathqa800k/all.jsonl
 - config_name: stackmathqa400k
-  data_files: "data/stackmathqa400k/all.jsonl"
+  data_files: data/stackmathqa400k/all.jsonl
 - config_name: stackmathqa200k
-  data_files: "data/stackmathqa200k/all.jsonl"
+  data_files: data/stackmathqa200k/all.jsonl
 - config_name: stackmathqa100k
-  data_files: "data/stackmathqa400k/all.jsonl"
+  data_files: data/stackmathqa400k/all.jsonl
 - config_name: preprocessed-1q1a
-  data_files: "preprocessed/stackexchange-math--1q1a/*.jsonl"
+  data_files: preprocessed/stackexchange-math--1q1a/*.jsonl
 - config_name: preprocessed-qalist
-  data_files: "preprocessed/stackexchange-math/*.jsonl"
+  data_files: preprocessed/stackexchange-math/*.jsonl
+tags:
+- mathematical-reasoning
+- reasoning
+- finetuning
+- pretraining
+- llm
 ---
 
 # StackMathQA
 StackMathQA is a meticulously curated collection of **2 million** mathematical questions and answers, sourced from various Stack Exchange sites. This repository is designed to serve as a comprehensive resource for researchers, educators, and enthusiasts in the field of mathematics and data science.
 
+## Configs
+
+```YAML
+configs:
+- config_name: stackmathqa1600k
+  data_files: data/stackmathqa1600k/all.jsonl
+  default: true
+- config_name: stackmathqa800k
+  data_files: data/stackmathqa800k/all.jsonl
+- config_name: stackmathqa400k
+  data_files: data/stackmathqa400k/all.jsonl
+- config_name: stackmathqa200k
+  data_files: data/stackmathqa200k/all.jsonl
+- config_name: stackmathqa100k
+  data_files: data/stackmathqa400k/all.jsonl
+- config_name: preprocessed-1q1a
+  data_files: preprocessed/stackexchange-math--1q1a/*.jsonl
+- config_name: preprocessed-qalist
+  data_files: preprocessed/stackexchange-math/*.jsonl
+```
+
 ## Preprocessed Data
 In the `./preprocessed/stackexchange-math` directory and `./preprocessed/stackexchange-math--1q1a` directory, you will find the data structured in two formats:
 
@@ -40,6 +67,20 @@ In the `./preprocessed/stackexchange-math` directory and `./preprocessed/stackex
    - `physics.stackexchange.com.jsonl`: 117,318 lines
    - In total: **1,138,426** questions
 
+```YAML
+dataset_info:
+  features:
+    - name: Q
+      dtype: string
+      description: "The mathematical question in LaTeX encoded format."
+    - name: A_list
+      dtype: sequence
+      description: "The list of answers to the mathematical question, also in LaTeX encoded."
+    - name: meta
+      dtype: dict
+      description: "A collection of metadata for each question and its corresponding answer list."
+```
+
 2. **Question and Single Answer Format**:
    Each line contains a question and one corresponding answer, structured as {"Q": "question", "A": "answer"}. Multiple answers for the same question are separated into different lines.
    - `math.stackexchange.com.jsonl`: 1,407,739 lines
@@ -48,22 +89,72 @@ In the `./preprocessed/stackexchange-math` directory and `./preprocessed/stackex
    - `physics.stackexchange.com.jsonl`: 226,532 lines
    - In total: **1,957,006** answers
   
+```YAML
+dataset_info:
+  features:
+    - name: Q
+      dtype: string
+      description: "The mathematical question in LaTeX encoded format."
+    - name: A
+      dtype: string
+      description: "The answer to the mathematical question, also in LaTeX encoded."
+    - name: meta
+      dtype: dict
+      description: "A collection of metadata for each question-answer pair."
+```
+  
 ## Selected Data
 The dataset has been carefully curated using importance sampling. We offer selected subsets of the dataset (`./preprocessed/stackexchange-math--1q1a`) with different sizes to cater to varied needs:
 
+```YAML
+dataset_info:
+  features:
+    - name: Q
+      dtype: string
+      description: "The mathematical question in LaTeX encoded format."
+    - name: A
+      dtype: string
+      description: "The answer to the mathematical question, also in LaTeX encoded."
+    - name: meta
+      dtype: dict
+      description: "A collection of metadata for each question-answer pair."
+```
+
 ### StackMathQA1600K
 - Location: `./data/stackmathqa1600k`
 - Contents:
   - `all.jsonl`: Containing 1.6 million entries.
   - `meta.json`: Metadata and additional information.
 
+Similar structures are available for StackMathQA800K, StackMathQA400K, StackMathQA200K, and StackMathQA100K subsets.
+
 ### StackMathQA800K
 - Location: `./data/stackmathqa800k`
 - Contents:
   - `all.jsonl`: Containing 800k entries.
   - `meta.json`: Metadata and additional information.
 
-Similar structures are available for StackMathQA400K, StackMathQA200K, and StackMathQA100K subsets.
+
+### StackMathQA400K
+
+- Location: `./data/stackmathqa400k`
+- Contents:
+  - `all.jsonl`: Containing 400k entries.
+  - `meta.json`: Metadata and additional information.
+ 
+### StackMathQA200K
+
+- Location: `./data/stackmathqa200k`
+- Contents:
+  - `all.jsonl`: Containing 200k entries.
+  - `meta.json`: Metadata and additional information.
+
+### StackMathQA100K
+
+- Location: `./data/stackmathqa100k`
+- Contents:
+  - `all.jsonl`: Containing 100k entries.
+  - `meta.json`: Metadata and additional information.
 
 ## Citation
 We appreciate your use of StackMathQA in your work. If you find this repository helpful, please consider citing it and star this repo. Feel free to contact [email protected] or open an issue if you have any questions.
@@ -74,4 +165,4 @@ We appreciate your use of StackMathQA in your work. If you find this repository
       author={Zhang, Yifan},
       year={2024},
 }
-```
+```