__init__.py 10 KB
Newer Older
1
import os
lintangsutawika's avatar
lintangsutawika committed
2
import yaml
3
from typing import List, Union, Dict
&'s avatar
& committed
4

5
from lm_eval import utils
6
from lm_eval import prompts
7
from lm_eval.api.task import TaskConfig, Task, ConfigurableTask
lintangsutawika's avatar
lintangsutawika committed
8
from lm_eval.api.registry import (
9
10
    register_task,
    register_group,
lintangsutawika's avatar
lintangsutawika committed
11
12
    TASK_REGISTRY,
    GROUP_REGISTRY,
haileyschoelkopf's avatar
haileyschoelkopf committed
13
    ALL_TASKS,
lintangsutawika's avatar
lintangsutawika committed
14
)
lintangsutawika's avatar
lintangsutawika committed
15

lintangsutawika's avatar
lintangsutawika committed
16
import logging
lintangsutawika's avatar
lintangsutawika committed
17

lintangsutawika's avatar
lintangsutawika committed
18
# import python tasks
lintangsutawika's avatar
lintangsutawika committed
19
from .squadv2.task import SQuAD2
lintangsutawika's avatar
lintangsutawika committed
20
21
22
23
24
25
26
27
from .scrolls.task import (
    QuALITY,
    NarrativeQA,
    ContractNLI,
    GovReport,
    SummScreenFD,
    QMSum,
)
lintangsutawika's avatar
lintangsutawika committed
28

29
eval_logger = utils.eval_logger
30

lintangsutawika's avatar
lintangsutawika committed
31

32
def register_configurable_task(config: Dict[str, str]) -> int:
33
34
35
36
37
38
39
40
41
42
43
    SubClass = type(
        config["task"] + "ConfigurableTask",
        (ConfigurableTask,),
        {"CONFIG": TaskConfig(**config)},
    )

    if "task" in config:
        task_name = "{}".format(config["task"])
        register_task(task_name)(SubClass)

    if "group" in config:
baberabb's avatar
baberabb committed
44
45
46
        if config["group"] == config["task"]:
            raise ValueError("task and group name cannot be the same")
        elif type(config["group"]) == str:
47
48
49
50
51
52
53
54
55
            group_name = [config["group"]]
        else:
            group_name = config["group"]

        for group in group_name:
            register_group(group)(SubClass)

    return 0

lintangsutawika's avatar
format  
lintangsutawika committed
56

lintangsutawika's avatar
lintangsutawika committed
57
def register_configurable_group(config: Dict[str, str], yaml_path: str = None) -> int:
58
59
    group = config["group"]
    all_task_list = config["task"]
lintangsutawika's avatar
format  
lintangsutawika committed
60
61
    config_list = [task for task in all_task_list if type(task) != str]
    task_list = [task for task in all_task_list if type(task) == str]
62
63

    for task_config in config_list:
64
65
66
67
68
69
70
71
72
73
74

        base_config = {}
        task_name_config = {}
        if "task" in task_config:
            task_name = task_config["task"]
            if task_name in ALL_TASKS:
                task_obj = get_task_dict(task_name)[task_name]
                if type(task_obj) == tuple:
                    _, task_obj = task_obj

                if task_obj is not None:
Lintang Sutawika's avatar
Lintang Sutawika committed
75
                    base_config = task_obj._config.to_dict(keep_callable=True)
76
77
                    task_name_config["task"] = f"{group}_{task_name}"

lintangsutawika's avatar
lintangsutawika committed
78
        task_config = utils.load_yaml_config(yaml_path, task_config)
79
80
        var_configs = check_prompt_config(
            {
81
                **base_config,
82
83
                **task_config,
                **{"group": group},
84
                **task_name_config,
lintangsutawika's avatar
lintangsutawika committed
85
86
            },
            yaml_path=os.path.dirname(yaml_path),
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
        )
        for config in var_configs:
            register_configurable_task(config)

    task_names = utils.pattern_match(task_list, ALL_TASKS)
    for task in task_names:
        if (task in TASK_REGISTRY) or (task in GROUP_REGISTRY):
            if group in GROUP_REGISTRY:
                GROUP_REGISTRY[group].append(task)
            else:
                GROUP_REGISTRY[group] = [task]
                ALL_TASKS.add(group)

    return 0

