task.py 46.6 KB
Newer Older
1
import abc
2
from dataclasses import dataclass, field, asdict
3
4

import re
5
import ast
lintangsutawika's avatar
lintangsutawika committed
6
import yaml
7
8
9
import evaluate
import random
import itertools
10
import functools
11
from tqdm import tqdm
12
13
14
15

import datasets
import numpy as np

baberabb's avatar
baberabb committed
16
from typing import Union, List, Any, Tuple, Literal
17
from collections.abc import Callable
18

19
from lm_eval import utils
20
from lm_eval.api import samplers
haileyschoelkopf's avatar
haileyschoelkopf committed
21
from lm_eval.api.instance import Instance
lintangsutawika's avatar
lintangsutawika committed
22
from lm_eval.api.filter import FilterEnsemble
23
24
25
26

from lm_eval.logger import eval_logger
from lm_eval.prompts import get_prompt
from lm_eval.filters import build_filter_ensemble
lintangsutawika's avatar
lintangsutawika committed
27
28
29
30
from lm_eval.api.metrics import (
    mean,
    weighted_perplexity,
    bits_per_byte,
lintangsutawika's avatar
lintangsutawika committed
31
    metric_max_over_ground_truths,
lintangsutawika's avatar
lintangsutawika committed
32
33
)
from lm_eval.api.registry import (
haileyschoelkopf's avatar
haileyschoelkopf committed
34
35
36
37
    get_metric,
    get_aggregation,
    get_default_aggregation,
    is_higher_better,
38
39
    DEFAULT_METRIC_REGISTRY,
    OUTPUT_TYPE_REGISTRY,
lintangsutawika's avatar
lintangsutawika committed
40
41
    AGGREGATION_REGISTRY,
)
42

43
44
45
46
47
48
49
ALL_OUTPUT_TYPES = [
    "loglikelihood",
    "multiple_choice",
    "loglikelihood_rolling",
    "greedy_until",
]

50
51
52

@dataclass
class TaskConfig(dict):
53
    # task naming/registry
54
    task: str = None
55
    group: Union[str, list] = None
56
57
58
    # HF dataset options.
    # which dataset to use,
    # and what splits for what purpose
59
60
    dataset_path: str = None
    dataset_name: str = None
61
    dataset_kwargs: dict = None
62
63
64
    training_split: str = None
    validation_split: str = None
    test_split: str = None
lintangsutawika's avatar
lintangsutawika committed
65
    fewshot_split: str = None  # TODO: assert that this not None if num_fewshot > 0. (?) assert if this is same split as one evaling (?)
66
67
    # formatting / prompting options.
    # see docs/advanced_task_guide.md for more info
68
    process_docs: Callable = None
69
70
    doc_to_text: Union[Callable, str] = None
    doc_to_target: Union[Callable, str] = None
lintangsutawika's avatar
lintangsutawika committed
71
    doc_to_choice: Union[Callable, str, dict, list] = None
72
    gold_alias: Union[Callable, str] = None
lintangsutawika's avatar
lintangsutawika committed
73
    process_results: Union[Callable, str] = None
74
    use_prompt: str = None
75
    description: str = ""
76
77
    target_delimiter: str = " "
    fewshot_delimiter: str = "\n\n"
haileyschoelkopf's avatar
haileyschoelkopf committed
78
    fewshot_config: dict = None
79
    # runtime configuration options
80
    num_fewshot: int = 0
81
    # scoring options
82
    metric_list: list = None
83
    output_type: str = "greedy_until"
84
    generation_kwargs: dict = None
85
    repeats: int = 1
lintangsutawika's avatar
lintangsutawika committed
86
    filter_list: Union[str, list] = None
87
88
    should_decontaminate: bool = False
    doc_to_decontamination_query: str = None
89

lintangsutawika's avatar
lintangsutawika committed
90
    metadata: str = None  # by default, not used in the code. allows for users to pass arbitrary info to tasks
91

Ethan Smith's avatar
Ethan Smith committed
92
    def __post_init__(self) -> None:
lintangsutawika's avatar
lintangsutawika committed
93
94
95
        if "." in self.dataset_path:
            import inspect
            from importlib import import_module
lintangsutawika's avatar
format  
lintangsutawika committed
96

lintangsutawika's avatar
lintangsutawika committed
97
            self.dataset_path = inspect.getfile(import_module(self.dataset_path))
98

Lintang Sutawika's avatar
Lintang Sutawika committed
99
100
101
        if self.generation_kwargs is not None:
            if self.output_type != "greedy_until":
                eval_logger.warning(
102
                    "passed `generation_kwargs`, but not using `output_type: greedy_until`!"
Lintang Sutawika's avatar
Lintang Sutawika committed
103
                )
104
                assert self.output_type != "greedy_until"
Lintang Sutawika's avatar
Lintang Sutawika committed
105
106
107
108
109
110
111

            if "temperature" in self.generation_kwargs:
                self.generation_kwargs["temperature"] = float(
                    self.generation_kwargs["temperature"]
                )

            if "until" not in self.generation_kwargs:
112
                self.generation_kwargs["until"] = [self.fewshot_delimiter]
Lintang Sutawika's avatar
Lintang Sutawika committed
113
114
115
116
        else:
            if self.output_type == "greedy_until":
                # ensure that we greedily generate in absence of explicit arguments otherwise
                self.generation_kwargs = {
Lintang Sutawika's avatar
Lintang Sutawika committed
117
                    "until": None
118
119
                    if self.fewshot_delimiter is None
                    else [self.fewshot_delimiter],
Lintang Sutawika's avatar
Lintang Sutawika committed
120
121
122
                    "do_sample": False,
                    "temperature": 0.0,
                }
123

haileyschoelkopf's avatar
haileyschoelkopf committed
124
125
        # TODO: how to make TaskConfigs be de- and re-serializable, even when using the !function constructor?

126
127
128
    def __getitem__(self, item):
        return getattr(self, item)

129
130
131
    def __setitem__(self, item, value):
        return setattr(self, item, value)

132
    def to_dict(self):
133
134
        """dumps the current config as a dictionary object, as a printable format.
        null fields will not be printed.
haileyschoelkopf's avatar
haileyschoelkopf committed
135
        Used for dumping results alongside full task configuration
136

haileyschoelkopf's avatar
haileyschoelkopf committed
137
138
139
140
141
142
143
144
145
146
        :return: dict
            A printable dictionary version of the TaskConfig object.

        # TODO: should any default value in the TaskConfig not be printed?
        """
        cfg_dict = asdict(self)
        # remove values that are `None`
        for k, v in list(cfg_dict.items()):
            if v is None:
                cfg_dict.pop(k)
haileyschoelkopf's avatar
haileyschoelkopf committed
147
148
149
            elif isinstance(v, Callable):
                # TODO: this should handle Promptsource template objects as a separate case?
                cfg_dict[k] = str(v)
