Skip to content

docs: update README and CONTRIBUTING for dataset_id-based API and new tasks#44

Merged
Mattdl merged 11 commits intomainfrom
mdl-docs-refactor
Mar 4, 2026
Merged

docs: update README and CONTRIBUTING for dataset_id-based API and new tasks#44
Mattdl merged 11 commits intomainfrom
mdl-docs-refactor

Conversation

@Mattdl
Copy link
Collaborator

@Mattdl Mattdl commented Mar 4, 2026

Summary

  • README.md: Rewrite the metrics & aggregation section to document the new dataset → language → task → task_group → task_type aggregation chain, LanguageAggregationMode (4 modes), ExecutionMode (lazy/all), available ranking/classification metrics, and evaluate_multiple_models(). Move the tasks & models tables above the Usage Guide for better discoverability and add class names. Fix the checkpointing code example (wrong variable name, formatting).
  • CONTRIBUTING.md: Update the "Adding a New Task" guide to use the new load_dataset(dataset_id, split) signature (replacing load_monolingual_data), document cross-lingual/multi-dataset task overrides (languages_to_dataset_ids, get_dataset_languages), update test examples to use task.datasets[dataset_id] instead of task.lang_datasets[Language.EN], add sections on CI/CD workflows, conventional commit format, and keeping forks up-to-date with upstream.
  • Examples: Replace MELO/MELS TODO comments with actual task usage (MELORanking, MELSRanking) in all four benchmark example scripts.

Closes #43

federetyk and others added 11 commits February 26, 2026 18:04
Introduce the MELO (Multilingual Entity Linking of Occupations) and MELS
(Multilingual Entity Linking of Skills) benchmarks as new ranking tasks.

MELO provides 42 evaluation datasets spanning 21 languages for job title
normalization into ESCO, built from crosswalks between national occupation
taxonomies and ESCO published by official EU labor organizations. MELS
follows the same methodology but targets skill normalization, covering
5 languages with 8 datasets.

- Add MELORanking task class with 42 datasets across 21 languages
- Add MELSRanking task class with 8 datasets across 5 languages
- Implement get_dataset_languages() for both tasks, supporting
  monolingual and cross-lingual dataset variants
- Add Austria and Belgium datasets to MELO (6 additional dataset IDs)
- Add unit tests for dataset ID filtering and language mapping
- Update README and example scripts with new tasks
…erview, metrics overview, and example of running multiple models
@Mattdl Mattdl merged commit 1064cbb into main Mar 4, 2026
2 checks passed
@Mattdl Mattdl deleted the mdl-docs-refactor branch March 4, 2026 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Update documentation for execution loop and input/output language refactor

2 participants