102

lintangsutawika's avatar
lintangsutawika committed
103
104
105
def check_prompt_config(
    config: Dict[str, str], yaml_path: str = None
) -> List[Dict[str, str]]:
106
107
108
109
110
    all_configs = []
    if "use_prompt" in config:
        prompt_list = prompts.load_prompt_list(
            use_prompt=config["use_prompt"],
            dataset_name=config["dataset_path"],
lintangsutawika's avatar
lintangsutawika committed
111
            subset_name=config["dataset_name"] if "dataset_name" in config else None,
lintangsutawika's avatar
lintangsutawika committed
112
            yaml_path=yaml_path,
113
114
115
116
117
118
119
120
        )
        for idx, prompt_variation in enumerate(prompt_list):
            all_configs.append(
                {
                    **config,
                    **{"use_prompt": prompt_variation},
                    **{
                        "task": "_".join(
121
122
123
124
                            [
                                config["task"]
                                if "task" in config
                                else get_task_name_from_config(config),
lintangsutawika's avatar
lintangsutawika committed
125
126
127
                                prompt_variation.split("/")[-1]
                                if ".yaml" in prompt_variation
                                else prompt_variation,
128
129
130
                            ]
                        )
                    },
131
                    **{"output_type": "generate_until"},
132
133
134
135
136
137
138
                }
            )
    else:
        all_configs.append(config)
    return all_configs


139
def get_task_name_from_config(task_config: Dict[str, str]) -> str:
Lintang Sutawika's avatar
Lintang Sutawika committed
140
    if "dataset_name" in task_config:
Lintang Sutawika's avatar
Lintang Sutawika committed
141
142
143
        return "{dataset_path}_{dataset_name}".format(**task_config)
    else:
        return "{dataset_path}".format(**task_config)
144
145


lintangsutawika's avatar
lintangsutawika committed
146
def include_task_folder(task_dir: str, register_task: bool = True) -> None:
147
148
149
    """
    Calling this function
    """
150
151
152

    # Track whether any tasks failed during loading
    import_fail = False
153
    for root, subdirs, file_list in os.walk(task_dir):
154
155
156
157
158
159
160
        # if (subdirs == [] or subdirs == ["__pycache__"]) and (len(file_list) > 0):
        for f in file_list:
            if f.endswith(".yaml"):
                yaml_path = os.path.join(root, f)
                try:
                    config = utils.load_yaml_config(yaml_path)

lintangsutawika's avatar
lintangsutawika committed
161
162
                    if "task" not in config:
                        continue
lintangsutawika's avatar
lintangsutawika committed
163

lintangsutawika's avatar
lintangsutawika committed
164
165
166
167
168
169
170
171
172
173
                    all_configs = check_prompt_config(
                        config, yaml_path=os.path.dirname(yaml_path)
                    )
                    for config in all_configs:
                        if register_task:
                            if type(config["task"]) == str:
                                register_configurable_task(config)
                        else:
                            if type(config["task"]) == list:
                                register_configurable_group(config, yaml_path)
174

lintangsutawika's avatar
lintangsutawika committed
175
                # Log this silently and show it only when
176
                # the user defines the appropriate verbosity.
177
178
                except (ImportError, ModuleNotFoundError) as e:
                    import_fail = True
179
                    eval_logger.debug(
baberabb's avatar
baberabb committed
180
181
                        f"{yaml_path}: {e}. Config will not be added to registry."
                    )
182
                except Exception as error:
lintangsutawika's avatar
lintangsutawika committed
183
                    import traceback
lintangsutawika's avatar
lintangsutawika committed
184

185
186
                    eval_logger.warning(
                        "Unexpected error loading config in\n"
187
188
                        f"                                 {yaml_path}\n"
                        "                                 Config will not be added to registry\n"
lintangsutawika's avatar
lintangsutawika committed
189
190
                        f"                                 Error: {error}\n"
                        f"                                 Traceback: {traceback.format_exc()}"
191
                    )
192
193
194
195
196
197

    if import_fail:
        eval_logger.warning(
          "Some tasks could not be loaded due to missing dependencies."
          " Run with `--verbosity DEBUG` for full details."
          )
lintangsutawika's avatar
lintangsutawika committed
198
    return 0
199
200
201
202
203
204
205