haileyschoelkopf's avatar
haileyschoelkopf committed
150
        return cfg_dict
151

152
153
154
155
156
157
158
159
160
161
162
163

class Task(abc.ABC):
    """A task represents an entire benchmark including its dataset, problems,
    answers, and evaluation methods. See BoolQ for a simple example implementation

    A `doc` can be any python object which represents one instance of evaluation.
    This is usually a dictionary e.g.
        {"question": ..., "answer": ...} or
        {"question": ..., question, answer)
    """

    VERSION = None
164

165
166
167
168
169
170
171
172
    # The name of the `Task` benchmark as denoted in the HuggingFace datasets Hub
    # or a path to a custom `datasets` loading script.
    DATASET_PATH: str = None

    # The name of a subset within `DATASET_PATH`.
    DATASET_NAME: str = None

    OUTPUT_TYPE: str = None
lintangsutawika's avatar
lintangsutawika committed
173

174
175
176
177
178
179
    def __init__(
        self,
        data_dir=None,
        cache_dir=None,
        download_mode=None,
        config=None,
Ethan Smith's avatar
Ethan Smith committed
180
    ) -> None:
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
        """
        :param data_dir: str
            Stores the path to a local folder containing the `Task`'s data files.
            Use this to specify the path to manually downloaded data (usually when
            the dataset is not publicly accessible).
        :param cache_dir: str
            The directory to read/write the `Task` dataset. This follows the
            HuggingFace `datasets` API with the default cache directory located at:
                `~/.cache/huggingface/datasets`
            NOTE: You can change the cache location globally for a given process
            to another directory:
                `export HF_DATASETS_CACHE="/path/to/another/directory"`
        :param download_mode: datasets.DownloadMode
            How to treat pre-existing `Task` downloads and data.
            - `datasets.DownloadMode.REUSE_DATASET_IF_EXISTS`
                Reuse download and reuse dataset.
            - `datasets.DownloadMode.REUSE_CACHE_IF_EXISTS`
                Reuse download with fresh dataset.
            - `datasets.DownloadMode.FORCE_REDOWNLOAD`
                Fresh download and fresh dataset.
        """
        self.download(data_dir, cache_dir, download_mode)
        self._training_docs = None
        self._fewshot_docs = None
        self._instances = None

haileyschoelkopf's avatar
haileyschoelkopf committed
207
        self._config = TaskConfig(**config) if config else TaskConfig()
208
209
210

        if not hasattr(self, "_filters"):
            self._filters = []
lintangsutawika's avatar
lintangsutawika committed
211
            for name, components in self._config.get(
212
                "filters", [["none", [["take_first", None]]]]
lintangsutawika's avatar
lintangsutawika committed
213
            ):
214
215
216
                filter_pipeline = build_filter_ensemble(name, components)
                self._filters.append(filter_pipeline)

lintangsutawika's avatar
lintangsutawika committed
217
        self.sampler = samplers.Sampler(
218
219
            list(self.fewshot_docs()), self, rnd=random.Random(1234)
        )
220

Ethan Smith's avatar
Ethan Smith committed
221
    def download(self, data_dir=None, cache_dir=None, download_mode=None) -> None:
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
        """Downloads and returns the task dataset.
        Override this method to download the dataset from a custom API.

        :param data_dir: str
            Stores the path to a local folder containing the `Task`'s data files.
            Use this to specify the path to manually downloaded data (usually when
            the dataset is not publicly accessible).
        :param cache_dir: str
            The directory to read/write the `Task` dataset. This follows the
            HuggingFace `datasets` API with the default cache directory located at:
                `~/.cache/huggingface/datasets`
            NOTE: You can change the cache location globally for a given process
            by setting the shell environment variable, `HF_DATASETS_CACHE`,
            to another directory:
                `export HF_DATASETS_CACHE="/path/to/another/directory"`
        :param download_mode: datasets.DownloadMode
            How to treat pre-existing `Task` downloads and data.
            - `datasets.DownloadMode.REUSE_DATASET_IF_EXISTS`
                Reuse download and reuse dataset.
            - `datasets.DownloadMode.REUSE_CACHE_IF_EXISTS`
                Reuse download with fresh dataset.
            - `datasets.DownloadMode.FORCE_REDOWNLOAD`
                Fresh download and fresh dataset.
        """
246
247
248
249
250
251
252
        self.dataset = datasets.load_dataset(
            path=self.DATASET_PATH,
            name=self.DATASET_NAME,
            data_dir=data_dir,
            cache_dir=cache_dir,
            download_mode=download_mode,
        )
253

254
255
256
257
258
    @property
    def config(self):
        """Returns the TaskConfig associated with this class."""
        return self._config

259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
    @abc.abstractmethod
    def has_training_docs(self):
        """Whether the task has a training set"""
        pass

    @abc.abstractmethod
    def has_validation_docs(self):
        """Whether the task has a validation set"""
        pass

    @abc.abstractmethod
    def has_test_docs(self):
        """Whether the task has a test set"""
        pass

    def training_docs(self):
        """
        :return: Iterable[obj]
            A iterable of any object, that doc_to_text can handle
        """
        return []

    def validation_docs(self):
        """
        :return: Iterable[obj]
            A iterable of any object, that doc_to_text can handle
        """
        return []

    def test_docs(self):
        """
        :return: Iterable[obj]
            A iterable of any object, that doc_to_text can handle
        """
        return []

295
296
297
298
299
300
301
302
303
304
    def fewshot_docs(self):
        """
        :return: Iterable[obj]
            A iterable of any object, that doc_to_text can handle
        """
        if self.has_training_docs():
            return self.training_docs()
        elif self.has_validation_docs():
            return self.validation_docs()
        else:
lintangsutawika's avatar
lintangsutawika committed
305
            eval_logger.warning(
306
                "has_training_docs and has_validation_docs are False"
307
                ", using test_docs as fewshot_docs but this is not recommended."
lintangsutawika's avatar
lintangsutawika committed
308
            )
309
310
            return self.test_docs()

311
312
313
314
315
316
317
318
319
320
    def _process_doc(self, doc):
        """
        Override this to process (detokenize, strip, replace, etc.) individual
        documents. This can be used in a map over documents of a data split.
        E.g. `map(self._process_doc, self.dataset["validation"])`

        :return: dict
            The processed version of the specified `doc`.
        """
        return doc
lintangsutawika's avatar
lintangsutawika committed
321

322
323
324
325
326
327
328
329
330
331
332
333
334
    @property
    def instances(self):
        """After calling `task.build_all_requests()`, tasks
        maintain a list of the dataset instances which will be evaluated.
        """
        return self._instances

    def fewshot_examples(self, k, rnd):
        if self._training_docs is None:
            self._training_docs = list(self.training_docs())

        return rnd.sample(self._training_docs, k)

Ethan Smith's avatar
Ethan Smith committed
335
    def doc_to_decontamination_query(self, doc) -> None:
