Update README.md

README.md

@@ -1,3 +1,88 @@
----
-license: mit
----
+---
+license: mit
+---
+# Usage
+```python
+import pandas as pd
+from datasets import load_dataset
+from transformers import M2M100ForConditionalGeneration
+model = M2M100ForConditionalGeneration.from_pretrained("vaishali/HiTQA-M2M")
+tokenizer = AutoTokenizer.from_pretrained("vaishali/HiTQA-M2M", src_lang="hi", tgt_lang="hi")
+forced_bos_id = forced_bos_token_id = tokenizer.get_lang_id("hi")
+
+
+# linearize table
+def process_header(headers: List):
+  return "<कलाम> " + " | ".join(headers)
+
+def process_row(row: List, row_index: int):
+  hi2enDigits = {'०': '0', '१': '1', '२': '2', '३': '3', '४': '4', '५': '5', '६': '6', '७': '7', '८': '8',
+                       '९': '9', '.': '.'}
+  en2hiDigits = {v:k for k, v in hi2enDigits.items()}
+  row_str = ""
+  row_cell_values = []
+  for cell_value in row:
+      if isinstance(cell_value, int) or isinstance(cell_value, float):
+          cell_value = convert_engDigit_to_hindi(str(cell_value))
+          row_cell_values.append(str(cell_value))
+      else:
+          row_cell_values.append(cell_value)
+  row_str += " | ".join([row_cell_values for cell_value in row])
+  hi_row_index = []
+  for c in str(row_index):
+      hi_row_index.append(en2hiDigits[c])
+  return "<रो " + "".join(hi_row_index) + "> " + row_str
+
+def process_table(table_content: Dict):
+  table_str = process_header(table_content["header"]) + " "
+  for i, row_example in enumerate(table_content["rows"]):
+      table_str += process_row(row_example, row_index=i + 1) + " "
+  return table_str.strip()
+
+# load the dataset
+hinditableQA = load_dataset("vaishali/hindiTabQA")
+
+for sample in hinditableQA['train']:
+  question = sample['question']
+  input_table = pd.read_json(sample['table'], orient='split')
+  answer = pd.read_json(sample['answer'], orient='split')
+
+  # create the input sequence: query + linearized input table
+  table_content = {"header": list(input_table.columns)[1:], "rows": [list(row.values)[1:] for i, row in input_table.iterrows()]}
+  linearized_inp_table = process_table(table_content)
+  linearized_output_table = process_table({"name": None, "header": [self.translate_column(col) for col in list(answer.columns)], 
+                             "rows": [list(row.values) for i, row in answer.iterrows()]})
+  source = query + " " + linearized_inp_table
+  target = linearized_output_table
+  input = tokenizer(source,
+                    return_tensors="pt",
+                    padding="max_length",
+                    truncation="longest_first",
+                    max_length=1024,
+                    add_special_tokens=True)
+
+  out = model.generate(input["input_ids"].to("cuda"), num_beams=5, return_dict_in_generate=True,
+                                output_scores=True, max_length=1024)
+```
+# BibTeX entry and citation info
+```
+@inproceedings{pal-etal-2024-table,
+    title = "Table Question Answering for Low-resourced {I}ndic Languages",
+    author = "Pal, Vaishali  and
+      Kanoulas, Evangelos  and
+      Yates, Andrew  and
+      de Rijke, Maarten",
+    editor = "Al-Onaizan, Yaser  and
+      Bansal, Mohit  and
+      Chen, Yun-Nung",
+    booktitle = "Proceedings of the 2024 Conference on Empirical Methods in Natural Language Processing",
+    month = nov,
+    year = "2024",
+    address = "Miami, Florida, USA",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2024.emnlp-main.5",
+    pages = "75--92",
+    abstract = "TableQA is the task of answering questions over tables of structured information, returning individual cells or tables as output. TableQA research has focused primarily on high-resource languages, leaving medium- and low-resource languages with little progress due to scarcity of annotated data and neural models. We address this gap by introducing a fully automatic large-scale tableQA data generation process for low-resource languages with limited budget. We incorporate our data generation method on two Indic languages, Bengali and Hindi, which have no tableQA datasets or models. TableQA models trained on our large-scale datasets outperform state-of-the-art LLMs. We further study the trained models on different aspects, including mathematical reasoning capabilities and zero-shot cross-lingual transfer. Our work is the first on low-resource tableQA focusing on scalable data generation and evaluation procedures. Our proposed data generation method can be applied to any low-resource language with a web presence. We release datasets, models, and code (https://github.com/kolk/Low-Resource-TableQA-Indic-languages).",
+}
+
+```