__init__.py 28.4 KB
Newer Older
1
import collections
2
import inspect
3
4
import logging
import os
5
from functools import partial
6
from typing import Dict, List, Mapping, Optional, Union
&'s avatar
& committed
7

8
from lm_eval import utils
Lintang Sutawika's avatar
Lintang Sutawika committed
9
from lm_eval.api.group import ConfigurableGroup, GroupConfig
10
from lm_eval.api.task import ConfigurableTask, Task
Lintang Sutawika's avatar
Lintang Sutawika committed
11
12
13
14
from lm_eval.evaluator_utils import get_subtask_list


GROUP_ONLY_KEYS = list(GroupConfig().to_dict().keys())
lintangsutawika's avatar
lintangsutawika committed
15

Lintang Sutawika's avatar
Lintang Sutawika committed
16
17
eval_logger = logging.getLogger(__name__)

18

19
20
21
class TaskManager:
    """TaskManager indexes all tasks from the default `lm_eval/tasks/`
    and an optional directory if provided.
22

23
24
    """

25
26
    def __init__(
        self,
Lintang Sutawika's avatar
Lintang Sutawika committed
27
        verbosity: Optional[str] = None,
28
29
        include_path: Optional[Union[str, List]] = None,
        include_defaults: bool = True,
Baber Abbasi's avatar
Baber Abbasi committed
30
        metadata: Optional[dict] = None,
31
    ) -> None:
Lintang Sutawika's avatar
Lintang Sutawika committed
32
33
        if verbosity is not None:
            utils.setup_logging(verbosity)
34
        self.include_path = include_path
Baber Abbasi's avatar
Baber Abbasi committed
35
        self.metadata = metadata
36
37
38
        self._task_index = self.initialize_tasks(
            include_path=include_path, include_defaults=include_defaults
        )
39
        self._all_tasks = sorted(list(self._task_index.keys()))
40

41
42
43
44
        self._all_groups = sorted(
            [x for x in self._all_tasks if self._task_index[x]["type"] == "group"]
        )
        self._all_subtasks = sorted(
45
46
47
48
49
            [
                x
                for x in self._all_tasks
                if self._task_index[x]["type"] in ["task", "python_task"]
            ]
50
51
52
53
54
        )
        self._all_tags = sorted(
            [x for x in self._all_tasks if self._task_index[x]["type"] == "tag"]
        )

55
        self.task_group_map = collections.defaultdict(list)
56

57
58
59
60
    def initialize_tasks(
        self,
        include_path: Optional[Union[str, List]] = None,
        include_defaults: bool = True,
Baber Abbasi's avatar
Baber Abbasi committed
61
62
    ) -> dict[str, dict]:
        """Creates a dictionary of tasks indexes.
63

64
65
66
67
68
        :param include_path: Union[str, List] = None
            An additional path to be searched for tasks recursively.
            Can provide more than one such path as a list.
        :param include_defaults: bool = True
            If set to false, default tasks (those in lm_eval/tasks/) are not indexed.
Baber Abbasi's avatar
Baber Abbasi committed
69
        return
70
71
            Dictionary of task names as key and task metadata
        """
72
73
74
75
        if include_defaults:
            all_paths = [os.path.dirname(os.path.abspath(__file__)) + "/"]
        else:
            all_paths = []
76
77
78
79
        if include_path is not None:
            if isinstance(include_path, str):
                include_path = [include_path]
            all_paths.extend(include_path)
80

81
82
83
84
        task_index = {}
        for task_dir in all_paths:
            tasks = self._get_task_and_group(task_dir)
            task_index = {**tasks, **task_index}
lintangsutawika's avatar
format  
lintangsutawika committed
85

86
87
88
89
90
91
        return task_index

    @property
    def all_tasks(self):
        return self._all_tasks

92
93
94
95
96
97
98
99
100
101
102
103
    @property
    def all_groups(self):
        return self._all_groups

    @property
    def all_subtasks(self):
        return self._all_subtasks

    @property
    def all_tags(self):
        return self._all_tags

