README.md

umBRELA

📟 Instructions

Create Conda Environment

conda create -n umbrela python=3.10
conda activate umbrela

If you do not already have JDK 21 installed, install via conda:

conda install -c conda-forge openjdk=21 maven -y

Install following dependencies for retrieval:

conda install -c pytorch faiss-cpu pytorch -y

Install Dependencies

pip install -r requirements.txt

Judgment generation snippet

Setting up the model jugde:

from umbrela.gpt_judge import GPTJudge

judge_gpt = GPTJudge(qrel="dl19-passage", prompt_type="bing")

Passing qrel-passages for evaluations:

input_dict = {
    "query": {"text": "how long is life cycle of flea", "qid": "264014"},
    "candidates": [
        {
            "doc": {
                "segment": "The life cycle of a flea can last anywhere from 20 days to an entire year. It depends on how long the flea remains in the dormant stage (eggs, larvae, pupa). Outside influences, such as weather, affect the flea cycle. A female flea can lay around 20 to 25 eggs in one day."
            },
            "docid": "4834547",
        },
    ]
}

judgments = judge_gpt.judge(request_dict=input_dict)

Evaluation for complete judgment:

python umbrela/gpt_judge.py --qrel dl19-passage --result_file <path/to/result-file> --prompt_type bing --model gpt-4o --few_shot_count 0 --removal_fraction 1

✨ References

If you use umBRELA, please cite the following paper:

[2406.06519] UMBRELA: UMbrela is the (Open-Source Reproduction of the) Bing RELevance Assessor

@ARTICLE{upadhyay2024umbrela,
  title   = {UMBRELA: UMbrela is the (Open-Source Reproduction of the) Bing RELevance Assessor},
  author  = {Shivani Upadhyay and Ronak Pradeep and Nandan Thakur and Nick Craswell and Jimmy Lin},
  year    = {2024},
  journal = {arXiv:2406.06519}
}

🙏 Acknowledgments

This research is supported in part by the Natural Sciences and Engineering Research Council (NSERC) of Canada.