evalscope 1.0.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

evalscope/benchmarks/multi_if/metrics.py

@@ -0,0 +1,120 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from typing import Any, Dict, List, Optional, Tuple
+
+from evalscope.utils import get_logger
+from . import ifeval
+
+logger = get_logger()
+
+
+def gen_acc_strict(x: Dict[str, Any]) -> Dict[str, List]:
+    # reference: fbcode/gen_ai/github/fair_evals/evals/tasks/finetune/ifeval.py
+    response = str(x['response'])
+    instruction_list = x['instruction_id_list']
+    is_following_list = []
+    for index, instruction_id in enumerate(instruction_list):
+        instruction_cls = ifeval.INSTRUCTION_DICT[instruction_id]
+        instruction = instruction_cls(instruction_id)
+
+        instruction.build_description(**x['kwargs'][index])
+        if response and instruction.check_following(response):
+            is_following_list.append(True)
+        else:
+            is_following_list.append(False)
+
+    return {
+        'follow_instruction_list': is_following_list,
+        'instruction_id_list': instruction_list,
+    }
+
+
+def gen_acc_loose(x: Dict[str, Any]) -> Dict[str, List]:
+    response = str(x['response'])
+    r = response.split('\n')
+    response_remove_first = '\n'.join(r[1:]).strip()
+    response_remove_last = '\n'.join(r[:-1]).strip()
+    response_remove_both = '\n'.join(r[1:-1]).strip()
+    revised_response = response.replace('*', '')
+    revised_response_remove_first = response_remove_first.replace('*', '')
+    revised_response_remove_last = response_remove_last.replace('*', '')
+    revised_response_remove_both = response_remove_both.replace('*', '')
+    all_responses = [
+        response,
+        revised_response,
+        response_remove_first,
+        response_remove_last,
+        response_remove_both,
+        revised_response_remove_first,
+        revised_response_remove_last,
+        revised_response_remove_both,
+    ]
+    instruction_list = x['instruction_id_list']
+    is_following_list = []
+    for index, instruction_id in enumerate(instruction_list):
+        instruction_cls = ifeval.INSTRUCTION_DICT[instruction_id]
+        instruction = instruction_cls(instruction_id)
+
+        instruction.build_description(**x['kwargs'][index])
+
+        is_following = False
+        for r in all_responses:  # type: ignore
+            if r.strip() and instruction.check_following(r):  # type: ignore
+                is_following = True
+                break
+
+        is_following_list.append(is_following)
+    return {
+        'follow_instruction_list': is_following_list,
+        'instruction_id_list': instruction_list,
+    }
+
+
+def parse_result(outputs: List[Dict[str, Any]]) -> Tuple[float, float]:
+
+    prompt_total = 0
+    prompt_correct = 0
+    instruction_total = 0
+    instruction_correct = 0
+
+    for example in outputs:
+        follow_instruction_list = example['follow_instruction_list']
+        instruction_id_list = example['instruction_id_list']
+
+        prompt_total += 1
+        if all(follow_instruction_list):
+            prompt_correct += 1
+
+        instruction_total += len(instruction_id_list)
+        instruction_correct += sum(follow_instruction_list)
+
+    return prompt_correct / prompt_total if prompt_total > 0 else 0, \
+        instruction_correct / instruction_total if instruction_total > 0 else 0
+
+
+def parse_result_no_reduce(outputs: List[Dict[str, Any]]) -> Tuple[List, List]:
+
+    prompt_res = []
+    inst_res = []
+
+    for example in outputs:
+        follow_instruction_list = example['follow_instruction_list']
+        instruction_id_list = example['instruction_id_list']
+        if all(follow_instruction_list):
+            prompt_res.append(1)
+        else:
+            prompt_res.append(0)
+        inst_res.append(sum(follow_instruction_list) / len(instruction_id_list) if instruction_id_list else 0.0)
+
+    return prompt_res, inst_res

evalscope/benchmarks/multi_if/multi_if_adapter.py