def include_path(task_dir):
    include_task_folder(task_dir)
    # Register Benchmarks after all tasks have been added
    include_task_folder(task_dir, register_task=False)
    return 0
206

lintangsutawika's avatar
lintangsutawika committed
207

208
209
210
211
212
def initialize_tasks(verbosity="INFO"):
    eval_logger.setLevel(getattr(logging, f"{verbosity}"))

    task_dir = os.path.dirname(os.path.abspath(__file__)) + "/"
    include_path(task_dir)
lintangsutawika's avatar
lintangsutawika committed
213

lintangsutawika's avatar
lintangsutawika committed
214

215
216
def get_task(task_name, config):
    try:
217
        return TASK_REGISTRY[task_name](config=config)
218
    except KeyError:
lintangsutawika's avatar
lintangsutawika committed
219
        eval_logger.info("Available tasks:")
220
        eval_logger.info(list(TASK_REGISTRY) + list(GROUP_REGISTRY))
lintangsutawika's avatar
lintangsutawika committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
        raise KeyError(f"Missing task {task_name}")


def get_task_name_from_object(task_object):
    for name, class_ in TASK_REGISTRY.items():
        if class_ is task_object:
            return name

    # TODO: scrap this
    # this gives a mechanism for non-registered tasks to have a custom name anyways when reporting
    return (
        task_object.EVAL_HARNESS_NAME
        if hasattr(task_object, "EVAL_HARNESS_NAME")
        else type(task_object).__name__
    )


# TODO: pass num_fewshot and other cmdline overrides in a better way
239
def get_task_dict(task_name_list: List[Union[str, Dict, Task]], **kwargs):
lintangsutawika's avatar
lintangsutawika committed
240
    config = {**kwargs}
241
242
243
244
245

    task_name_from_registry_dict = {}
    task_name_from_config_dict = {}
    task_name_from_object_dict = {}

lintangsutawika's avatar
lintangsutawika committed
246
247
248
    if type(task_name_list) != list:
        task_name_list = [task_name_list]

249
250
251
    for task_element in task_name_list:
        if isinstance(task_element, str):
            if task_element in GROUP_REGISTRY:
252
                group_name = task_element
253
254
                for task_name in GROUP_REGISTRY[task_element]:
                    if task_name not in task_name_from_registry_dict:
lintangsutawika's avatar
lintangsutawika committed
255
256
257
258
259
260
261
262
263
264
265
                        task_obj = get_task_dict(task_name)
                        if task_name in task_obj.keys():
                            task_dict = {
                                task_name: (group_name, task_obj[task_name]),
                            }
                        else:
                            task_dict = {
                                task_name: (group_name, None),
                                **task_obj,
                            }

266
267
                        task_name_from_registry_dict = {
                            **task_name_from_registry_dict,
lintangsutawika's avatar
lintangsutawika committed
268
                            **task_dict,
lintangsutawika's avatar
lintangsutawika committed
269
                        }
270
            else:
271
                task_name = task_element
272
273
274
                if task_name not in task_name_from_registry_dict:
                    task_name_from_registry_dict = {
                        **task_name_from_registry_dict,
lintangsutawika's avatar
lintangsutawika committed
275
276
                        task_name: get_task(task_name=task_element, config=config),
                    }
277
278

        elif isinstance(task_element, dict):
279
            task_element.update(config)
280
281
282
            task_name_from_config_dict = {
                **task_name_from_config_dict,
                get_task_name_from_config(task_element): ConfigurableTask(
283
                    config=task_element
lintangsutawika's avatar
lintangsutawika committed
284
                ),
285
286
287
288
289
            }

        elif isinstance(task_element, Task):
            task_name_from_object_dict = {
                **task_name_from_object_dict,
lintangsutawika's avatar
lintangsutawika committed
290
                get_task_name_from_object(task_element): task_element,
291
            }
lintangsutawika's avatar
lintangsutawika committed
292
293
294
295

    assert set(task_name_from_registry_dict.keys()).isdisjoint(
        set(task_name_from_object_dict.keys())
    )
lintangsutawika's avatar
lintangsutawika committed
296
297
298
    return {
        **task_name_from_registry_dict,
        **task_name_from_config_dict,
299
        **task_name_from_object_dict,
lintangsutawika's avatar
lintangsutawika committed
300
    }