Update README.md

README.md

@@ -52,5 +52,103 @@ configs:
     path: data/train-*
 ---
 
-This is the HF repo for the IndicMTEval dataset.
-See the github for the same: https://github.com/AI4Bharat/IndicMT-Eval
+# IndicMT-Eval
+
+This repository contains the code for the paper "IndicMT Eval: A Dataset to Meta-Evaluate Machine Translation Metrics for Indian Languages" to appear at ACL 2023
+
+## Contents
+
+- [Overview](#overview)
+- [MQM Dataset](#mqm-dataset)
+- [How to use](#How-to-use)
+- [Indic Comet](#indic-comet)
+- [Other Metrics](#other-metrics)
+- [Citation](#citation)
+
+## Overview
+
+We contribute a Multidimensional Quality Metric (MQM) dataset for Indian languages created by taking outputs generated by 7 popular MT systems and asking human annotators to judge the quality of the translations using the MQM style guidelines. Using this rich set of annotated data, we show the performance of 16 metrics of various types on evaluating en-xx translations for 5 Indian languages. We provide an updated metric called Indic-COMET which not only shows stronger correlations with human judgement on Indian languages, but is also more robust to perturbations. 
+
+Please find more details of this work in our paper (link coming soon).
+
+## MQM Dataset
+
+The MQM annotated dataset collected with the help of language experts for the 5 Indian lamguages (Hindi, Tamil, Marathi, Malayalam, Gujarati) can be downloaded from here (link coming soon).
+
+An example of an MQM annotation containing the source, reference and the translated output with error spans as demarcated by the annotator looks like the following:
+![MQM-example](https://github.com/AI4Bharat/IndicMT-Eval/assets/23221743/0296986f-bb89-4044-88ef-b8fb71acf9ee)
+
+More details regarding the instructions provided and the procedures followed for annotations are present in the paper.
+
+
+### How to use
+
+The `datasets` library allows you to load and pre-process your dataset in pure Python, at scale. The dataset can be downloaded and prepared in one call to your local drive by using the `load_dataset` function. 
+
+
+- Before downloading first follow the following steps:
+
+  1.  Gain access to the dataset and get the HF access token from: [https://huggingface.co/settings/tokens](https://huggingface.co/settings/tokens).
+  2.  Install dependencies and login HF:
+       - Install Python
+       - Run `pip install librosa soundfile datasets huggingface_hub[cli]`
+       - Login by `huggingface-cli login` and paste the HF access token. Check [here](https://huggingface.co/docs/huggingface_hub/guides/cli#huggingface-cli-login) for details.
+
+For example:
+```python
+from datasets import load_dataset
+ds = load_dataset("ai4bharat/IndicMTEval")
+```
+
+
+Using the datasets library, you can also stream the dataset on-the-fly by adding a `streaming=True` argument to the `load_dataset` function call. Loading a dataset in streaming mode loads individual samples of the dataset at a time, rather than downloading the entire dataset to disk.
+```python
+from datasets import load_dataset
+ds = load_dataset("ai4bharat/IndicMTEval",streaming=True)
+print(next(iter(ds)))
+```
+
+## Indic Comet
+
+We load the pretrained encoder and initialize it with either XLM-Roberta, COMET-DA or COME-MQM weights. During training, we divide the model parameters into two groups: the encoder parameters, that include the encoder model and the regressor parameters, that include the parameters from the top feed-forward network. We apply gradual unfreezing and discriminative learning rates, meaning that the encoder model is frozen for one epoch while the feed-forward is optimized with a learning rate. After the first epoch, the entire model is fine-tuned with a different learning rate. Since we are fine-tuning on a small dataset, we make use of early stopping with a patience of 3. The best saved checkpoint is decided using the overall Kendall-tau correlation on the test set. We use the [COMET](https://github.com/Unbabel/COMET) repository for training and our checkpoints are compatible with their setup.
+
+Download the best checkpoint here
+
+| MQM | DA |
+| ---- | --- |
+| [indic-comet-mqm](https://objectstore.e2enetworks.net/indic-asr-public/data/anushka/comet_mqm_1.5e-5/comet_mqm_1.5e-5/checkpoints/epoch=2-step=1875-val_kendall=0.455.ckpt) | [indic-comet-da](https://objectstore.e2enetworks.net/indic-asr-public/data/anushka/comet_da_1.5e-5/comet_da_1.5e-5/checkpoints/epoch=3-step=2500-val_kendall=0.456.ckpt) |
+| [hparams.yaml](https://objectstore.e2enetworks.net/indic-asr-public/data/anushka/comet_da_1.5e-5/comet_da_1.5e-5/hparams.yaml) | [hparamas.yaml](https://objectstore.e2enetworks.net/indic-asr-public/data/anushka/comet_mqm_1.5e-5/comet_mqm_1.5e-5/hparams.yaml) |
+
+## Other Metrics
+
+We followed the implementation of metrics with the help of the following repositories:
+ For BLEU, METEOR, ROUGE-L, CIDEr, Embedding Averaging, Greedy Matching, and Vector Extrema, we use the implementation provided by [Sharma et al. (2017)](https://github.com/Maluuba/nlg-eval). For chrF++, TER, BERTScore, and BLEURT, we use the repository of [Castro Ferreira et al. (2020)](https://github.com/WebNLG/GenerationEval).  For SMS, WMDo, and Mover-Score, we use the implementation provided by [Fabbri et al. (2020)](https://github.com/Yale-LILY/SummEval). For all the remaining task-specific metrics, we use the official codes from the respective papers.
+ 
+ <br>
+ The python file code/evaluate.py runs all of these metrics on the given dataset.
+
+## Citation
+If you find IndicMTEval useful in your research or work, please consider citing our paper.
+```
+@article{DBLP:journals/corr/abs-2212-10180,
+  author       = {Ananya B. Sai and
+                  Tanay Dixit and
+                  Vignesh Nagarajan and
+                  Anoop Kunchukuttan and
+                  Pratyush Kumar and
+                  Mitesh M. Khapra and
+                  Raj Dabre},
+  title        = {IndicMT Eval: {A} Dataset to Meta-Evaluate Machine Translation metrics
+                  for Indian Languages},
+  journal      = {CoRR},
+  volume       = {abs/2212.10180},
+  year         = {2022}
+}
+
+@article{singh2024good,
+  title={How Good is Zero-Shot MT Evaluation for Low Resource Indian Languages?},
+  author={Singh, Anushka and Sai, Ananya B and Dabre, Raj and Puduppully, Ratish and Kunchukuttan, Anoop and Khapra, Mitesh M},
+  journal={arXiv preprint arXiv:2406.03893},
+  year={2024}
+}
+```