UniTable 项目使用教程

1. 项目的目录结构及介绍

UniTable 项目的目录结构如下：

unitable/
├── configs/
│   └── CONFIG.mk
├── dataset/
│   └── mini_pubtabnet/
├── experiments/
├── notebooks/
├── src/
├── vocab/
├── website/
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• configs/: 包含项目的配置文件 CONFIG.mk，用于定义实验名称和其他配置参数。
• dataset/: 包含示例数据集 mini_pubtabnet，用于快速了解训练过程。
• experiments/: 包含实验相关的文件和脚本。
• notebooks/: 包含 Jupyter Notebook 文件，用于演示和测试。
• src/: 包含项目的源代码。
• vocab/: 包含词汇表相关的文件。
• website/: 包含项目网站相关的文件。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证文件。
• Makefile: 项目的 Makefile 文件，用于自动化任务。
• README.md: 项目介绍和使用说明。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

UniTable 项目的启动文件主要是 Makefile 和 Jupyter Notebook 文件。

Makefile

Makefile 是项目的主要启动文件，包含了多个目标（targets），用于执行不同的任务，例如设置虚拟环境、下载模型权重、运行实验等。

常用目标

• make done_venv: 设置虚拟环境。
• make done_download_weights: 从 HuggingFace 下载模型权重。
• make experiment/<exp_name>/done_<training_type>: 运行特定实验。

Jupyter Notebook

notebooks/ 目录下包含多个 Jupyter Notebook 文件，用于演示和测试项目的功能。用户可以通过这些 Notebook 文件快速上手项目。

3. 项目的配置文件介绍

UniTable 项目的主要配置文件是 configs/CONFIG.mk。

CONFIG.mk

CONFIG.mk 文件定义了项目的各种配置参数，包括实验名称、数据集路径、模型参数等。

配置示例

# 实验名称
EXP_NAME := ssp_2m_mini_html_base

# 数据集路径
DATASET_ROOT := dataset/mini_pubtabnet

# 模型参数
MODEL_PARAMS := --batch_size 32 --learning_rate 0.001

通过修改 CONFIG.mk 文件中的参数，用户可以自定义实验和训练过程。

---

以上是 UniTable 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你快速上手和使用该项目。