336
337
338
339
340
341
342
343
344
345
346
347
348
        print(
            "Override doc_to_decontamination_query with document specific decontamination query."
        )
        assert False

    @abc.abstractmethod
    def doc_to_text(self, doc):
        pass

    @abc.abstractmethod
    def doc_to_target(self, doc):
        pass

Ethan Smith's avatar
Ethan Smith committed
349
    def build_all_requests(self, limit=None, rank=None, world_size=None) -> None:
350
351
352
353
354
355
356
357
358
359
        """Build a set of Instances for a task, and store them in task.instances"""
        if self.has_test_docs():
            docs = self.test_docs()
        elif self.has_validation_docs():
            docs = self.validation_docs()
        else:
            assert (
                False
            ), f"Task dataset (path={self.DATASET_PATH}, name={self.DATASET_NAME}) must have valid or test docs!"

360
        eval_logger.info(
361
            f"Building contexts for task '{self.config.task}' on rank {rank}..."
362
363
        )

364
        instances = []
365
366
        for doc_id, doc in utils.create_iterator(
            enumerate(docs), rank, world_size, limit
lintangsutawika's avatar
lintangsutawika committed
367
        ):
368
            # sample fewshot context #TODO: need to offset doc_id by rank now!
369
            fewshot_ctx = self.fewshot_context(
370
                doc,
371
                self.config.num_fewshot,
372
            )
373

374
            # TODO: we should override self.config.repeats if doing greedy gen so users don't waste time+compute
lintangsutawika's avatar
lintangsutawika committed
375
376
377
            inst = self.construct_requests(
                doc=doc,
                ctx=fewshot_ctx,
378
                metadata=(self.config["task"], doc_id, self.config.repeats),
lintangsutawika's avatar
lintangsutawika committed
379
            )
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404

            if not isinstance(inst, list):
                inst = [inst]

            instances.extend(inst)

        self._instances = instances
        assert len(self._instances) != 0, "task.build_requests() did not find any docs!"

    @abc.abstractmethod
    def construct_requests(self, doc, ctx, **kwargs):
        """Uses RequestFactory to construct Requests and returns an iterable of
        Requests which will be sent to the LM.

        :param doc:
            The document as returned from training_docs, validation_docs, or test_docs.
        :param ctx: str
            The context string, generated by fewshot_context. This includes the natural
            language description, as well as the few shot examples, and the question
            part of the document for `doc`.
        :param doc_idx: int
            The index of a document within `self.test_docs()` or `self.validation_docs()`,
            whichever is the main split used.
        :param repeats: int
        TODO: update this docstring
lintangsutawika's avatar
lintangsutawika committed
405
            The number of times each instance in a dataset is inferred on. Defaults to 1,
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
            can be increased for techniques like majority voting.
        """
        pass

    @abc.abstractmethod
    def process_results(self, doc, results):
        """Take a single document and the LM results and evaluates, returning a
        dict where keys are the names of submetrics and values are the values of
        the metric for that one document

        :param doc:
            The document as returned from training_docs, validation_docs, or test_docs.
        :param results:
            The results of the requests created in construct_requests.
        """
        pass

    @abc.abstractmethod
    def aggregation(self):
        """
        :returns: {str: [metric_score] -> float}
            A dictionary where keys are the names of submetrics and values are
            functions that aggregate a list of metric scores
        """
        pass

    @abc.abstractmethod
    def higher_is_better(self):
        """
        :returns: {str: bool}
            A dictionary where keys are the names of submetrics and values are
            whether a higher value of the submetric is better
        """
        pass

haileyschoelkopf's avatar
haileyschoelkopf committed
441
442
443
444
445
446
447
448
449
450
    @classmethod
    def count_bytes(cls, doc):
        """Used for byte-level perplexity metrics in rolling loglikelihood"""
        return len(doc.encode("utf-8"))

    @classmethod
    def count_words(cls, doc):
        """Downstream loglikelihood_rolling perplexity tasks with custom word boundaries should override this!"""
        return len(re.split(r"\s+", doc))

451
    @utils.positional_deprecated
452
    def fewshot_context(self, doc, num_fewshot):
453
454
455
456
457
458
459
460
461
462
463
464
        """Returns a fewshot context string that is made up of a prepended description
        (if provided), the `num_fewshot` number of examples, and an appended prompt example.

        :param doc: str
            The document as returned from training_docs, validation_docs, or test_docs.
        :param num_fewshot: int
            The number of fewshot examples to provide in the returned context string.
        :returns: str
            The fewshot context.
        """

        if num_fewshot == 0:
465
            # always prepend the (possibly empty) task description
466
            labeled_examples = self.config.description
467
        else:
468
            labeled_examples = self.config.description + self.sampler.get_context(
lintangsutawika's avatar
lintangsutawika committed
469
470
                doc, num_fewshot
            )
471
472

        example = self.doc_to_text(doc)
473
474
475
476
        if type(example) == str:
            return labeled_examples + example
        elif type(example) == list:
            return [labeled_examples + ex for ex in example]
477
        elif type(example) == int:
478
            if self.config.doc_to_choice is not None:
lintangsutawika's avatar
lintangsutawika committed
479
480
481
482
                choices = self.doc_to_choice(doc)
                return labeled_examples + choices[example]
            else:
                return labeled_examples + str(example)
483
484

    def apply_filters(self):
lintangsutawika's avatar
lintangsutawika committed
485
486
487
488
489
490
        if hasattr(self, "_filters"):
            for f in self._filters:
                f.apply(self._instances)
        else:
            eval_logger.warning("No filter defined, passing through instances")
            return self._instances
491

baberabb's avatar
baberabb committed
492
    def dump_config(self) -> dict:
493
        """Returns a dictionary representing the task's config.
494
495
496
497
498

        :returns: str
            The fewshot context.
        """
        # TODO: this should only return the overrides applied to a non-YAML task's configuration.
499
        # (num_fewshot)
500
        return self.config.to_dict()
501

502
503

class ConfigurableTask(Task):
504
    VERSION = "Yaml"
505
    OUTPUT_TYPE = None
506
    CONFIG = None
507
508
509

    def __init__(
        self, data_dir=None, cache_dir=None, download_mode=None, config: dict = None
Ethan Smith's avatar
Ethan Smith committed
510
    ) -> None:  # TODO no super() call here
511
        # Get pre-configured attributes
512
        self._config = self.CONFIG
513

514
        # Use new configurations if there was no preconfiguration
515
        if self.config is None:
516
            self._config = TaskConfig(**config)
517
518
        # Overwrite configs
        else:
lintangsutawika's avatar
lintangsutawika committed
519
            if config is not None:
520
                self._config.__dict__.update(config)
521

522
        if self.config is None:
lintangsutawika's avatar
lintangsutawika committed
523
524
525
            raise ValueError(
                "Must pass a config to ConfigurableTask, either in cls.CONFIG or `config` kwarg"
            )
526