@@ -0,0 +1,161 @@
+import json
+from typing import Any, Dict, List
+
+from evalscope.api.benchmark import BenchmarkMeta, DefaultDataAdapter
+from evalscope.api.dataset import Sample
+from evalscope.api.evaluator import TaskState
+from evalscope.api.messages import ChatMessageUser, messages_pretty_str
+from evalscope.api.metric import Score
+from evalscope.api.model import Model
+from evalscope.api.registry import register_benchmark
+from evalscope.constants import Tags
+from evalscope.utils.import_utils import check_import
+from evalscope.utils.logger import get_logger
+
+logger = get_logger()
+
+SUBSET_LIST = [
+    'Chinese',
+    'English',
+    'German',
+    'Italian',
+    'Vietnamese',
+    'Spanish',
+    'Hindi',
+    'Portuguese',
+    'French',
+    'Thai',
+    'Russian',
+]
+
+
+@register_benchmark(
+    BenchmarkMeta(
+        name='multi_if',
+        pretty_name='Multi-IF',
+        description=
+        'Multi-IF is a benchmark designed to evaluate the performance of LLM models\' capabilities in multi-turn instruction following within a multilingual environment.',  # noqa: E501
+        tags=[Tags.INSTRUCTION_FOLLOWING, Tags.MULTI_LINGUAL, Tags.MULTI_TURN],
+        dataset_id='facebook/Multi-IF',
+        subset_list=SUBSET_LIST,
+        metric_list=[
+            'prompt_level_strict',
+            'inst_level_strict',
+            'prompt_level_loose',
+            'inst_level_loose',
+        ],
+        few_shot_num=0,
+        train_split=None,
+        eval_split='train',
+        extra_params={
+            'max_turns': 3,  # maximum number of turns to evaluate
+        }
+    )
+)
+class MultiIFAdapter(DefaultDataAdapter):
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+        # Ensure required packages are installed
+        check_import(
+            module_name=['nltk', 'langdetect'],
+            package=['nltk', 'langdetect'],
+            raise_error=True,
+            feature_name=self.pretty_name
+        )
+        if 'Chinese' in self.subset_list:
+            check_import(module_name='emoji', package='emoji', raise_error=True, feature_name='Chinese subset')
+        if 'Thai' in self.subset_list:
+            check_import(module_name='pythainlp', package='pythainlp', raise_error=True, feature_name='Thai subset')
+
+        self.reformat_subset = True
+        self.max_turns = self.extra_params.get('max_turns', 3)
+        if not isinstance(self.max_turns, int) or self.max_turns < 1 or self.max_turns > 3:
+            logger.warning(f'max_turns should be an integer between 1 and 3, got {self.max_turns}, clamping to 3.')
+            self.max_turns = 3
+
+    def record_to_sample(self, record: Dict[str, Any]) -> Sample:
+        return Sample(
+            input=[ChatMessageUser(content='')],  # NOTE: we will build the multi turn conversation in the evaluator
+            target='',
+            subset_key=record['language'],
+            metadata=record,
+        )
+
+    def run_inference(self, model: Model, sample: Sample, output_dir: str, **kwargs) -> TaskState:
+        """
+        Run multi-turn inference with the model and sample.
+        """
+        record = sample.metadata
+        history = []
+        step_record = {}
+        for step in range(1, self.max_turns + 1):
+            current_prompt = json.loads(record[f'turn_{step}_prompt'])
+            history.append(ChatMessageUser(content=current_prompt['content']))
+            # Generate model output
+            model_output = model.generate(input=history, tools=sample.tools)
+
+            response = model_output.completion
+            instruction_id_list = json.loads(record[f'turn_{step}_instruction_id_list'])
+            kwargs_list = json.loads(record[f'turn_{step}_kwargs'])
+            _kwargs = [json.loads(kwarg) for kwarg in kwargs_list]
+
+            step_record[step] = {
+                'prompt': messages_pretty_str(history),
+                'response': response,
+                'instruction_id_list': instruction_id_list,
+                'kwargs': _kwargs
+            }
+
+            # Append model output to history for next turn
+            history.append(model_output.message)
+
+        sample.metadata['step_record'] = step_record
+        return TaskState(
+            model=model.name,
+            sample=sample,
+            messages=history,
+            output=model_output,
+            completed=True,
+        )
+
+    def match_score(
+        self, original_prediction: str, filtered_prediction: str, reference: Dict, task_state: TaskState
+    ) -> Score:
+        """
+        Calculate evaluation scores by comparing prediction with reference.
+        """
+        from .metrics import gen_acc_loose, gen_acc_strict, parse_result
+
+        # Initialize the score object with prediction details
+        score = Score(
+            extracted_prediction=filtered_prediction,
+            prediction=original_prediction,
+        )
+
+        step_record = task_state.metadata['step_record']
+        results = {}
+        try:
+            for step, record in step_record.items():
+                outputs_strict = gen_acc_strict(record)
+                outputs_loose = gen_acc_loose(record)
+                prompt_level_strict, inst_level_strict = parse_result([outputs_strict])
+                prompt_level_loose, inst_level_loose = parse_result([outputs_loose])
+                results.update({
+                    f'turn_{step}_prompt_level_strict': prompt_level_strict,
+                    f'turn_{step}_inst_level_strict': inst_level_strict,
+                    f'turn_{step}_prompt_level_loose': prompt_level_loose,
+                    f'turn_{step}_inst_level_loose': inst_level_loose,
+                })
+            score.value.update(results)
+
+            # Set main score name
+            if results:
+                score.main_score_name = f'turn_{step}_prompt_level_strict'
+
+        except Exception as e:
+            logger.error(f'Error calculating ifeval metrics: {e}')
+            score.value = {}
+
+        return score

