README.md

---
language:
- en
pretty_name: "TableSense Dataset"
tags:
- tabular
- spreadsheet
- table-detection
- excel
license: mit
size_categories:
- 1K<n<10K
---

# TableSense Dataset
## Overview
This dataset is derived from the tablesense [paper](https://arxiv.org/abs/2106.13500) and [github repo](https://github.com/microsoft/TableSense).

### Original description: 

Tablesense: Spreadsheet table detection with convolutional neural networks 

Spreadsheet table detection is the task of detecting all tables on a given sheet and locating their respective ranges. Automatic table detection is a key enabling technique and an initial step in spreadsheet data intelligence. To enable data-driven models, we annotated a large amount of table ranges on real spreadsheet data. Our annotations are based on three public datasets (VEnron2, VEUSUS, and VFUSE), which are widely used in spreadsheet domain. To eliminate similar spreadsheets that may introduce lots of duplicated labeling efforts, we use [the published dataset](https://figshare.com/projects/Versioned_Spreadsheet_Corpora/20116) which has clustered similar sheets by [SpreadCluster](http://www.tcse.cn/~wsdou/project/venron/):
1.	VEnron2 is built on the Enron email archive by SpreadCluster (MSR 2017). It contains 1,609 evolution groups and 12,254 spreadsheets.
2.	VEUSES is built on EUSES by SpreadCluster (MSR 2017). It contains 177 evolution groups and 363 spreadsheets.
3.	VFUSE is built on FUSE by SpreadCluster (MSR 2017). It contains 188 evolution groups and 1,143 spreadsheets.

Note that the WebSheet dataset introduced by [TableSense](https://www.microsoft.com/en-us/research/uploads/prod/2019/01/TableSense_AAAI19.pdf) needs to solve compliance issues before publishing, so we firstly publish annotations for VEnron2, VEUSUS, and VFUSE to facilitate recent research.
To process raw Excel files, we first transformed original Excel files from .xls to .xlsx. Second, we tried to read and extract features from these files using ClosedXML. We excluded those files that failed to transform and process. Then we seleceted one file for each cluster, and labeled only the first two sheets for those files containing multiple spreadsheets. All sheets had been labeled and checked by no less than two persons. We excluded those controversial cases between annotators. Finally we got 2,615 tables from 1,645 spreadsheet. Since VEnron2 has the greatest number of clusters, it contributes most annotated table ranges.

### Processing 

We downloaded the three datasets from the link above, converted them to xlsx using libreoffice and aggregated them into this dataset. See process_data.py for details. 

### Dataset Structure 

- **filepath**: Path to the source spreadsheet file
- **sheet_name**: Name of the worksheet containing the table
- **split**: Dataset split (training_set or testing_set)
- **table_regions**: List of table regions, each containing:
  - **start_col**: Starting column (ex: A, AA, BC)
  - **start_row**: Starting row number  (an integer)
  - **end_col**: Ending column 
  - **end_row**: Ending row number

## Usage

```
from datasets import load_dataset

dataset = load_dataset("kl3269/tablesense",split="all", trust_remote_code=True)

example = dataset[0]
print(example)

# {'filepath': '/Users/kylel1/Documents/GitHub/tablesense/data/VEnron2_VEnron2_253_1_CounterParty Trading status 2001_11_13 pm.xlsx', 'sheet_name': 'Counterparty Trading Statuses', 'split': 'training_set', 'table_regions': [{'start_col': 'A', 'start_row': 1, 'end_col': 'AB', 'end_row': 52}]}
```