104
105
106
107
    @property
    def task_index(self):
        return self._task_index

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
    def list_all_tasks(
        self, list_groups=True, list_tags=True, list_subtasks=True
    ) -> str:
        from pytablewriter import MarkdownTableWriter

        def sanitize_path(path):
            # don't print full path if we are within the lm_eval/tasks dir !
            # if we aren't though, provide the full path.
            if "lm_eval/tasks/" in path:
                return "lm_eval/tasks/" + path.split("lm_eval/tasks/")[-1]
            else:
                return path

        group_table = MarkdownTableWriter()
        group_table.headers = ["Group", "Config Location"]
        gt_values = []
        for g in self.all_groups:
            path = self.task_index[g]["yaml_path"]
            if path == -1:
                path = "---"
            else:
                path = sanitize_path(path)
            gt_values.append([g, path])
        group_table.value_matrix = gt_values

        tag_table = MarkdownTableWriter()
        tag_table.headers = ["Tag"]
        tag_table.value_matrix = [[t] for t in self.all_tags]

        subtask_table = MarkdownTableWriter()
        subtask_table.headers = ["Task", "Config Location", "Output Type"]
        st_values = []
        for t in self.all_subtasks:
            path = self.task_index[t]["yaml_path"]

            output_type = ""

            # read the yaml file to determine the output type
            if path != -1:
                config = utils.load_yaml_config(path, mode="simple")
                if "output_type" in config:
                    output_type = config["output_type"]
                elif (
                    "include" in config
                ):  # if no output type, check if there is an include with an output type
                    include_path = path.split("/")[:-1] + config["include"]
                    include_config = utils.load_yaml_config(include_path, mode="simple")
                    if "output_type" in include_config:
                        output_type = include_config["output_type"]

            if path == -1:
                path = "---"
            else:
                path = sanitize_path(path)
            st_values.append([t, path, output_type])
        subtask_table.value_matrix = st_values

        result = "\n"
        if list_groups:
            result += group_table.dumps() + "\n\n"
        if list_tags:
            result += tag_table.dumps() + "\n\n"
        if list_subtasks:
            result += subtask_table.dumps() + "\n\n"
        return result

Baber Abbasi's avatar
Baber Abbasi committed
174
    def match_tasks(self, task_list: list[str]) -> list[str]:
175
        return utils.pattern_match(task_list, self.all_tasks)
176

Baber Abbasi's avatar
Baber Abbasi committed
177
    def _name_is_registered(self, name: str) -> bool:
178
        return name in self.all_tasks
179

Baber Abbasi's avatar
Baber Abbasi committed
180
    def _name_is_task(self, name: str) -> bool:
181
182
183
        return (
            self._name_is_registered(name) and self.task_index[name]["type"] == "task"
        )
Lintang Sutawika's avatar
Lintang Sutawika committed
184

Baber Abbasi's avatar
Baber Abbasi committed
185
    def _name_is_tag(self, name: str) -> bool:
186
        return self._name_is_registered(name) and self.task_index[name]["type"] == "tag"
187

Baber Abbasi's avatar
Baber Abbasi committed
188
    def _name_is_group(self, name: str) -> bool:
189
190
191
        return (
            self._name_is_registered(name) and self.task_index[name]["type"] == "group"
        )
192

Baber Abbasi's avatar
Baber Abbasi committed
193
    def _name_is_python_task(self, name: str) -> bool:
194
195
196
197
        return (
            self._name_is_registered(name)
            and self.task_index[name]["type"] == "python_task"
        )
198

Baber Abbasi's avatar
Baber Abbasi committed
199
    def _config_is_task(self, config: dict) -> bool:
200
        return "task" in config and isinstance(config["task"], str)
201

Baber Abbasi's avatar
Baber Abbasi committed
202
    def _config_is_group(self, config: dict) -> bool:
203
        return "task" in config and isinstance(config["task"], list)
204

Baber Abbasi's avatar
Baber Abbasi committed
205
    def _config_is_python_task(self, config: dict) -> bool:
206
207
208
209
        return "class" in config

    def _config_is_task_list(self, config: dict) -> bool:
        return "task_list" in config and isinstance(config["task_list"], list)
210

Baber Abbasi's avatar
Baber Abbasi committed
211
    def _get_yaml_path(self, name: str):
212
213
        if name not in self.task_index:
            raise ValueError