527
528
529
        if self.config.output_type is not None:
            assert self.config.output_type in ALL_OUTPUT_TYPES
            self.OUTPUT_TYPE = self.config.output_type
530

531
532
        if self.config.dataset_path is not None:
            self.DATASET_PATH = self.config.dataset_path
533

534
535
        if self.config.dataset_name is not None:
            self.DATASET_NAME = self.config.dataset_name
536

537
538
539
540
        self._metric_fn_list = {}
        self._metric_fn_kwargs = {}
        self._aggregation_list = {}
        self._higher_is_better = {}
541

542
543
        _metric_list = DEFAULT_METRIC_REGISTRY[self.config.output_type]
        if self.config.metric_list is None:
544
            # TODO: handle this in TaskConfig.__post_init__ ?
545
            for metric_name in _metric_list:
haileyschoelkopf's avatar
haileyschoelkopf committed
546
547
                self._metric_fn_list[metric_name] = get_metric(metric_name)
                self._aggregation_list[metric_name] = get_default_aggregation(
548
                    metric_name
haileyschoelkopf's avatar
haileyschoelkopf committed
549
550
                )
                self._higher_is_better[metric_name] = is_higher_better(metric_name)
551
        else:
552
            for metric_config in self.config.metric_list:
553
554
555
556
557
558
559
                assert "metric" in metric_config
                metric_name = metric_config["metric"]
                kwargs = {
                    key: metric_config[key]
                    for key in metric_config
                    if key not in ["metric", "aggregation", "higher_is_better"]
                }
560

561
                if self.config.process_results is not None:
562
563
                    self._metric_fn_list[metric_name] = None
                    self._metric_fn_kwargs[metric_name] = {}
564
565
566
567
568
569
570
571
                elif callable(metric_name):
                    metric_fn = metric_name.__call__
                    metric_name = metric_name.__name__
                    self._metric_fn_list[metric_name] = metric_fn
                    self._metric_fn_kwargs[metric_name] = kwargs
                else:
                    self._metric_fn_list[metric_name] = get_metric(metric_name)
                    self._metric_fn_kwargs[metric_name] = kwargs
lintangsutawika's avatar
lintangsutawika committed
572

573
                if "aggregation" in metric_config:
574
                    agg_name = metric_config["aggregation"]
575
                    if type(agg_name) == str:
haileyschoelkopf's avatar
haileyschoelkopf committed
576
                        self._aggregation_list[metric_name] = get_aggregation(agg_name)
577
578
579
580
                    elif callable(agg_name):
                        self._aggregation_list[metric_name] = metric_config[
                            "aggregation"
                        ]
581
                else:
582
                    INV_AGG_REGISTRY = {v: k for k, v in AGGREGATION_REGISTRY.items()}
haileyschoelkopf's avatar
haileyschoelkopf committed
583
                    metric_agg = get_default_aggregation(metric_name)
584
                    eval_logger.warning(
baberabb's avatar
baberabb committed
585
                        f"[Task: {self._config.task}] metric {metric_name} is defined, but aggregation is not. "
586
587
                        f"using default "
                        f"aggregation={INV_AGG_REGISTRY[metric_agg]}"
588
                    )
589
                    self._aggregation_list[metric_name] = metric_agg
lintangsutawika's avatar
lintangsutawika committed
590

591
592
593
594
595
596
                if "higher_is_better" in metric_config:
                    self._higher_is_better[metric_name] = metric_config[
                        "higher_is_better"
                    ]
                else:
                    eval_logger.warning(
baberabb's avatar
baberabb committed
597
                        f"[Task: {self._config.task}] metric {metric_name} is defined, but higher_is_better is not. "
598
                        f"using default "
haileyschoelkopf's avatar
haileyschoelkopf committed
599
                        f"higher_is_better={is_higher_better(metric_name)}"
600
                    )
haileyschoelkopf's avatar
haileyschoelkopf committed
601
                    self._higher_is_better[metric_name] = is_higher_better(metric_name)
602

603
        self.download(self.config.dataset_kwargs)
604
605
606
        self._training_docs = None
        self._fewshot_docs = None

607
        if self.config.filter_list is not None:
lintangsutawika's avatar
lintangsutawika committed
608
            self._filters = []
609
            for filter_config in self.config.filter_list:
lintangsutawika's avatar
lintangsutawika committed
610
611
612
613
614
615
616
                for filter_pipeline in filter_config:
                    filter_name = filter_config["name"]
                    filter_functions = filter_config["filter"]
                    components = []
                    for function in filter_functions:
                        kwargs = {
                            key: function[key] for key in function if key != "function"
lintangsutawika's avatar
lintangsutawika committed
617
618
619
                        }
                        components.append([function["function"], kwargs])
                    filter_pipeline = build_filter_ensemble(filter_name, components)
lintangsutawika's avatar
lintangsutawika committed
620
                self._filters.append(filter_pipeline)
lintangsutawika's avatar
lintangsutawika committed
621
        else:
622
            self._filters = [build_filter_ensemble("none", [["take_first", None]])]
623

624
625
        if self.config.use_prompt is not None:
            eval_logger.info(f"loading prompt {self.config.use_prompt}")
626
            self.prompt = get_prompt(
627
                self.config.use_prompt, self.DATASET_PATH, self.DATASET_NAME
lintangsutawika's avatar
lintangsutawika committed
628
            )
629
630
631
        else:
            self.prompt = None

lintangsutawika's avatar
lintangsutawika committed
632
        if self.fewshot_docs() is not None:
haileyschoelkopf's avatar
haileyschoelkopf committed
633
634
635
            self.sampler = samplers.get_sampler(
                self.config.fewshot_config.get("sampler", "default")
            )(list(self.fewshot_docs()), self, rnd=random.Random(1234))
636

637
        if self.has_test_docs():
638
            self.task_docs = self.test_docs()
639
        elif self.has_validation_docs():
640
            self.task_docs = self.validation_docs()
641
642
643
644
645
        else:
            assert (
                False
            ), f"Task dataset (path={self.DATASET_PATH}, name={self.DATASET_NAME}) must have valid or test docs!"

646
        # Test One Doc
647
        self.features = list(self.task_docs.features.keys())
648
649
        self.multiple_input = 0
        self.multiple_target = 0
650
        test_doc = self.task_docs[0]
651
        test_text = self.doc_to_text(test_doc)
652
        test_target = self.doc_to_target(test_doc)
lintangsutawika's avatar
lintangsutawika committed
653

654
        if self.config.doc_to_choice is not None:
lintangsutawika's avatar
lintangsutawika committed
655
656
657
            test_choice = self.doc_to_choice(test_doc)
            if type(test_choice) is not list:
                eval_logger.error("doc_to_choice must return list")
658
659
            else:
                num_choice = len(test_choice)
660

661
662
            if type(test_text) is int:
                self.multiple_input = num_choice
663
664
        else:
            test_choice = None
665

666
        if type(test_target) is list:
