Rename README_English.md to README_zh.md

README_English.md

@@ -1,98 +0,0 @@
----
-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 strings are also considered a word:
-* \\[
-* \\]
-* \\{
-* \\}
-* \\_
-* \\$
-* \\&
-* \\\#
-* \\%
-* \\|
-* '
-* ''
-* '''
-* ''''
-* '^
-* ''^
-* '''^
-* ''''^

README_zh.md

@@ -0,0 +1,77 @@
+---
+license: openrail
+task_categories:
+- image-to-text
+---
+
+# Dataset Description
+
+这里有两个数据集：**raw_formulas**和**cleaned_formulas**(这个数据集有*550K*个公式-图片对)。
+
+我们在*arxiv*上爬取了约100万条未经过清洗以及文本分词的latex公式的图片文本对从而得到了*raw_formulas*数据集。
+在将*raw_formulas*数据集进行**清洗**并加入[im2latex-100K](https://zenodo.org/records/56198#.V2px0jXT6eA)数据集后得到了*cleaned_formulas*数据集（一个具有*550K*公式-图片对的数据集）。
+
+渲染公式对应的图片时，需要用到以下外部包：
+* amsmath
+* amsfonts
+* amssymb
+* mathtools
+
+## 用法
+加载 **raw_formulas** 数据集:
+
+```python 
+from datasets import load_dataset
+data = load_dataset("OleehyO/latex-formulas", "raw_formulas") 
+```
+
+加载 **cleaned_formulas** 数据集:
+```python
+from datasets import load_dataset
+data = load_dataset("OleehyO/latex-formulas", "cleaned_formulas") 
+```
+
+## 有关*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
+
+## *cleaned_formulas*数据集的一些预处理细节
+### 清洗
+* 我们删除了*raw_formulas*和[im2latex-100K](https://zenodo.org/records/56198#.V2px0jXT6eA)中一些无用的垃圾数据
+* 我们删除了*raw_formulas*和[im2latex-100K](https://zenodo.org/records/56198#.V2px0jXT6eA)中过于复杂的公式：
+  * 公式对应的渲染图片高宽比如果大于0.8，那么公式会被删除
+  * 字符长度大于200的公式被删除了
+* 在*raw_formulas*和[im2latex-100K](https://zenodo.org/records/56198#.V2px0jXT6eA)的公式中，以下内容被删除了：
+  * \tag
+  * \text
+  * \begin{split}
+  * \end{split}
+  * \nonumber
+  * \notag
+* *raw_formulas*和中的`equation、equation*、align、\[...\]`公式环境均被替换成了`align*`公式环境
+* 我们删除了*raw_formulas*中包含自定义宏的公式。