214
215
216
        return self.task_index[name]["yaml_path"]

    def _get_config(self, name):
217
218
        if name not in self.task_index:
            raise ValueError
219
220
221
222
223
224
225
        yaml_path = self._get_yaml_path(name)
        if yaml_path == -1:
            return {}
        else:
            return utils.load_yaml_config(yaml_path, mode="full")

    def _get_tasklist(self, name):
226
227
        if self._name_is_task(name):
            raise ValueError
228
229
        return self.task_index[name]["task"]

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
    def _register_task(
        self,
        task_name: str,
        task_type: str,
        yaml_path: str,
        tasks_and_groups: dict,
        config: dict = None,
        populate_tags_fn=None,
    ):
        """Helper method to register a task in the tasks_and_groups dict"""
        tasks_and_groups[task_name] = {
            "type": task_type,
            "yaml_path": yaml_path,
        }
        # Only populate tags for configs that support it (not groups)
        if config and task_type != "group" and populate_tags_fn:
246
            populate_tags_fn(config, task_name, tasks_and_groups)
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

    def _merge_task_configs(
        self, base_config: dict, task_specific_config: dict, task_name: str
    ) -> dict:
        """Merge base config with task-specific overrides for task_list configs"""
        if task_specific_config:
            task_specific_config = task_specific_config.copy()
            task_specific_config.pop("task", None)
            return {**base_config, **task_specific_config, "task": task_name}
        return {**base_config, "task": task_name}

    def _process_tag_subtasks(self, tag_name: str, update_config: dict = None):
        """Process subtasks for a tag and return loaded tasks"""
        subtask_list = self._get_tasklist(tag_name)
        fn = partial(
            self._load_individual_task_or_group,
            update_config=update_config,
        )
        return dict(collections.ChainMap(*map(fn, reversed(subtask_list))))

267
268
269
270
271
272
273
274
275
    def _process_alias(self, config, group=None):
        # If the group is not the same as the original
        # group which the group alias was intended for,
        # Set the group_alias to None instead.
        if ("group_alias" in config) and ("group" in config) and group is not None:
            if config["group"] != group:
                config["group_alias"] = None
        return config

276
277
278
279
280
281
282
283
    def _class_has_config_in_constructor(self, cls):
        constructor = getattr(cls, "__init__", None)
        return (
            "config" in inspect.signature(constructor).parameters
            if constructor
            else False
        )

284
    def _load_individual_task_or_group(
285
        self,
286
287
288
289
        name_or_config: Optional[Union[str, dict]] = None,
        parent_name: Optional[str] = None,
        update_config: Optional[dict] = None,
    ) -> Mapping:
Lintang Sutawika's avatar
Lintang Sutawika committed
290
        def _load_task(config, task):
291
            if "include" in config:
292
293
294
                # Store the task name to preserve it after include processing
                original_task_name = config.get("task", task)

295
296
                config = {
                    **utils.load_yaml_config(
Lintang Sutawika's avatar
Lintang Sutawika committed
297
                        yaml_path=None,
298
299
                        yaml_config={"include": config.pop("include")},
                        mode="full",
300
301
                    ),
                    **config,
302
                    "task": original_task_name,
303
                }
304
305
306
307

                # Ensure the task name from the group config is preserved
                # This prevents tasks with the same include from being treated as duplicates

308
            if self._config_is_python_task(config):
309
310
311
312
313
314
                if self._class_has_config_in_constructor(config["class"]):
                    task_object = config["class"](config=config)
                else:
                    task_object = config["class"]()
                if isinstance(task_object, ConfigurableTask):
                    # very scuffed: set task name here. TODO: fixme?
315
                    task_object.config.task = task
316
            else:
Baber Abbasi's avatar
Baber Abbasi committed
317
318
319
320
                if self.metadata is not None:
                    config["metadata"] = config.get("metadata", {}) | self.metadata
                else:
                    config["metadata"] = config.get("metadata", {})
321
                task_object = ConfigurableTask(config=config)
Lintang Sutawika's avatar
Lintang Sutawika committed
322

323
324
            return {task: task_object}

