From f6eb9f55bd3c3eccdb208f8ebac8d534a586bf7b Mon Sep 17 00:00:00 2001
From: Zhengbao Jiang <zhengbao@users.noreply.huggingface.co>
Date: Wed, 26 Oct 2022 01:39:20 +0000
Subject: [PATCH] Create README.md

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d14c26e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+---
+language: en
+tags:
+- omnitab
+datasets:
+- wikitablequestions
+---
+
+# OmniTab
+
+OmniTab is a table-based QA model proposed in [OmniTab: Pretraining with Natural and Synthetic Data for Few-shot Table-based Question Answering](https://arxiv.org/pdf/2207.03637.pdf). The original Github repository is [https://github.com/jzbjyb/OmniTab](https://github.com/jzbjyb/OmniTab).
+
+## Description
+
+`neulab/omnitab-large-finetuned-wtq` (based on BART architecture) is initialized with `microsoft/tapex-large`, continuously pretrained on natural and synthetic data, and fine-tuned on [WikiTableQuestions](https://huggingface.co/datasets/wikitablequestions).
+
+## Usage
+
+```python
+from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
+import pandas as pd
+
+tokenizer = AutoTokenizer.from_pretrained("neulab/omnitab-large-finetuned-wtq")
+model = AutoModelForSeq2SeqLM.from_pretrained("neulab/omnitab-large-finetuned-wtq")
+
+data = {
+    "year": [1896, 1900, 1904, 2004, 2008, 2012],
+    "city": ["athens", "paris", "st. louis", "athens", "beijing", "london"]
+}
+table = pd.DataFrame.from_dict(data)
+
+query = "In which year did beijing host the Olympic Games?"
+encoding = tokenizer(table=table, query=query, return_tensors="pt")
+
+outputs = model.generate(**encoding)
+
+print(tokenizer.batch_decode(outputs, skip_special_tokens=True))
+# [' 2008']
+```
+
+## Reference
+
+```bibtex
+@inproceedings{jiang-etal-2022-omnitab,
+  title = "{O}mni{T}ab: Pretraining with Natural and Synthetic Data for Few-shot Table-based Question Answering",
+  author = "Jiang, Zhengbao and Mao, Yi and He, Pengcheng and Neubig, Graham and Chen, Weizhu",
+  booktitle = "Proceedings of the 2022 Conference of the North American Chapter of the Association for Computational Linguistics: Human Language Technologies",
+  month = jul,
+  year = "2022",
+}
+```
\ No newline at end of file