This repository contains the code necessary to reproduce the short-phrase and sentence-length experiments of the Nature submission 'Detecting Hallucinations in Large Language Models Using Semantic Entropy'.
This repository builds on the original, now deprecated codebase for semantic uncertainty at https://github.com/lorenzkuhn/semantic_uncertainty.
We here discuss hardware and software system requirements.
Generally speaking, our experiments require modern computer hardware which is suited for usage with large language models (LLMs).
Requirements regarding the system's CPU and RAM size are relatively modest: any reasonably modern system should suffice, e.g. a system with an Intel 10th generation CPU and 16 GB of system memory or better.
More importantly, all our experiments make use of one or more Graphics Processor Units (GPUs) to speed up LLM inference. Without a GPU, it is not feasible to reproduce our results in a reasonable amount of time. The particular GPU necessary depends on the choice of LLM: LLMs with more parameters require GPUs with more memory. For smaller models (7B parameters), desktop GPUs such as the Nvidia TitanRTX (24 GB) are sufficient. For larger models (13B), GPUs with more memory, such as the Nvidia A100 server GPU, are required. Our largest models with 70B parameters require the use of two Nvidia A100 GPUs (2x80GB) simultaneously.
One can reduce the precision to float16 or int8 to reduce memory requirements without significantly affecting model predictions and their accuracy.
We use float16 for 70B models by default, and int8 mode can be enabled for any model by suffixing the model name with -int8.
Our code relies on Python 3.11 with PyTorch 2.1.
Our systems run the Ubuntu 20.04.6 LTS (GNU/Linux 5.15.0-89-generic x86_64) operating system.
In environment_export.yaml we list the exact versions for all Python packages used in our experiments. We generally advise against trying to install from this exact export of our conda environment. Please see below for installation instructions.
Although we have not tested this, we would expect our code to be compatible with other operating systems, Python versions, and versions of the Python libraries that we use.
To install Python with all necessary dependencies, we recommend the use of conda, and we refer to https://conda.io/ for an installation guide.
After installing conda, you can set up and activate a new conda environment with all required packages by executing the following commands from the root folder of this repository in a shell:
conda-env update -f environment.yaml
conda activate semantic_uncertainty
The installation should take around 15 minutes.
Our experiments rely on Weights & Biases (wandb) to log and save individual runs. While wandb will be installed automatically with the above conda script, you may need to log in with your wandb API key upon initial execution.
Our experiments rely on Hugging Face for all LLM models and most of the datasets.
It may be necessary to set the environment variable HUGGING_FACE_HUB_TOKEN to the token associated with your Hugging Face account.
Further, it may be necessary to apply for access to use the official repository of Meta's LLaMa-2 models.
We further recommend setting the XDG_CACHE_HOME environment variable to a directory on a device with sufficient space, as models and datasets will be downloaded to this folder.
Our experiments with sentence-length generation use GPT models from the OpenAI API.
Please set the environment variable OPENAI_API_KEY to your OpenAI API key in order to use these models.
Note that OpenAI charges a cost per input token and per generated token.
Costs for reproducing our results vary depending on experiment configuration, but, without any guarantee, should lie somewhere between 5 and 30 USD per run.
For almost all tasks, the dataset is downloaded automatically from the Hugging Face Datasets library upon first execution.
The only exception is BioASQ (task b, BioASQ11, 2023), for which the data needs to be downloaded manually and stored at $SCRATCH_DIR/$USER/semantic_uncertainty/data/bioasq/training11b.json, where $SCRATCH_DIR defaults to ..
Execute
python semantic_uncertainty/generate_answers.py --model_name=Llama-2-7b-chat --dataset=trivia_qa
to reproduce results for short-phrase generation with LLaMa-2 Chat (7B) on the BioASQ dataset.
The expected runtime of this demo is 1 hour using an Nvidia A100 GPU (80 GB), 24 cores of a Intel(R) Xeon(R) Gold 6248R CPU @ 3.00GHz, and 192 GB of RAM. Runtime may be longer upon first execution, as the LLM needs to be downloaded from Hugging Face first.
To evaluate the run and obtain a barplot similar to those of the paper, open the Jupyter notebook in notebooks/example_evaluation.ipynb, populate the wandb_id variable in the first cell with the id assigned to your demo run, and execute all cells of the notebook.
We refer to https://jupyter.org/ for more information on how to start the Jupter notebook server.
We here give an overview of the various components of the code.
By default, a standard run executes the following three scripts in order:
generate_answers.py: Sample responses (and their likelihods/hidden states) from the models for a set of input questions.compute_uncertainty_measures.py: Compute uncertainty metrics given responses.analyze_results.py: Compute aggregate performance metrics given uncertainties.
It is possible to run these scripts individually, e.g. when recomputing results, and we are happy to provide guidance on how to do so upon request.
To reproduce the experiments of the paper, one needs to execute
python generate_answers.py --model_name=$MODEL --dataset=$DATASET $EXTRA_CFG
for all combinations of models and datasets, and where $EXTRA_CFG is defined to either activate short-phrase or sentence-length generations and their associated hyperparameters.
Concretely,
$MODELis one of:[Llama-2-7b, Llama-2-13b, Llama-2-70b, Llama-2-7b-chat, Llama-2-13b-chat, Llama-2-70b-chat, falcon-7b, falcon-40b, falcon-7b-instruct, falcon-40b-instruct, Mistral-7B-v0.1, Mistral-7B-Instruct-v0.1],$DATASETis one of[trivia_qa, squad, bioasq, nq, svamp],- and
$EXTRA_CFG=''is empty for short-phrase generations andEXTRA_CFG=--num_few_shot=0 --model_max_new_tokens=100 --brief_prompt=chat --metric=llm_gpt-4 --entailment_model=gpt-3.5 --no-compute_accuracy_at_all_tempsfor sentence-length generations.
The results for any run can be obtained by passing the associated wandb_id to an evaluation notebook identical to the demo in notebooks/example_evaluation.ipynb.