667
            self.multiple_target = len(test_target)
668
        else:
lintangsutawika's avatar
lintangsutawika committed
669
            if (type(test_target) is int) and (test_choice is not None):
lintangsutawika's avatar
lintangsutawika committed
670
                test_target = test_choice[test_target]
671
            else:
lintangsutawika's avatar
lintangsutawika committed
672
                test_target = str(test_target)
673

674
675
676
        if test_choice is not None:
            check_choices = test_choice
        else:
lintangsutawika's avatar
lintangsutawika committed
677
            check_choices = [test_target]
678
679
680
681
682
        if self.config.doc_to_choice is not None:
            for choice in check_choices:
                choice_has_whitespace = True if choice[0].isspace() else False
                delimiter_has_whitespace = (
                    True if self.config.target_delimiter[-1].isspace() else False
683
                )
684

685
686
687
688
689
690
691
692
693
                if delimiter_has_whitespace and choice_has_whitespace:
                    eval_logger.warning(
                        f'Both target_delimiter and target choice: "{choice}" have whitespace'
                    )
                elif (not delimiter_has_whitespace) and (not choice_has_whitespace):
                    eval_logger.warning(
                        f'Both target_delimiter and target choice: "{choice}" does not have whitespace, ignore if the language you are evaluating on does not require/use whitespace'
                    )

Ethan Smith's avatar
Ethan Smith committed
694
    def download(self, dataset_kwargs=None) -> None:
695
696
697
698
699
700
        self.dataset = datasets.load_dataset(
            path=self.DATASET_PATH,
            name=self.DATASET_NAME,
            **dataset_kwargs if dataset_kwargs is not None else {},
        )

baberabb's avatar
baberabb committed
701
    def has_training_docs(self) -> bool:
702
        if self.config.training_split is not None:
703
704
705
706
            return True
        else:
            return False

baberabb's avatar
baberabb committed
707
    def has_validation_docs(self) -> bool:
708
        if self.config.validation_split is not None:
709
710
711
712
            return True
        else:
            return False

baberabb's avatar
baberabb committed
713
    def has_test_docs(self) -> bool:
714
        if self.config.test_split is not None:
715
716
717
718
            return True
        else:
            return False

baberabb's avatar
baberabb committed
719
    def training_docs(self) -> datasets.Dataset:
720
        if self.has_training_docs():
721
722
723
            if self.config.process_docs is not None:
                return self.config.process_docs(
                    self.dataset[self.config.training_split]
724
                )
725
            return self.dataset[self.config.training_split]
726

baberabb's avatar
baberabb committed
727
    def validation_docs(self) -> datasets.Dataset:
728
        if self.has_validation_docs():
729
730
731
            if self.config.process_docs is not None:
                return self.config.process_docs(
                    self.dataset[self.config.validation_split]
732
                )
733
            return self.dataset[self.config.validation_split]
734

baberabb's avatar
baberabb committed
735
    def test_docs(self) -> datasets.Dataset:
736
        if self.has_test_docs():
737
738
739
            if self.config.process_docs is not None:
                return self.config.process_docs(self.dataset[self.config.test_split])
            return self.dataset[self.config.test_split]
740

741
    def fewshot_docs(self):
742
743
        if self.config.fewshot_split is not None:
            return self.dataset[self.config.fewshot_split]
744
        else:
745
            if self.config.num_fewshot > 0:
746
                eval_logger.warning(
747
                    f"Task '{self.config.task}': "
748
749
750
751
                    "num_fewshot > 0 but fewshot_split is None. "
                    "using preconfigured rule."
                )
            return super().fewshot_docs()
752

753
754
755
756
757
758
759
760
761
    def apply_filters(self):

        if hasattr(self, "_filters"):
            for f in self._filters:
                f.apply(self._instances, self.task_docs)
        else:
            eval_logger.warning("No filter defined, passing through instances")
            return self._instances

762
    def should_decontaminate(self):
763
        return self.config.should_decontaminate
764
765

    def doc_to_decontamination_query(self, doc):
766
767
768
        if self.config.should_decontaminate:
            if self.config.doc_to_decontamination_query in self.features:
                return doc[self.config.doc_to_decontamination_query]
769
770
            else:
                return ast.literal_eval(
771
                    utils.apply_template(self.config.doc_to_decontamination_query, doc)
772
                )
773

774
775
776
777
778
779
780
781
782
783
784
785
    def _process_doc(self, doc):
        """
        Override this to process (detokenize, strip, replace, etc.) individual
        documents. This can be used in a map over documents of a data split.
        E.g. `map(self._process_doc, self.dataset["validation"])`

        :return: dict
            The processed version of the specified `doc`.
        """
        return doc

    def doc_to_text(self, doc):
786
787
        if self.prompt is not None:
            doc_to_text = self.prompt
788
        else:
789
            doc_to_text = self.config.doc_to_text
lintangsutawika's avatar
lintangsutawika committed
790

791
792
793
        if type(doc_to_text) == int:
            return doc_to_text
        elif type(doc_to_text) == str:
794
            if doc_to_text in self.features:
795
                # if self.config.doc_to_choice is not None:
796
797
                #     return self.doc_to_choice(doc)[doc[doc_to_text]]
                # else:
798
799
                return doc[doc_to_text]
            else:
lintangsutawika's avatar
lintangsutawika committed
800
                text_string = utils.apply_template(doc_to_text, doc)
lintangsutawika's avatar
lintangsutawika committed
801
                if text_string.isdigit() and self._config.doc_to_choice is not None:
lintangsutawika's avatar
lintangsutawika committed
802
803
804
                    return ast.literal_eval(text_string)
                else:
                    return text_string
805
        elif callable(doc_to_text):
806
            return doc_to_text(doc)
lintangsutawika's avatar
lintangsutawika committed
807
        # Used when applying a Promptsource template
808
        elif hasattr(doc_to_text, "apply"):
809
810
811
812
813
            applied_prompt = doc_to_text.apply(doc)
            if len(applied_prompt) == 2:
                return applied_prompt[0]
            else:
                eval_logger.warning("Applied prompt returns empty string")
814
                return self.config.fewshot_delimiter
815
        else:
816
            print(type(doc_to_text))
817
            raise TypeError
818

819
    def doc_to_target(self, doc: dict) -> Union[int, str, list]:
820
821
        if self.prompt is not None:
            doc_to_target = self.prompt
822
        else:
823
            doc_to_target = self.config.doc_to_target
824

825
826
827
        if type(doc_to_target) == int:
            return doc_to_target
        elif type(doc_to_target) == str:
828
            if doc_to_target in self.features:
829
                # if self.config.doc_to_choice is not None:
830
831
832
                #     return self.doc_to_choice(doc)[doc[doc_to_target]]
                # else:
                return doc[doc_to_target]
833
            else:
lintangsutawika's avatar
lintangsutawika committed
834
                target_string = utils.apply_template(doc_to_target, doc)