Baber Abbasi's avatar
Baber Abbasi committed
325
326
327
328
329
        def _get_group_and_subtask_from_config(
            config: dict,
        ) -> tuple[ConfigurableGroup, list[str]]:
            if self.metadata is not None:
                config["metadata"] = config.get("metadata", {}) | self.metadata
Lintang Sutawika's avatar
Lintang Sutawika committed
330
331
332
333
334
335
336
337
338
            group_name = ConfigurableGroup(config=config)
            subtask_list = []
            for task in group_name.config["task"]:
                if isinstance(task, str) and self._name_is_tag(task):
                    subtask_list.extend(self._get_tasklist(task))
                else:
                    subtask_list.append(task)
            return group_name, subtask_list

Baber Abbasi's avatar
Baber Abbasi committed
339
340
341
        def _process_group_config(
            config: dict, update_config: dict = None
        ) -> tuple[dict, dict]:
Lintang Sutawika's avatar
Lintang Sutawika committed
342
343
344
345
346
347
348
349
350
351
352
            if update_config is not None:
                config = {**config, **update_config}
            _update_config = {
                k: v for k, v in config.items() if k not in GROUP_ONLY_KEYS
            }
            if not bool(_update_config):
                _update_config = None

            group_config = {k: v for k, v in config.items() if k in GROUP_ONLY_KEYS}
            return group_config, _update_config

353
354
355
356
        if isinstance(name_or_config, str):
            if update_config is not None:
                # Process name_or_config as a dict instead
                name_or_config = {"task": name_or_config, **update_config}
Lintang Sutawika's avatar
Lintang Sutawika committed
357
358
359
            elif self._name_is_task(name_or_config) or self._name_is_python_task(
                name_or_config
            ):
360
                task_config = self._get_config(name_or_config)
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389

                # Handle task_list configs
                if "task_list" in task_config:
                    # Find the specific task entry
                    task_specific_config = None
                    for task_entry in task_config["task_list"]:
                        if (
                            isinstance(task_entry, dict)
                            and task_entry.get("task") == name_or_config
                        ):
                            task_specific_config = task_entry
                            break

                    if task_specific_config:
                        # Create base config without task_list
                        base_config = {
                            k: v for k, v in task_config.items() if k != "task_list"
                        }
                        # Merge using helper method
                        task_config = self._merge_task_configs(
                            base_config, task_specific_config, name_or_config
                        )
                    else:
                        # Task not found in task_list, shouldn't happen if indexing worked correctly
                        eval_logger.warning(
                            f"Task {name_or_config} not found in task_list"
                        )
                        task_config = {"task": name_or_config}

Lintang Sutawika's avatar
Lintang Sutawika committed
390
                return _load_task(task_config, task=name_or_config)
391
            else:
392
393
394
                subtask_list = self._get_tasklist(name_or_config)
                if subtask_list == -1:
                    group_config = self._get_config(name_or_config)
Lintang Sutawika's avatar
Lintang Sutawika committed
395
396
397
398
399
400
                    group_config, update_config = _process_group_config(group_config)
                    group_name, subtask_list = _get_group_and_subtask_from_config(
                        group_config
                    )
                else:
                    if self._name_is_tag(name_or_config):
401
402
403
                        return self._process_tag_subtasks(
                            name_or_config,
                            name_or_config
Lintang Sutawika's avatar
Lintang Sutawika committed
404
405
406
407
408
409
410
                            if isinstance(name_or_config, dict)
                            else None,
                        )
                    else:
                        group_name = ConfigurableGroup(
                            config={"group": name_or_config, "task": subtask_list}
                        )
411

412
413
        if isinstance(name_or_config, dict):
            if self._config_is_task(name_or_config):
Lintang Sutawika's avatar
Lintang Sutawika committed
414
415
416
                name = name_or_config.pop("task")
                if update_config is not None:
                    name_or_config = {**name_or_config, **update_config}
417
418
                # If the name is registered as a group
                if self._name_is_group(name):
Lintang Sutawika's avatar
Lintang Sutawika committed
419
420
421
422
423
424
425
426
427
                    group_config = self._get_config(name)

                    group_config, update_config = _process_group_config(
                        group_config, name_or_config
                    )
                    group_name, subtask_list = _get_group_and_subtask_from_config(
                        group_config
                    )
                elif self._name_is_tag(name):
