2023-07-26

README.md

@@ -5,5 +5,96 @@ task_categories:
 ---
 
 # Dataset Description
-Wait...
-We are making something big
+> English version is [here](./README_English.md)
+
+这里有两个数据集：*raw_formulas*和*tokenized_formulas*。
+
+我们在*arxiv*上爬取了约100万条未经过清洗以及文本分词的latex公式的图片文本对从而得到了*raw_formulas*数据集。在将*raw_formulas*数据集进行**清洗**以及**文本分词**后得到了*tokenized_formulas*数据集。
+
+渲染公式对应的图片时，需要用到以下外部包：
+* amsmath
+* amsfonts
+* amssymb
+* mathtools
+
+## 有关*raw_formulas*数据集的一些细节
+我们爬取了包含以下公式环境的latex公式:
+  * equation
+  * align
+  * align*
+  * gather
+  * gather*
+公式中不存在以下内容：
+  * \label
+  * %
+  * \quad
+  * \qquad
+  * \vspace
+  * \hspace
+  * \resizebox
+  * \scalebox
+  * \rotatebox
+  * \parbox
+  * \fbox
+  * \makebox
+  * \raisebox
+  * \addvspace
+  * \hfill
+  * \vfill
+  * \textwidth
+  * \textheight
+  * \rule
+
+## *tokenized_formulas*数据集的一些预处理细节
+### 清洗
+* 我们删除了*raw_formulas*中一些无用的垃圾数据
+* 我们删除了*raw_formulas*中过于复杂的公式：
+  * 公式对应的渲染图片高宽比如果大于0.8，那么公式会被删除
+  * 字符长度大于200的公式被删除了
+* *raw_formulas*公式中的以下内容被删除了：
+  * \tag
+  * \text
+  * \begin{split}
+  * \end{split}
+  * \nonumber
+  * \notag
+* *raw_formulas*中的`equation、equation*、align、\[...\]`公式环境被替换成了`align*`公式环境，`gather`公式环境被替换成了`gather*`环境
+* 我们删除了*raw_formulas*中包含自定义宏的公式，**只有以下的常见自定义宏被保留了**:
+  * \newcommand{\R}{\mathbb{R}}
+  * \newcommand{\N}{\mathbb{N}}
+  * \newcommand{\Z}{\mathbb{Z}}
+  * \newcommand{\Q}{\mathbb{Q}}
+  * \newcommand{\C}{\mathbb{C}}
+  * \newcommand{\avg}[1]{\left<#1\right>}
+  * \newcommand{\Deriv}[2]{\frac{\mathrm{d} #1}{\mathrm{d} #2}}
+  * \newcommand{\dd}{\mathrm{d}}
+  * \newcommand{\norm}[1]{\left\lVert#1\right\rVert}
+  * \newcommand{\abs}[1]{\left|#1\right|}
+  * \newcommand{\vect}[1]{\mathbf{#1}}
+### 分词
+符合以下patten的子串被视为一个词：
+* \begin{.*?}
+* \end\{.*?}
+* \[A-Za-z]+
+
+以下关键词也被视为一个词：
+* \[
+* \]
+* \\
+* \{
+* \}
+* \_
+* \$
+* \&
+* \#
+* \%
+* \|
+* '
+* ''
+* '''
+* ''''
+* '\^
+* ''\^
+* '''\^
+* ''''\^
+

README_English.md

@@ -0,0 +1,96 @@
+---
+license: openrail
+task_categories:
+- image-to-text
+---
+# Dataset Description
+There are two datasets here: *raw_formulas* and *tokenized_formulas*.
+
+We crawled approximately 1 million uncleaned and untokenized latex formula image-text pairs from *arxiv*, resulting in the *raw_formulas* dataset. After cleaning and tokenizing the *raw_formulas* dataset, we obtained the *tokenized_formulas* dataset.
+
+When rendering images corresponding to the formulas, the following external packages are required:
+
+* amsmath
+* amsfonts
+* amssymb
+* mathtools
+
+## Details about the *raw_formulas* dataset
+We crawled latex formulas containing the following formula environments:
+* equation
+* align
+* align*
+* gather
+* gather*
+The formulas do not contain the following content:
+* \label
+* %
+* \quad
+* \qquad
+* \vspace
+* \hspace
+* \resizebox
+* \scalebox
+* \rotatebox
+* \parbox
+* \fbox
+* \makebox
+* \raisebox
+* \addvspace
+* \hfill
+* \vfill
+* \textwidth
+* \textheight
+* \rule
+
+## Preprocessing details of the *tokenized_formulas* dataset
+### Cleaning
+* We removed some useless junk data from *raw_formulas*.
+* We removed overly complex formulas from *raw_formulas*:
+* Formulas with a render image aspect ratio greater than 0.8 were deleted.
+* Formulas with a character length greater than 200 were deleted.
+* The following content in *raw_formulas* formulas was removed:
+  * \tag,
+  * \text
+  * \begin{split}
+  * \end{split}
+  * \nonumber
+  * \notag
+* In *raw_formulas*, the `equation, equation*, align, \[...\]` formula environments were replaced with the `align*` formula environment, and the `gather` formula environment was replaced with the `gather*` environment.
+* We removed formulas containing custom macros from *raw_formulas*, only the following common custom macros were retained:
+  * \newcommand{\R}{\mathbb{R}}
+  * \newcommand{\N}{\mathbb{N}}
+  * \newcommand{\Z}{\mathbb{Z}}
+  * \newcommand{\Q}{\mathbb{Q}}
+  * \newcommand{\C}{\mathbb{C}}
+  * \newcommand{\avg}[1]{\left<#1\right>}
+  * \newcommand{\Deriv}[2]{\frac{\mathrm{d} #1}{\mathrm{d} #2}}
+  * \newcommand{\dd}{\mathrm{d}}
+  * \newcommand{\norm}[1]{\left\lVert#1\right\rVert}
+  * \newcommand{\abs}[1]{\left|#1\right|}
+  * \newcommand{\vect}[1]{\mathbf{#1}}
+
+### Tokenization
+Substrings that match the following pattern are considered a word:
+* \begin{.*?}
+* \end{.*?}
+* [A-Za-z]+
+
+The following keywords are also considered a word:
+* ]
+* {
+* }
+* _
+* $
+* &
+* #
+* %
+* |
+* '
+* ''
+* '''
+* ''''
+* '^
+* ''^
+* '''^
+* ''''^