lintangsutawika's avatar
lintangsutawika committed
835
                if target_string.isdigit() and self._config.doc_to_choice is not None:
lintangsutawika's avatar
lintangsutawika committed
836
                    return ast.literal_eval(target_string)
lintangsutawika's avatar
lintangsutawika committed
837
838
839
840
841
                elif (
                    len(target_string) >= 2
                    and (target_string[0] == "[")
                    and (target_string[-1] == "]")
                ):
baberabb's avatar
baberabb committed
842
843
844
845
                    try:
                        return ast.literal_eval(target_string)
                    except (SyntaxError, ValueError):
                        return target_string
lintangsutawika's avatar
lintangsutawika committed
846
847
                else:
                    return target_string
848
849
        elif type(doc_to_target) == list:
            return doc_to_target
850
        elif callable(doc_to_target):
851
            return doc_to_target(doc)
lintangsutawika's avatar
lintangsutawika committed
852
        # Used when applying a Promptsource template
853
        elif hasattr(doc_to_target, "apply"):
854
            applied_prompt = doc_to_target.apply(doc)
855
856
857
858
            if len(applied_prompt) == 2:
                return applied_prompt[1]
            else:
                eval_logger.warning("Applied prompt returns empty string")
859
                return self.config.fewshot_delimiter
860
861
        else:
            raise TypeError
862

baberabb's avatar
baberabb committed
863
    def doc_to_choice(self, doc: Any) -> List[str]:
864
865
        if self.prompt is not None:
            doc_to_choice = self.prompt
866
        elif self.config.doc_to_choice is None:
867
868
            eval_logger.error("doc_to_choice was called but not set in config")
        else:
869
            doc_to_choice = self.config.doc_to_choice
870
871
872
873
874
875
876
877
878
879
880
881
882

        if type(doc_to_choice) == str:
            return ast.literal_eval(utils.apply_template(doc_to_choice, doc))
        elif type(doc_to_choice) == list:
            return doc_to_choice
        elif type(doc_to_choice) == dict:
            return list(doc_to_choice.values())
        elif callable(doc_to_choice):
            return doc_to_choice(doc)
        elif hasattr(doc_to_choice, "get_answer_choices_list"):
            return doc_to_choice.get_answer_choices_list(doc)
        else:
            raise TypeError
883

884
    def gold_alias(self, doc):
885
886
887
888
889
        # returns a version of the gold target answer to a document,
        # which should be passed into metric for scoring as the ground truth.

        # in multiple_choice tasks, this should be castable to an int corresponding to the index
        # within the answer choices, while doc_to_target is the string version of {{answer_choices[gold]}}.
890
891
        if self.config.gold_alias is not None:
            doc_to_target = self.config.gold_alias
892
        else:
lintangsutawika's avatar
lintangsutawika committed
893
            return self.doc_to_target(doc)
894
895
896
897
898
899
900
901
902
903

        if type(doc_to_target) == str:
            return utils.apply_template(doc_to_target, doc)
        elif callable(doc_to_target):
            return doc_to_target(doc)
        elif hasattr(doc_to_target, "apply"):
            return doc_to_target.apply(doc)[1]
        else:
            raise TypeError

baberabb's avatar
baberabb committed
904
905
906
    def construct_requests(
        self, doc: dict, ctx: str, **kwargs
    ) -> Union[List[Instance], Instance]:
907
        if self.OUTPUT_TYPE == "loglikelihood":
lintangsutawika's avatar
lintangsutawika committed
908
            arguments = (ctx, self.doc_to_target(doc))
909
        elif self.OUTPUT_TYPE == "loglikelihood_rolling":
lintangsutawika's avatar
lintangsutawika committed
910
            arguments = (self.doc_to_target(doc),)
911
        elif self.OUTPUT_TYPE == "multiple_choice":
912
            choices = self.doc_to_choice(doc)
913
            target_delimiter = self.config.target_delimiter
914
915
            if self.multiple_input:
                # If there are multiple inputs, choices are placed in the ctx
916
                cont = self.doc_to_target(doc)
917
                arguments = [(ctx, f"{target_delimiter}{cont}") for ctx in choices]
918
            else:
919
                # Otherwise they are placed in the continuation
920
                arguments = [(ctx, f"{target_delimiter}{cont}") for cont in choices]
921

922
            request_list = [
923
924
                Instance(
                    request_type="loglikelihood",
lintangsutawika's avatar
lintangsutawika committed
925
                    doc=doc,
926
                    arguments=arg,
927
                    idx=i,
928
929
                    **kwargs,
                )
930
                for i, arg in enumerate(arguments)
931
            ]
932
            # TODO: we should raise a warning telling users this will at most ~2x runtime.
933
            if "acc_mutual_info" in self._metric_fn_list.keys():
934
935
936
                # if we are calculating multiple choice accuracy
                # using mutual information instead of raw loglikelihood as metric, need unconditional lls.

lintangsutawika's avatar
lintangsutawika committed
937
                # here mutual info refers to calculating
938
939
940
941
942
943
                # log(P(choice|ctx) / P(choice)) = log(P(choice|ctx)) - log(P(choice))
                # in other words normalizing by subtracting the unconditional logprob of each choice.
                request_list.extend(
                    [
                        Instance(
                            request_type="loglikelihood",
lintangsutawika's avatar
lintangsutawika committed
944
                            doc=doc,
945
                            arguments=("", "{}".format(choice)),
946
947
948
                            idx=i,
                            **kwargs,
                        )
lintangsutawika's avatar
lintangsutawika committed
949
                        for i, choice in enumerate(choices)
950
951
952
                    ]
                )
            return request_list
lintangsutawika's avatar
lintangsutawika committed
953

954
        elif self.OUTPUT_TYPE == "greedy_until":
955
            arguments = (ctx, self.config.generation_kwargs)
lintangsutawika's avatar
lintangsutawika committed
956
957

        return Instance(
lintangsutawika's avatar
lintangsutawika committed
958
959
            request_type=self.OUTPUT_TYPE, doc=doc, arguments=arguments, idx=0, **kwargs
        )
960
961
962

    def process_results(self, doc, results):

963
964
        if callable(self.config.process_results):
            return self.config.process_results(doc, results)
lintangsutawika's avatar
lintangsutawika committed
965

966
        result_dict = {}
967
        use_metric = list(self._metric_fn_list.keys())
968
969
970
        if self.OUTPUT_TYPE == "loglikelihood":
            results = results[0]
            ll, is_greedy = results
971
972
973
974
            return {
                **({"perplexity": ll} if "perplexity" in use_metric else {}),
                **({"acc": int(is_greedy)} if "acc" in use_metric else {}),
            }
975
        elif self.OUTPUT_TYPE == "loglikelihood_rolling":
haileyschoelkopf's avatar
haileyschoelkopf committed
976
            (loglikelihood,) = results
