Task naming convention¶
This document describes the naming convention for tasks in the eval-framework.
We use the task’s class name as its identifier, which is what needs to be passed to the
--task-name flag, what is logged in results, and what names the output directory.
[!NOTE] We are iteratively rolling out this naming convention. For now, we ask new tasks to follow it. However, the convention is not final and will be revised based on experience, so exceptions are possible if the PR gives a good reason. These exceptions should inform the next iteration of the convention. Once it is finalized, we will gradually migrate existing tasks to it as well.
Canonical grammar¶
All class names of tasks should follow the following grammar:
{Dataset}_{Source}_{Language}[_{Style}][_{Variant}][_{Subset}]
Fields in square brackets are optional, but we recommend using the Style field for likelihood tasks (to avoid having to rename them later, when we add a new style).
Note, internal base classes do not need to follow this grammar, but should start with _ and end with Base.
Field |
Rule |
Examples |
|---|---|---|
Dataset |
Shortest sensible, canonical capitalization, no hyphens |
|
Source |
E.g. HF org, capitalized first letter then canonical capitalization |
|
Language |
Prompt language, two-letter (ISO 639), uppercase, multi-lingual = |
|
Style |
Optional, (e.g. |
|
Variant |
Optional, after Style (e.g. |
|
Subset |
Optional trailing subset |
|
Dataset + Source + Language are mandatory and always present, in that order.
Examples:
Canonical class name |
Meaning |
|---|---|
|
ARC, AllenAI source, English, Cloze style |
|
…multiple-choice, OLMES variant |
|
…Cloze, “I don’t know” variant |
|
German ARC, LeoLM translation, Cloze |
|
German ARC, Ellamind translation, Cloze |
Naming notes¶
Additional notes on the naming convention:
MC vs MC_OLMES. If a dataset has a single multiple-choice task, name it
_MC. Only when both a default MC and an OLMES-style MC (with space before each label in the prompt) exist do we distinguish_MCand_MC_OLMES.Source is usually the HF org, canonical-capitalized (
allenai→AllenAI). However, sometimes datasets live in a personal HF account which might not be the institution we associate with that particular dataset. In these cases, use the originating institution when there is a single clear one and the HF path is just a mirror/personal handle (e.g.SQuAD→Stanford, notrajpurkar); when a dataset’s variants come from different repos, name each by its own source (e.g. DROP completion →EleutherAI, MC/Cloze →AllenAI). If we do use the person, and the handle is a clear name, use capitalization for the first letter of the first and surname, e.g.mandarjoshi→MandarJoshi.Capitalization. Names are case-sensitive. Write Style and Variant tokens exactly as listed above (
Cloze, notCLOZE;MC, notMc), and Language always in uppercase.Subset vs. subjects. A Subset is a separate version of the dataset that gets its own task class (e.g.
Diamond,Platinum,Easy/Hard). It is not one of the task’sSUBJECTS: subjects stay within a single task and are selected at runtime via--task-subjects.Multilingual. A single class spanning many languages uses
XX; per-language subclasses use the language code (GlobalMMLU_Cohere_XX_MC→GlobalMMLU_Cohere_DE_MC).