428
                    return self._process_tag_subtasks(name, name_or_config)
429
430
431
432
433
434
                else:
                    if self._name_is_registered(name):
                        base_task_config = self._get_config(name)

                        # Check if this is a duplicate.
                        if parent_name is not None:
435
436
437
438
439
440
441
442
                            num_duplicate = len(
                                list(
                                    filter(
                                        lambda x: x.startswith(name),
                                        self.task_group_map[parent_name],
                                    )
                                )
                            )
443
444
445
446
                            if num_duplicate > 0:
                                name = f"{name}-{num_duplicate}"
                            self.task_group_map[parent_name].append(name)

447
448
449
450
                        task_config = {
                            **base_task_config,
                            **name_or_config,
                        }
451
452
                    else:
                        task_config = name_or_config
Lintang Sutawika's avatar
Lintang Sutawika committed
453
                    return _load_task(task_config, task=name)
454
            else:
Lintang Sutawika's avatar
Lintang Sutawika committed
455
456
457
458
                group_config, update_config = _process_group_config(name_or_config)
                group_name, subtask_list = _get_group_and_subtask_from_config(
                    group_config
                )
459

460
461
462
463
464
        fn = partial(
            self._load_individual_task_or_group,
            parent_name=group_name,
            update_config=update_config,
        )
Lintang Sutawika's avatar
Lintang Sutawika committed
465
466
        return {
            group_name: dict(collections.ChainMap(*map(fn, reversed(subtask_list))))
467
        }
468

469
    def load_task_or_group(self, task_list: Optional[Union[str, list]] = None) -> dict:
470
        """Loads a dictionary of task objects from a list
471

472
473
        :param task_list: Union[str, list] = None
            Single string or list of string of task names to be loaded
474

475
476
477
478
479
        :return
            Dictionary of task objects
        """
        if isinstance(task_list, str):
            task_list = [task_list]
480

481
        all_loaded_tasks = dict(
Baber Abbasi's avatar
Baber Abbasi committed
482
483
484
485
486
487
            collections.ChainMap(
                *map(
                    lambda task: self._load_individual_task_or_group(task),
                    task_list,
                )
            )
488
489
490
491
492
493
494
        )
        return all_loaded_tasks

    def load_config(self, config: Dict):
        return self._load_individual_task_or_group(config)

    def _get_task_and_group(self, task_dir: str):
495
        """Creates a dictionary of tasks index with the following metadata,
Lintang Sutawika's avatar
Lintang Sutawika committed
496
        - `type`, that can be either `task`, `python_task`, `group` or `tags`.
497
498
            `task` refer to regular task configs, `python_task` are special
            yaml files that only consists of `task` and `class` parameters.
Lintang Sutawika's avatar
Lintang Sutawika committed
499
500
            `group` are group configs. `tags` are labels that can be assigned
            to tasks to assist in sorting and calling tasks of certain themes.
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
        - `yaml_path`, path to the yaml file. If the entry is a `group` that
            was configured through a task config, the yaml_path will be -1
            and all subtasks will be listed in `task` (see below)
        - `task`, reserved for entries with `type` as `group`. This will list
            all subtasks. When a group config is created (as opposed to task
            config having `group` parameter set), this will be set to -1 to
            avoid recursive indexing. The whole list of subtasks will be loaded
            at evaluation.

        :param task_dir: str
            A directory to check for tasks

        :return
            Dictionary of task names as key and task metadata
        """
516

517
        def _populate_tags_and_groups(config, task, tasks_and_groups):
518
            # TODO: remove group in next release
519
520
521
522
523
524
525
526
527
528
529
530
531
            if "tag" in config:
                attr_list = config["tag"]
                if isinstance(attr_list, str):
                    attr_list = [attr_list]

                for tag in attr_list:
                    if tag not in tasks_and_groups:
                        tasks_and_groups[tag] = {
                            "type": "tag",
                            "task": [task],
                            "yaml_path": -1,
                        }
                    elif tasks_and_groups[tag]["type"] != "tag":
Lintang Sutawika's avatar
Lintang Sutawika committed
532
                        eval_logger.info(
533
534
                            f"The tag '{tag}' is already registered as a group, this tag will not be registered. "
                            "This may affect tasks you want to call."
535
                        )