evalscope/benchmarks/needle_haystack/needle_haystack_adapter.py

@@ -73,6 +73,7 @@ class NeedleHaystackAdapter(DefaultDataAdapter):
         super().__init__(**kwargs)
 
         self._use_llm_judge = True
+        self.add_aggregation_name = False  # Don't add aggregation name for needle haystack adapter
         # set extra params
         self.retrieval_question = self.extra_params.get(
             'retrieval_question', 'What is the best thing to do in San Francisco?'
@@ -359,10 +360,6 @@ class NeedleHaystackAdapter(DefaultDataAdapter):
 
         return score
 
-    def _on_generate_report(self, scores, model_name, add_aggregation_name=True):
-        # Don't add aggregation name for needle haystack adapter
-        return super()._on_generate_report(scores, model_name, False)
-
     def _on_generate_report_end(self, report: 'Report', output_dir: str, **kwargs):
         try:
             import os

evalscope/benchmarks/ocr_bench/ocr_bench_adapter.py

@@ -0,0 +1,101 @@
+import json
+from typing import Any, Dict, List
+
+from evalscope.api.benchmark import BenchmarkMeta, VisionLanguageAdapter
+from evalscope.api.dataset import Sample
+from evalscope.api.evaluator.state import TaskState
+from evalscope.api.messages import ChatMessageUser, Content, ContentImage, ContentText
+from evalscope.api.metric.scorer import Score
+from evalscope.api.registry import register_benchmark
+from evalscope.constants import Tags
+from evalscope.utils.io_utils import bytes_to_base64
+from evalscope.utils.logger import get_logger
+
+logger = get_logger()
+
+SUBSET_LIST = [
+    'Regular Text Recognition', 'Irregular Text Recognition', 'Artistic Text Recognition', 'Handwriting Recognition',
+    'Digit String Recognition', 'Non-Semantic Text Recognition', 'Scene Text-centric VQA', 'Doc-oriented VQA',
+    'Key Information Extraction', 'Handwritten Mathematical Expression Recognition'
+]
+
+
+@register_benchmark(
+    BenchmarkMeta(
+        name='ocr_bench',
+        pretty_name='OCRBench',
+        tags=[Tags.MULTI_MODAL, Tags.KNOWLEDGE, Tags.QA],
+        description=
+        'OCRBench is a comprehensive evaluation benchmark designed to assess the OCR capabilities of Large Multimodal Models. It comprises five components: Text Recognition, SceneText-Centric VQA, Document-Oriented VQA, Key Information Extraction, and Handwritten Mathematical Expression Recognition. The benchmark includes 1000 question-answer pairs, and all the answers undergo manual verification and correction to ensure a more precise evaluation.',  # noqa: E501
+        dataset_id='evalscope/OCRBench',
+        subset_list=SUBSET_LIST,
+        metric_list=['acc'],
+        eval_split='test',
+        prompt_template='{question}',
+    )
+)
+class OCRBenchAdapter(VisionLanguageAdapter):
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.add_aggregation_name = False
+        self.reformat_subset = True
+
+    def record_to_sample(self, record: Dict[str, Any]) -> Sample:
+
+        input_text = self.prompt_template.format(question=record['question'])
+        content_list: List[Content] = [ContentText(text=input_text)]
+        image = record.get('image')
+        if image:
+            image_base64 = bytes_to_base64(image['bytes'], format='jpeg', add_header=True)
+            content_list.append(ContentImage(image=image_base64))
+        return Sample(
+            input=[ChatMessageUser(content=content_list)],
+            target=json.dumps(record.get('answer'), ensure_ascii=False),  # answers is a list
+            subset_key=record.get('question_type'),
+            metadata={
+                'dataset': record.get('dataset'),
+                'question_type': record.get('question_type'),
+            }
+        )
+
+    def match_score(
+        self, original_prediction: str, filtered_prediction: str, reference: str, task_state: TaskState
+    ) -> Score:
+
+        score = Score(
+            extracted_prediction=filtered_prediction,
+            prediction=original_prediction,
+        )
+
+        pred = filtered_prediction.lower().strip()
+        gt_ans = json.loads(reference)
+        dataset_name = task_state.metadata['dataset']
+
+        score_value = 0
+        if dataset_name == 'HME100k':
+            if isinstance(gt_ans, list):
+                for j in range(len(gt_ans)):
+                    answer = gt_ans[j].strip().replace('\n', ' ').replace(' ', '')
+                    predict = pred.strip().replace('\n', ' ').replace(' ', '')
+                    if answer in predict:
+                        score_value = 1
+            else:
+                answer = gt_ans.strip().replace('\n', ' ').replace(' ', '')
+                predict = pred.strip().replace('\n', ' ').replace(' ', '')
+                if answer in predict:
+                    score_value = 1
+        else:
+            if isinstance(gt_ans, list):
+                for j in range(len(gt_ans)):
+                    answer = gt_ans[j].lower().strip().replace('\n', ' ')
+                    predict = pred.lower().strip().replace('\n', ' ')
+                    if answer in predict:
+                        score_value = 1
+            else:
+                answer = gt_ans.lower().strip().replace('\n', ' ')
+                predict = pred.lower().strip().replace('\n', ' ')
+                if answer in predict:
+                    score_value = 1
+        score.value = {'acc': score_value}
+        return score

evalscope/benchmarks/ocr_bench_v2/IoUscore_metric.py

@@ -0,0 +1,87 @@
+# flake8: noqa
+import ast
+import re
+
+from .vqa_metric import vqa_evaluation
+
+
+def calculate_iou(box1, box2):
+    try:
+        box1 = [int(coordinate) for coordinate in box1]
+        box2 = [int(coordinate) for coordinate in box2]
+    except:
+        return 0
+
+    x1_inter = max(box1[0], box2[0])
+    y1_inter = max(box1[1], box2[1])
+    x2_inter = min(box1[2], box2[2])
+    y2_inter = min(box1[3], box2[3])
+
+    inter_area = max(0, x2_inter - x1_inter) * max(0, y2_inter - y1_inter)
+
+    box1_area = (box1[2] - box1[0]) * (box1[3] - box1[1])
+    box2_area = (box2[2] - box2[0]) * (box2[3] - box2[1])
+
+    union_area = box1_area + box2_area - inter_area
+
+    iou = inter_area / union_area if union_area != 0 else 0
+
+    return iou
+
+
+def vqa_with_position_evaluation(predict, img_metas):
+    score_content, score_bbox = 0.0, 0.0
+    if 'answer' in predict.keys():
+        score_content = vqa_evaluation(predict['answer'], img_metas['answers'])
+    if 'bbox' in predict.keys():
+        gt_bbox = img_metas['bbox']
+        try:
+            predict_bbox_list = ast.literal_eval(predict['bbox'])
+            score_bbox = calculate_iou(predict_bbox_list, gt_bbox)
+        except:
+            score_bbox = 0
+    return 0.5 * score_content + 0.5 * score_bbox
+
+
+def extract_coordinates(text):
+    # Regex pattern to match coordinates in either (x1, y1, x2, y2) or [x1, y1, x2, y2] format
+
+    pattern = r'[\(\[]\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*[\)\]]'
+
+    matches = list(re.finditer(pattern, text))
+    coords_list = []
+    coords_set = set()
+    for match in matches:
+        x1, y1, x2, y2 = map(int, match.groups())
+
+        if all(0 <= n <= 1000 for n in [x1, y1, x2, y2]):
+            coords = (x1, y1, x2, y2)
+
+            if coords in coords_set:
+                coords_list = [c for c in coords_list if c != coords]
+
+            coords_list.append(coords)
+            coords_set.add(coords)
+    if coords_list:
+        last_coords = coords_list[-1]
+        return list(last_coords)
+    else:
+        return None
+
+
+if __name__ == '__main__':
+    print('Example for Text Grounding task.')
+    box1 = [50, 50, 150, 150]
+    box2 = [60, 60, 140, 140]
+    iou_score = calculate_iou(box1, box2)
+    print(f'IoU score: {iou_score}')
+
+    print('Example for VQA with position task.')
+    pred = {'content': 'The content is Hello Buddies', 'bbox': box1}
+    gt = {'content': 'Hello Buddies', 'bbox': box2}
+
+    vqa_score = vqa_evaluation(pred['content'], gt['content'])
+    iou_score = calculate_iou(pred['bbox'], gt['bbox'])
+
+    print(f'VQA score: {vqa_score}')
+    print(f'IoU score: {iou_score}')