doclens

Code for "DocLens: Multi-aspect Fine-grained Evaluation for Medical Text Generation" (ACL 2024)

https://github.com/yiqingxyq/doclens

Science Score: 41.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Code for "DocLens: Multi-aspect Fine-grained Evaluation for Medical Text Generation" (ACL 2024)

Basic Info
  • Host: GitHub
  • Owner: yiqingxyq
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 458 KB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 2
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.md

DocLens 🔍

Code for "DocLens: Multi-aspect Fine-grained Evaluation for Medical Text Generation" (Arxiv)

If you find our paper or code useful, please cite the paper: @inproceedings{xie2024doclens, title={DocLens: Multi-aspect Fine-grained Evaluation for Medical Text Generation}, author={Yiqing Xie and Sheng Zhang and Hao Cheng and Pengfei Liu and Zelalem Gero and Cliff Wong and Tristan Naumann and Hoifung Poon and Carolyn Rose}, year={2024}, booktitle={Proceedings of the 62nd Annual Meeting of the Association for Computational Linguistics} }

 

Data

To evaluate with DocLens, you will need two json files: * (1) a file with the input and reference, which should be put under data/, and * (2) a file with the generated text, which should be put under results/

The file with the input and reference is a list of dicts. Each dict represents a test example and is in the following format: { "example_id": the id of this example, "input": the input text, "reference": the reference output # Optional, required for claim recall/precision evaluation } Note that the reference key is required for the claim recall/precision evaluation, but is not required for citation recall/precision evaluation.

The file with the generated text is also a list of dicts with a similar format: { "example_id": the id of this example, "input": the input text, "output": the system output }

 

Evaluation with DocLens

We provide the code to compute claim recall, claim precision, citation recall, and citation precision.

Claim Generation

To evaluate claim recall and claim precision, we will need to first generate the subclaims for the reference and outputs by running: bash scripts/eval_general_claim_generation.sh $SAVENAME $REFERENCE $PROMPT_FILE $SAVENAME is the name of the file for generated text without the '.json' file extension (e.g., if your file is results/generation.json, we have $SAVENAME="generation"). $REFERENCE is the name of the file with the input and reference without the '.json' file extension (e.g., if your file is data/reference.json, we have $REFERENCE="reference"). $PROMPT_FILE is the prompt for claim extraction. We provide a simple prompt template in claim_evaluation/prompts/general_subclaim_generation.json. You can also create your own prompt file.

 

Claim Recall and Claim Precision Computation

After generating the claims, we can compute claim recall and claim precision. You can use the GPT-4 evaluator by running: bash scripts/eval_general_api_claim_entailment.sh $SAVENAME $REFERENCE $PROMPT_FILE We have $PROMPTFILE="claimevaluation/prompts/generalclaimentail.json" by default

You can also use the Mistral or TRUE evaluators: bash scripts/eval_general_model_claim_entailment.sh $SAVENAME $REFERENCE $EVAL_MODEL $PROMPT_FILE You can choose the evaluator model by setting $EVAL_MODEL=TRUE or $EVAL_MODEL=Mistral. If you want to use Mistral for evaluation, you can also specify the $PROMPTFILE, which is by default `claimevaluation/prompts/generalclaimentail_Mistral.json`

 

Citation Recall and Citation Precision Computation

The computation of citation recall and citation precision do not need reference. You can use GPT-4 to compute citation recall and precision: bash scripts/eval_general_api_citation.sh $SAVENAME $PROMPT_FILE We have $PROMPT_FILE="citation_evaluation/prompts/general_citation_entail.json" by default.

You can also use the Mistral or TRUE evaluators: bash scripts/eval_general_model_citation.sh $SAVENAME $EVAL_MODEL $PROMPT_FILE We have $PROMPT_FILE="citation_evaluation/prompts/general_citation_entail_Mistral.json" by default.

 

Aggregate Scores

The scores of all examples can be aggregated by aggregate_scores.py. For example: python aggregate_scores.py --result_file results/${SAVENAME}.json \ --eval_claim_recall \ # compute claim recall --eval_claim_precision \ # compute claim precision --eval_citations \ # compute citation recall or citation precision --eval_model GPT # can also be Mistral or TRUE, depend on the evaluator model you used

 

Reproduce the Results in our Paper

Here are the instructions for reproducing the results on ACI-BENCH (note generation), MIMIC (report summarization), and MeQSum (question summarization) in our paper.

Data

We provide the preprocessed datafiles as follows: data ├── ACI-Bench-TestSet-1_clean.claim_min1max30.json # data of ACI-BENCH-test1 with generated reference claims ├── ACI-Bench-TestSet-1_clean.json # data of ACI-BENCH-test1 ├── meqsum-test_clean.json # data of MeQSum-test ├── mimic-sampled200_clean.json # data of MIMIC (the 200 test examples sampled by proportion of different splits) └── mimic-sampled200_clean.claim_min1max30.json # data of MIMIC (200 samples) with generated reference claims The .claim_min1max30.json files contain the reference subclaims we generated.

 

Run Medical Text Generation

To run text generation, you'll need to call the run.py file. This will follow the instructions in the prompt file and generate a piece of text based on the input text of each example.

We provide several example scripts unser scripts/ named run_DATASET.sh or run_DATASET_0shot.sh. For example, bash scripts/run_mimic.sh $CONFIG_FILE We provide several example config files under configs/ Note that for ACI-BENCH, we provide scripts for both full-note generation (e.g., scripts/run_acibench_full.sh) and per-section generation (e.g., scripts/run_acibench_persection.sh).

 

Evaluation with DocLens

The scripts for evaluation are similar to evaluating your own text. For example: bash scripts/eval_mimic_api.sh $SAVENAME and bash scripts/eval_mimic_model.sh $SAVENAME $EVAL_MODEL

Owner

  • Name: Yiqing Xie
  • Login: yiqingxyq
  • Kind: user
  • Company: HKUST | UIUC | CMU

PhD @CMU-LTI

Citation (citation_evaluation/eval_citation.py)

import argparse
import os
import json
import time
from tqdm import tqdm
from copy import deepcopy
import numpy as np
import re

import openai
import openai.error

from nltk import sent_tokenize


SECTION_DIVISIONS = ['subjective', 'objective_exam', 'objective_results', 'assessment_and_plan']

def remove_citations(sent):
    return re.sub(r"\[\d+", "", re.sub(r" \[\d+", "", sent)).replace(" |", "").replace("]", "")

def completion_with_backoff(**kwargs):
    is_ok = False
    retry_count = 0
    while not is_ok:
        retry_count += 1
        try:
            response = openai.ChatCompletion.create(**kwargs)
            is_ok = True
        except openai.error.RateLimitError as error:
            if retry_count <= 30:
                if retry_count % 10 == 0:
                    print(f"OpenAI API retry for {retry_count} times ({error})")
                time.sleep(10)
                continue
            else:
                return {}
        except openai.error.InvalidRequestError as error:
            if 'maximum context length' in error._message:
                if retry_count <= 3:
                    print(f"reduce max_tokens by 500")
                    kwargs['max_tokens'] = kwargs['max_tokens'] - 500
                    continue
                else:
                    print(error)
                    return {}
            else:
                print(error)
                return {}
        except Exception as error:
            print(error)
            return {}
    return response


if __name__ == "__main__":
    parser = argparse.ArgumentParser()
    # data
    parser.add_argument('--result_file', required=True, help='filename of the system-generated outputs.')
    parser.add_argument("--dataset_name", type=str, default=None, help="Name of the dataset")
    
    # evaluation setting
    parser.add_argument("--split_method", type=str, choices=['sent', 'citation'], help="Split the generation output by sent/citation idx")
    parser.add_argument("--max_citation_num", type=int, default=10)
    parser.add_argument("--get_persection_score", action="store_true", default=False, help="Compute the scores for each section")
    
    # evaluation model
    parser.add_argument('--prompt_file', required=True, help='filename of the prompt dict .json.')
    parser.add_argument("--azure", action="store_true", default=False, help="Azure openai API")
    parser.add_argument("--max_new_tokens", type=int, default=2000, help="Max number of new tokens to generate in one step")
    
    args = parser.parse_args()
    
    result_file, dataset_name, split_method, max_citation_num, prompt_file, max_new_tokens = args.result_file, args.dataset_name, args.split_method, args.max_citation_num, args.prompt_file, args.max_new_tokens
    savefile = result_file.replace('.json', '.citations.score')
    
    # API setup 
    if args.azure:
        openai.api_base = os.environ.get("OPENAI_API_BASE")
        openai.api_key = os.environ.get("OPENAI_API_KEY")
        openai.api_type = "azure"
        openai.api_version = "2023-05-15" 
        EVALUATOR_NAME = EVALUATOR_DEPLOY_NAME = "gpt-4-1106-preview"
        # EVALUATOR_NAME = EVALUATOR_DEPLOY_NAME = "gpt-35-turbo"
    else:
        openai.api_base = "https://api.openai.com/v1"
        openai.api_key = os.environ.get("OPENAI_API_KEY")
        EVALUATOR_NAME = "gpt-4-1106-preview"
    
    if not args.get_persection_score:
        SECTION_DIVISIONS = ['full']
        
    output_data = json.load(open(result_file, 'r')) # a list of dicts
    
    print( f"Saving scores to {savefile.split('/')[-1]}..") # {section: {eid_str: [{"send_id": "", "output": "", ... "entailment_prediction": 0 or 1}, ...]} }
        
    if os.path.exists(savefile):
        print('Save file exist!')
        citations_score = json.load(open(savefile, 'r'))
    else:
        citations_score = {}
        for section in SECTION_DIVISIONS:
            citations_score[section] = {}
            for x in output_data:
                eid_str = str(x['example_id'])
                citations_score[section][eid_str] = []
    
    TEXT_NAME = {
        'acibench': {'output_sent_name': 'sentence_in_note', 'cited_input_name': 'conversational_turns'},
        'mimic': {'output_sent_name': 'sentence_in_summary', 'cited_input_name': 'sentences_in_the_radiology_report'},
        'meqsum': {'output_sent_name': 'short_question', 'cited_input_name': 'sentences_in_the_long_question'},
    }
    
    # run entailment
    wrong_format_count = 0
    wrong_entailment_count = 0
    sent_count = 0
    new_generation_count = 0
    for section in SECTION_DIVISIONS:
        if args.get_persection_score:
            output_key = f'output_{section}'
            prompt_template = json.load(open(prompt_file.replace('persection', section), 'r'))
        else:
            output_key = 'output'
            prompt_template = json.load(open(prompt_file, 'r'))
            
        for i in range(1,len(prompt_template)-1):
            prompt_template[i]['content'] = json.dumps(prompt_template[i]['content'])
            
        if dataset_name in TEXT_NAME:
            output_sent_name, cited_input_name = TEXT_NAME[dataset_name]["output_sent_name"], TEXT_NAME[dataset_name]["cited_input_name"]
        else:
            output_sent_name, cited_input_name = "generated_sentence", "sentence_in_clinical_report"
        
        for item in output_data:
            eid_str, input_text, output_text = str(item['example_id']), item['input'], item[output_key]
                
            if output_text == "":
                # skip empty note
                citations_score[section][eid_str] = []
                continue
            
            # preprocess input (split output note into sents, split input_text by idx)
            if dataset_name == 'meqsum':
                # only one sent in the generation output
                sents = [output_text]
            elif split_method == 'sent':
                sents = sent_tokenize(output_text)
            elif split_method == 'citation':
                clean_sents = re.split("[\[\d+\]]+", output_text)[:-1] # remove the last split without citations
                citations = re.findall("[\[\d+\]]+", output_text)
                sents = [s+c for s,c in zip(clean_sents, citations)]
                if len(sents) == 1:
                    print('Citation not found')
                    wrong_format_count += 1
                    sent_count += 1
                    citations_score[section][eid_str] = [{
                        "sent_id": 0,
                        "output": "",
                        "citations": [],
                        "cited_sents": [],
                        "entailment_prediction": 0,
                        "explanation": "",
                        "provenance": [],
                    }]
                    
                    continue
                    
            sents = [" ".join(s.split()) for s in sents] # output sents w/ citations
            target_sents = [remove_citations(sent) for sent in sents]
            
            # split input text by citations
            input_sents = re.split("\[\d+\]", input_text)[1:] # the sent is after its citation idx
            citations = re.findall("\[\d+\]", input_text)
            input_sents = [" ".join(s.split()) for s in input_sents]
            docs = {int(citation[1:-1]): sent for sent, citation in zip(input_sents, citations)}
            
            # run entailment
            sent_count += len(sents)
            new_gen_flag = False

            if len(citations_score[section][eid_str]) < len(sents):
                citations_score[section][eid_str] = [{} for _ in sents]
                
            for sent_id, sent in enumerate(sents):
                if "entailment_prediction" in citations_score[section][eid_str][sent_id]:
                    continue
                
                new_gen_flag = True
                
                target_sent = target_sents[sent_id] # The output sent

                # Find references
                ref = [int(r[1:]) for r in re.findall(r"\[\d+", sent)] # In our setting the citation starts from 0
                ref = list(set(ref)) # there could be repeated ref
                print('-'*20, f'eid_str: {eid_str}, Sentence idx: {sent_id}', '-'*20)
                print(f"For `{sent}`, find citations {ref}")
                
                if len(ref) == 0:
                    # No citations
                    # Reach the next citation
                    for next_sent_id in range(sent_id+1, len(sents)):
                        next_sent = sents[next_sent_id]
                        next_target_sent = target_sents[next_sent_id]
                        ref = [int(r[1:]) for r in re.findall(r"\[\d+", next_sent)]
                        if len(ref) > 0:
                            break
                    print(f"For `{sent}`, find citations {ref}")
                
                if len(ref) == 0 or any([ref_id >= len(docs) for ref_id in ref]):
                    # No citations or Citations out of range
                    print(f"Invalid citation format: {ref}")
                    wrong_format_count += 1
                    citations_score[section][eid_str][sent_id] = {
                        "sent_id": sent_id,
                        "output": sent,
                        "citations": ref,
                        "cited_sents": [],
                        "entailment_prediction": 0,
                        "explanation": "",
                        "provenance": [],
                    }
                    
                    continue
                    
                ref = ref[:args.max_citation_num]

                # compute citation scores 
                if dataset_name == 'acibench':
                    joint_passage = []
                    for psgs_id in ref:
                        speaker = re.findall(r"\[[a-z,\s,_]+\]", docs[psgs_id])[0][1:-1]
                        content = re.sub(r"\[[a-z,\s,_]+\] ", "", docs[psgs_id])
                        joint_passage.append({
                            "idx": str(psgs_id),
                            "speaker": speaker,
                            "content": content
                        })
                else:
                    joint_passage = []
                    for psgs_id in ref:
                        joint_passage.append({
                            "idx": str(psgs_id),
                            "content": docs[psgs_id]
                        })
                    
                print(joint_passage)
                
                prompt = deepcopy(prompt_template)
                prompt[-1]['content'] = json.dumps({
                    output_sent_name: target_sent,
                    cited_input_name: joint_passage
                })
                
                if args.azure:
                    response = completion_with_backoff(
                        engine=EVALUATOR_DEPLOY_NAME, model=EVALUATOR_NAME, messages=prompt, max_tokens=max_new_tokens
                    )
                else:
                    response = completion_with_backoff(
                        model=EVALUATOR_NAME, messages=prompt, max_tokens=max_new_tokens
                    )
                
                if len(response) == 0:
                    citations_score[section][eid_str][sent_id] = {
                        "sent_id": sent_id,
                        "output": sent,
                        "citations": ref,
                        "cited_sents": joint_passage,
                        "response": "",
                    }
                    print('No response from the evaluator model')
                    wrong_entailment_count += 1
                    
                    continue
                else:
                    response_content = response['choices'][0]['message']['content']
                
                try:
                    response_dict = json.loads(response_content) # entailment_prediction, explanation, provenance
                    print(json.dumps(response_dict, indent=4))
                    
                    response_dict.update({
                        "sent_id": sent_id,
                        "output": sent,
                        "citations": ref,
                        "cited_sents": joint_passage,
                        "entailment_prediction": response_dict['entailment_prediction'],
                        "explanation": response_dict['explanation'],
                        "provenance": response_dict['provenance'],
                    })
                    
                    citations_score[section][eid_str][sent_id] = response_dict
                except:
                    wrong_entailment_count += 1
                    print('!'*10, 'Cannot convert to json format', '!'*10)
                    print(response_content)
                    citations_score[section][eid_str][sent_id] = {
                        "sent_id": sent_id,
                        "output": sent,
                        "citations": ref,
                        "cited_sents": joint_passage,
                        "response": response_content,
                    }
            
            new_generation_count += int(new_gen_flag)
            if new_gen_flag and new_generation_count % 3 == 0:
                print('Saving results..')
                json.dump(citations_score, open(savefile, 'w'), indent=4, sort_keys=True)

    # save results
    json.dump(citations_score, open(savefile, 'w'), indent=4, sort_keys=True)
    
    print(f"Wrong format count: {wrong_format_count}/{sent_count}")
    print(f"Wrong entailment count: {wrong_entailment_count}/{sent_count}")

GitHub Events

Total
  • Issues event: 2
  • Watch event: 9
  • Issue comment event: 1
Last Year
  • Issues event: 2
  • Watch event: 9
  • Issue comment event: 1