536
537
538
                        break
                    else:
                        tasks_and_groups[tag]["task"].append(task)
539

Lintang Sutawika's avatar
Lintang Sutawika committed
540
        # TODO: remove group in next release
541
542
543
544
        ignore_dirs = [
            "__pycache__",
            ".ipynb_checkpoints",
        ]
545
        tasks_and_groups = collections.defaultdict()
546
547
        for root, dirs, file_list in os.walk(task_dir):
            dirs[:] = [d for d in dirs if d not in ignore_dirs]
548
549
550
551
552
553
            for f in file_list:
                if f.endswith(".yaml"):
                    yaml_path = os.path.join(root, f)
                    config = utils.load_yaml_config(yaml_path, mode="simple")
                    if self._config_is_python_task(config):
                        # This is a python class config
554
                        task = config["task"]
555
556
557
558
559
560
561
                        self._register_task(
                            task,
                            "python_task",
                            yaml_path,
                            tasks_and_groups,
                            config,
                            _populate_tags_and_groups,
562
                        )
563
564
565
566
                    elif self._config_is_group(config):
                        # This is a group config
                        tasks_and_groups[config["group"]] = {
                            "type": "group",
567
568
569
570
571
                            "task": -1,  # This signals that
                            # we don't need to know
                            # the task list for indexing
                            # as it can be loaded
                            # when called.
572
573
                            "yaml_path": yaml_path,
                        }
lintangsutawika's avatar
lintangsutawika committed
574

575
576
577
578
579
580
581
582
583
584
585
586
                        # # Registered the level 1 tasks from a group config
                        # for config in config["task"]:
                        #     if isinstance(config, dict) and self._config_is_task(config):
                        #         task = config["task"]
                        #         tasks_and_groups[task] = {
                        #             "type": "task",
                        #             "yaml_path": yaml_path,
                        #             }

                    elif self._config_is_task(config):
                        # This is a task config
                        task = config["task"]
587
588
589
590
591
592
593
                        self._register_task(
                            task,
                            "task",
                            yaml_path,
                            tasks_and_groups,
                            config,
                            _populate_tags_and_groups,
594
                        )
595
596
597
598
599
600
601
602
603
604
605
606
607
                    elif self._config_is_task_list(config):
                        # This is a task_list config
                        for task_entry in config["task_list"]:
                            if isinstance(task_entry, dict) and "task" in task_entry:
                                task_name = task_entry["task"]
                                self._register_task(
                                    task_name,
                                    "task",
                                    yaml_path,
                                    tasks_and_groups,
                                    config,
                                    _populate_tags_and_groups,
                                )
608
                    else:
Lintang Sutawika's avatar
Lintang Sutawika committed
609
                        eval_logger.debug(f"File {f} in {root} could not be loaded")
610
611

        return tasks_and_groups
lintangsutawika's avatar
lintangsutawika committed
612

613

614
615
616
617
618
619
620
def get_task_name_from_config(task_config: Dict[str, str]) -> str:
    if "task" in task_config:
        return task_config["task"]
    if "dataset_name" in task_config:
        return "{dataset_path}_{dataset_name}".format(**task_config)
    else:
        return "{dataset_path}".format(**task_config)
lintangsutawika's avatar
lintangsutawika committed
621

622

lintangsutawika's avatar
lintangsutawika committed
623
def get_task_name_from_object(task_object):
624
625
    if hasattr(task_object, "config"):
        return task_object._config["task"]
lintangsutawika's avatar
lintangsutawika committed
626
627
628
629
630
631
632
633
634

    # 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__
    )

635