977
978
            _words = self.count_words(self.doc_to_target(doc))
            _bytes = self.count_bytes(self.doc_to_target(doc))
haileyschoelkopf's avatar
haileyschoelkopf committed
979
            return {
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
                **(
                    {"word_perplexity": (loglikelihood, _words)}
                    if "word_perplexity" in use_metric
                    else {}
                ),
                **(
                    {"byte_perplexity": (loglikelihood, _bytes)}
                    if "byte_perplexity" in use_metric
                    else {}
                ),
                **(
                    {"bits_per_byte": (loglikelihood, _bytes)}
                    if "bits_per_byte" in use_metric
                    else {}
                ),
haileyschoelkopf's avatar
haileyschoelkopf committed
995
            }
996
        elif self.OUTPUT_TYPE == "multiple_choice":
997
            lls, is_greedy = zip(*results)
lintangsutawika's avatar
lintangsutawika committed
998

999
            # retrieve choices in List[str] form, to compute choice lengths, etc.
1000
            choices = self.doc_to_choice(doc)
1001
1002
            completion_len = np.array([float(len(i)) for i in choices])

1003
1004
            if (
                2 * len(choices) == len(lls)
1005
                and "acc_mutual_info" in self._metric_fn_list.keys()
1006
1007
1008
1009
1010
1011
1012
            ):
                # then we are doing mutual info.
                # this stores the "dryrun" / unconditional answer loglikelihoods
                lls_unconditional = lls[1::2]
                assert len(lls_unconditional) == len(choices)
                # and this stores our "regular" conditional loglikelihoods
                lls = lls[::2]
1013

1014
1015
            pred = np.argmax(lls)
            pred_norm = np.argmax(lls / completion_len)
lintangsutawika's avatar
lintangsutawika committed
1016

1017
1018
            if self.multiple_input:
                gold = self.doc_to_text(doc)
1019
            else:
1020
                gold = self.doc_to_target(doc)
1021
1022
1023

            gold_index_error = False
            if type(gold) is list:
Lintang Sutawika's avatar
Lintang Sutawika committed
1024
1025
                gold = [i if i < len(choices) else -100 for i in gold]
                if -100 in gold:
1026
1027
1028
                    gold_index_error = True
            else:
                if type(gold) is int:
Lintang Sutawika's avatar
Lintang Sutawika committed
1029
                    gold = gold if gold < len(choices) else -100
1030
                elif type(gold) is str:
Lintang Sutawika's avatar
Lintang Sutawika committed
1031
                    gold = choices.index(gold) if gold in choices else -100
lintangsutawika's avatar
lintangsutawika committed
1032

Lintang Sutawika's avatar
Lintang Sutawika committed
1033
                if gold == -100:
1034
1035
1036
1037
                    gold_index_error = True

            if gold_index_error:
                eval_logger.warning(
lintangsutawika's avatar
lintangsutawika committed
1038
                    f"Label index was not in within range of available choices,"
1039
1040
                    f"Sample:\n\n{doc}\n\n"
                )
lintangsutawika's avatar
lintangsutawika committed
1041

1042
            if self.multiple_target:
lintangsutawika's avatar
lintangsutawika committed
1043
1044
                acc = 1.0 if pred in gold else 0.0
                acc_norm = 1.0 if pred_norm in gold else 0.0
Lintang Sutawika's avatar
Lintang Sutawika committed
1045
                exact_match = int(any([is_greedy[i] if i != -100 else 0 for i in gold]))
lintangsutawika's avatar
lintangsutawika committed
1046
1047
1048
            else:
                acc = 1.0 if pred == gold else 0.0
                acc_norm = 1.0 if pred_norm == gold else 0.0
1049
                # TODO: this gets score of 0 on arc_challenge for pythia-70m. need to test that this works properly
Lintang Sutawika's avatar
Lintang Sutawika committed
1050
                exact_match = int(is_greedy[gold]) if gold != -100 else 0
1051
1052

            result_dict = {
1053
                **({"acc": acc} if "acc" in use_metric else {}),
1054
1055
                **({"f1": (gold, pred)} if "f1" in use_metric else {}),
                **({"mcc": (gold, pred)} if "mcc" in use_metric else {}),
1056
                **({"acc_norm": acc_norm} if "acc_norm" in use_metric else {}),
1057
                **({"exact_match": exact_match} if "exact_match" in use_metric else {}),
1058
1059
            }

1060
            if "acc_mutual_info" in use_metric:
lintangsutawika's avatar
lintangsutawika committed
1061
1062
1063
                lls_mutual_info = [
                    ll_c - ll_u for ll_c, ll_u in zip(lls, lls_unconditional)
                ]
1064
1065
1066
                acc_mutual_info = 1.0 if np.argmax(lls_mutual_info) == gold else 0.0
                result_dict["acc_mutual_info"] = acc_mutual_info

1067
        elif self.OUTPUT_TYPE == "greedy_until":
1068
            gold = self.doc_to_target(doc)
1069
            if self.config.doc_to_choice is not None:
lintangsutawika's avatar
lintangsutawika committed
1070
                # If you set doc_to_choice,
lintangsutawika's avatar
lintangsutawika committed
1071
                # it assumes that doc_to_target returns a number.
1072
1073
                choices = self.doc_to_choice(doc)
                gold = choices[gold]
1074
1075
            # we expect multiple_targets to be a list.
            elif self.multiple_target:
baberabb's avatar
baberabb committed
1076
                gold = list(gold)
lintangsutawika's avatar
lintangsutawika committed
1077
1078
            else:
                gold = str(gold)
1079

lintangsutawika's avatar
lintangsutawika committed
1080
            result = results[0]
lintangsutawika's avatar
lintangsutawika committed
1081
            for metric in self._metric_fn_list.keys():
haileyschoelkopf's avatar
haileyschoelkopf committed
1082
1083
1084
1085
1086
                if self.multiple_target:
                    # in the case where we have multiple targets,
                    # return true if any are true
                    # TODO: this may break for multipLe_target, non zero-or-1 metrics
                    scores = []
haileyschoelkopf's avatar
haileyschoelkopf committed
1087
1088
1089
1090
                    if not isinstance(gold, list):
                        # sometimes, a multiple_target dataset has exceptions where one doc has only one string answer
                        # print(gold)
                        gold = [gold]
haileyschoelkopf's avatar
haileyschoelkopf committed
1091
                    for gold_option in gold:
1092
                        try:
1093
                            result_score = self._metric_fn_list[metric](
1094
1095
                                references=[gold_option],
                                predictions=[result],
1096
                                **self._metric_fn_kwargs[metric],
1097
1098
                            )
                        except TypeError:  # TODO: this is hacky and I don't want to do it
1099
                            result_score = self._metric_fn_list[metric](
haileyschoelkopf's avatar
haileyschoelkopf committed
1100
1101
1102
                                [gold_option, result]
                            )
                        if isinstance(result_score, dict):
haileyschoelkopf's avatar
haileyschoelkopf committed
1103
                            # TODO: this handles the case where HF evaluate returns a dict.
1104
                            result_score = result_score[metric]
haileyschoelkopf's avatar
haileyschoelkopf committed
1105
                        scores.append(result_score)
haileyschoelkopf's avatar
haileyschoelkopf committed
1106
                    if any(scores):
1107
                        result_score = 1.0
haileyschoelkopf's avatar
haileyschoelkopf committed
1108
                    else:
1109
                        result_score = 0.0
haileyschoelkopf's avatar
haileyschoelkopf committed
1110
                else:
1111
                    try:
1112
                        result_score = self._metric_fn_list[metric](
1113
1114
                            references=[gold],
                            predictions=[result],
1115
                            **self._metric_fn_kwargs[metric],
1116
                        )
1117
1118
                    except TypeError:  # needed for now in order to use a different interface between our own metrics and HF Evaluate metrics
                        result_score = self._metric_fn_list[metric]([gold, result])
1119
1120
1121
1122
                    if isinstance(result_score, dict):
                        # TODO: this handles the case where HF evaluate returns a dict.
                        result_score = result_score[metric]
                result_dict[metric] = result_score
1123
        else:
lintangsutawika's avatar
lintangsutawika committed
1124
1125
            raise ValueError(
                f"Passed invalid output_type '{self.OUTPUT_TYPE}' ! Please use one of ",
1126
                "'loglikelihood', 'loglikelihood_rolling', 'greedy_until' or 'multiple_choice'",
1127
            )
1128
1129
1130
1131
1132
1133
1134

        return result_dict

    def aggregation(self):
        return self._aggregation_list

    def higher_is_better(self):
haileyschoelkopf's avatar
haileyschoelkopf committed
1135
        return self._higher_is_better
1136
1137
1138
1139
1140


class MultipleChoiceTask(Task):
    OUTPUT_TYPE: str = "loglikelihood"

baberabb's avatar
baberabb committed
1141
    def doc_to_target(self, doc: dict) -> str:
1142
1143
        return " " + doc["choices"][doc["gold"]]

baberabb's avatar
baberabb committed
1144
    def construct_requests(self, doc: dict, ctx: str, **kwargs) -> List[Instance]:
1145
        # TODO: add mutual info here?
lintangsutawika's avatar
lintangsutawika committed
1146
1147
        return [
            Instance(
haileyschoelkopf's avatar
haileyschoelkopf committed
1148
                request_type="loglikelihood",
lintangsutawika's avatar
lintangsutawika committed
1149
                doc=doc,
1150
                arguments=(ctx, " {}".format(choice)),
1151
                idx=i,
1152
1153
                **kwargs,
            )
lintangsutawika's avatar
lintangsutawika committed
1154
1155
            for i, choice in enumerate(doc["choices"])
        ]
1156

baberabb's avatar
baberabb committed
1157
    def process_results(self, doc: dict, results: List[Tuple[float, bool]]) -> dict:
lintangsutawika's avatar
lintangsutawika committed
1158
1159
1160
        results = [
            res[0] for res in results
        ]  # only retain loglikelihoods, discard is_greedy TODO: do we need is_greedy anywhere?
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
        gold = doc["gold"]

        acc = 1.0 if np.argmax(results) == gold else 0.0
        completion_len = np.array([float(len(i)) for i in doc["choices"]])
        acc_norm = 1.0 if np.argmax(results / completion_len) == gold else 0.0

        return {
            "acc": acc,
            "acc_norm": acc_norm,
        }

baberabb's avatar
baberabb committed
1172
    def higher_is_better(self) -> dict:
1173
1174
1175
1176
1177
        return {
            "acc": True,
            "acc_norm": True,
        }

baberabb's avatar
baberabb committed
1178
    def aggregation(self) -> dict:
1179
1180
1181
1182
1183
1184
        return {
            "acc": mean,
            "acc_norm": mean,
        }


lintangsutawika's avatar
lintangsutawika committed
1185
class PerplexityTask(Task):
1186
1187
    OUTPUT_TYPE = "loglikelihood_rolling"

baberabb's avatar
baberabb committed
1188
    def has_training_docs(self) -> bool:
1189
1190
        return False

baberabb's avatar
baberabb committed
1191
    def fewshot_examples(self, k: int, rnd) -> List:
1192
1193
1194
        assert k == 0
        return []

baberabb's avatar
baberabb committed
1195
    def fewshot_context(self, doc: dict, num_fewshot: int) -> Literal[""]:
1196
1197
1198
1199
1200
1201
        assert (
            num_fewshot == 0
        ), "The number of fewshot examples must be 0 for perplexity tasks."

        return ""

baberabb's avatar
baberabb committed
1202
    def higher_is_better(self) -> dict:
1203
1204
1205
1206
1207
1208
1209
1210
1211
        return {
            "word_perplexity": False,
            "byte_perplexity": False,
            "bits_per_byte": False,
        }

    def doc_to_decontamination_query(self, doc):
        return doc

Ethan Smith's avatar
Ethan Smith committed
1212
    def doc_to_text(self, doc) -> str:
1213
1214
1215
1216
1217
        return ""

    def doc_to_target(self, doc):
        return doc

baberabb's avatar
baberabb committed
1218
    def construct_requests(self, doc: dict, ctx: Union[str, None], **kwargs):
1219
1220
        assert not ctx

lintangsutawika's avatar
lintangsutawika committed
1221
1222
1223
1224
1225
1226
1227
        return Instance(
            request_type=self.OUTPUT_TYPE,
            doc=doc,
            arguments=(self.doc_to_target(doc),),
            idx=0,
            **kwargs,
        )
1228

baberabb's avatar
baberabb committed
1229
    def process_results(self, doc: dict, results: float) -> dict:
1230
        (loglikelihood,) = results
haileyschoelkopf's avatar
haileyschoelkopf committed
1231
1232
        words = self.count_words(self.doc_to_target(doc))
        bytes_ = self.count_bytes(self.doc_to_target(doc))
1233
1234
1235
1236
1237
1238
        return {
            "word_perplexity": (loglikelihood, words),
            "byte_perplexity": (loglikelihood, bytes_),
            "bits_per_byte": (loglikelihood, bytes_),
        }

baberabb's avatar
baberabb committed
1239
    def aggregation(self) -> dict:
1240
1241
1242
1243
1244
1245
1246
        return {
            "word_perplexity": weighted_perplexity,
            "byte_perplexity": weighted_perplexity,
            "bits_per_byte": bits_per_byte,
        }

    @classmethod
baberabb's avatar
baberabb committed
1247
    def count_bytes(cls, doc) -> int:
1248
1249
1250
        return len(doc.encode("utf-8"))

    @classmethod
baberabb's avatar
baberabb committed
1251
    def count_words(cls, doc) -> int:
1252
1253
        """Downstream tasks with custom word boundaries should override this!"""
        return len(re.split(r"\s+", doc))