Baber Abbasi's avatar
Baber Abbasi committed
636
def _check_duplicates(task_dict: dict) -> None:
Lintang Sutawika's avatar
Lintang Sutawika committed
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
    """helper function solely used in validating get_task_dict output.
    Takes the output of lm_eval.evaluator_utils.get_subtask_list and
    returns a list of all leaf subtasks contained within, and errors if any such leaf subtasks are
    "oversubscribed" to several disjoint groups.
    """
    subtask_names = []
    for key, value in task_dict.items():
        subtask_names.extend(value)

    duplicate_tasks = {
        task_name for task_name in subtask_names if subtask_names.count(task_name) > 1
    }

    # locate the potentially problematic groups that seem to 'compete' for constituent subtasks
    competing_groups = [
        group
        for group in task_dict.keys()
        if len(set(task_dict[group]).intersection(duplicate_tasks)) > 0
    ]

    if len(duplicate_tasks) > 0:
        raise ValueError(
            f"Found 1 or more tasks while trying to call get_task_dict() that were members of more than 1 called group: {list(duplicate_tasks)}. Offending groups: {competing_groups}. Please call groups which overlap their constituent tasks in separate evaluation runs."
        )


663
def get_task_dict(
664
    task_name_list: Union[str, List[Union[str, Dict, Task]]],
665
    task_manager: Optional[TaskManager] = None,
666
):
667
    """Creates a dictionary of task objects from either a name of task, config, or prepared Task object.
lintangsutawika's avatar
lintangsutawika committed
668

669
670
671
672
673
674
675
    :param task_name_list: List[Union[str, Dict, Task]]
        Name of model or LM object, see lm_eval.models.get_model
    :param task_manager: TaskManager = None
        A TaskManager object that stores indexed tasks. If not set,
        task_manager will load one. This should be set by the user
        if there are additional paths that want to be included
        via `include_path`
676

677
678
679
    :return
        Dictionary of task objects
    """
Lintang Sutawika's avatar
Lintang Sutawika committed
680

681
    task_name_from_string_dict = {}
682
683
684
    task_name_from_config_dict = {}
    task_name_from_object_dict = {}

685
    if isinstance(task_name_list, str):
lintangsutawika's avatar
lintangsutawika committed
686
        task_name_list = [task_name_list]
687
688
689
690
691
692
693
694
695
    elif isinstance(task_name_list, list):
        if not all([isinstance(task, (str, dict, Task)) for task in task_name_list]):
            raise TypeError(
                "Expected all list items to be of types 'str', 'dict', or 'Task', but at least one entry did not match."
            )
    else:
        raise TypeError(
            f"Expected a 'str' or 'list' but received {type(task_name_list)}."
        )
lintangsutawika's avatar
lintangsutawika committed
696

697
    string_task_name_list = [task for task in task_name_list if isinstance(task, str)]
698
699
700
    others_task_name_list = [
        task for task in task_name_list if not isinstance(task, str)
    ]
701
702
703
    if len(string_task_name_list) > 0:
        if task_manager is None:
            task_manager = TaskManager()
lintangsutawika's avatar
lintangsutawika committed
704

705
706
707
        task_name_from_string_dict = task_manager.load_task_or_group(
            string_task_name_list
        )
708

709
710
    for task_element in others_task_name_list:
        if isinstance(task_element, dict):
711
712
            task_name_from_config_dict = {
                **task_name_from_config_dict,
713
                **task_manager.load_config(config=task_element),
714
715
716
717
718
            }

        elif isinstance(task_element, Task):
            task_name_from_object_dict = {
                **task_name_from_object_dict,
lintangsutawika's avatar
lintangsutawika committed
719
                get_task_name_from_object(task_element): task_element,
720
            }
lintangsutawika's avatar
lintangsutawika committed
721

722
    if not set(task_name_from_string_dict.keys()).isdisjoint(
lintangsutawika's avatar
lintangsutawika committed
723
        set(task_name_from_object_dict.keys())
724
725
    ):
        raise ValueError
726

Lintang Sutawika's avatar
Lintang Sutawika committed
727
    final_task_dict = {
728
        **task_name_from_string_dict,
lintangsutawika's avatar
lintangsutawika committed
729
        **task_name_from_config_dict,
730
        **task_name_from_object_dict,
lintangsutawika's avatar
lintangsutawika committed
731
    }
Lintang Sutawika's avatar
Lintang Sutawika committed
732
733
734
735
736
737
738
739

    # behavior can get odd if one tries to invoke several groups that "compete" for the same task.
    # (notably, because one could request several num_fewshot values at once in GroupConfig overrides for the subtask
    # and we'd be unsure which to use and report.)
    # we explicitly check and error in this case.
    _check_duplicates(get_subtask_list(final_task_dict))

    return final_task_dict