From df27a43ba7b20501b1370c19b4a7f68ca436a0a6 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:01:21 +0100 Subject: [PATCH 01/36] Add Reference docs with Pipeline docs --- docs/source/_toctree.yml | 6 ++++++ docs/source/package_reference/pipeline.mdx | 5 +++++ 2 files changed, 11 insertions(+) create mode 100644 docs/source/package_reference/pipeline.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 243462b3d..f7167c4ff 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -28,3 +28,9 @@ - local: available-tasks title: Available Tasks title: API +- sections: + - sections: + - local: package_reference/pipeline + title: Pipeline + title: Main classes + title: Reference diff --git a/docs/source/package_reference/pipeline.mdx b/docs/source/package_reference/pipeline.mdx new file mode 100644 index 000000000..aa0aeff3b --- /dev/null +++ b/docs/source/package_reference/pipeline.mdx @@ -0,0 +1,5 @@ +# Pipeline + +[[autodoc]] pipeline.Pipeline + +[[autodoc]] pipeline.PipelineParameters From afb0ce2cac1754a14f7839ec0f4fa25cb90c3f43 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:27:51 +0100 Subject: [PATCH 02/36] Pin numpy<2 --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index a779ebf4c..7d17c8d13 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -59,6 +59,7 @@ dependencies = [ "torch>=2.0,<2.5", "GitPython>=3.1.41", # for logging "datasets>=2.14.0", + "numpy<2", # pinned to avoid incompatibilities # Prettiness "termcolor==2.3.0", "pytablewriter", From 696416f791644cb4048e0696082e22112beb6760 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:37:56 +0100 Subject: [PATCH 03/36] Add Tasks docs --- docs/source/_toctree.yml | 2 ++ docs/source/package_reference/tasks.mdx | 3 +++ 2 files changed, 5 insertions(+) create mode 100644 docs/source/package_reference/tasks.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index f7167c4ff..aa3e0559e 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -32,5 +32,7 @@ - sections: - local: package_reference/pipeline title: Pipeline + - local: package_reference/tasks + title: Tasks title: Main classes title: Reference diff --git a/docs/source/package_reference/tasks.mdx b/docs/source/package_reference/tasks.mdx new file mode 100644 index 000000000..8dc77a2d7 --- /dev/null +++ b/docs/source/package_reference/tasks.mdx @@ -0,0 +1,3 @@ +# Tasks + +[[autodoc]] tasks.lighteval_task.LightevalTask From 89b25815ea4185ce501dc017e7c967ed639463a2 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:54:30 +0100 Subject: [PATCH 04/36] Add more Tasks docs --- docs/source/package_reference/tasks.mdx | 26 +++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/source/package_reference/tasks.mdx b/docs/source/package_reference/tasks.mdx index 8dc77a2d7..4f8914f52 100644 --- a/docs/source/package_reference/tasks.mdx +++ b/docs/source/package_reference/tasks.mdx @@ -1,3 +1,29 @@ # Tasks +## LightevalTask + [[autodoc]] tasks.lighteval_task.LightevalTask + +[[autodoc]] tasks.lighteval_task.LightevalTaskConfig + +## PromptManager + +[[autodoc]] tasks.prompt_manager.PromptManager + +## Registry + +[[autodoc]] tasks.registry.Registry + +## Requests + +[[autodoc]] tasks.requests.Request + +[[autodoc]] tasks.requests.LoglikelihoodRequest + +[[autodoc]] tasks.requests.LoglikelihoodSingleTokenRequest + +[[autodoc]] tasks.requests.LoglikelihoodRollingRequest + +[[autodoc]] tasks.requests.GreedyUntilRequest + +[[autodoc]] tasks.requests.GreedyUntilMultiTurnRequest From 77f779ab85e61b313d36724cb3103c40655a5879 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:57:02 +0100 Subject: [PATCH 05/36] Add Models docs --- docs/source/_toctree.yml | 2 ++ docs/source/package_reference/models.mdx | 17 +++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 docs/source/package_reference/models.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index aa3e0559e..883f1ca9f 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -30,6 +30,8 @@ title: API - sections: - sections: + - local: package_reference/models + title: Models - local: package_reference/pipeline title: Pipeline - local: package_reference/tasks diff --git a/docs/source/package_reference/models.mdx b/docs/source/package_reference/models.mdx new file mode 100644 index 000000000..80c136669 --- /dev/null +++ b/docs/source/package_reference/models.mdx @@ -0,0 +1,17 @@ +# Models + +[[autodoc]] models.base_model.BaseModel + +[[autodoc]] AdapterModel + +[[autodoc]] DeltaModel + +[[autodoc]] InferenceEndpointModel + +[[autodoc]] LightevalModel + +[[autodoc]] ModelClient + +[[autodoc]] NanotronLightevalModel + +[[autodoc]] OpenAIClient From aaeee7b14c8e2effee05fd5e287b010411f84aa6 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 14:04:35 +0100 Subject: [PATCH 06/36] Fix Models docs --- docs/source/package_reference/models.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/package_reference/models.mdx b/docs/source/package_reference/models.mdx index 80c136669..4af43a7b3 100644 --- a/docs/source/package_reference/models.mdx +++ b/docs/source/package_reference/models.mdx @@ -2,16 +2,16 @@ [[autodoc]] models.base_model.BaseModel -[[autodoc]] AdapterModel +[[autodoc]] models.adapter_model.AdapterModel -[[autodoc]] DeltaModel +[[autodoc]] models.delta_model.DeltaModel -[[autodoc]] InferenceEndpointModel +[[autodoc]] models.endpoint_model.InferenceEndpointModel -[[autodoc]] LightevalModel +[[autodoc]] models.abstract_model.LightevalModel -[[autodoc]] ModelClient +[[autodoc]] models.tgi_model.ModelClient -[[autodoc]] NanotronLightevalModel +[[autodoc]] models.nanotron_model.NanotronLightevalModel -[[autodoc]] OpenAIClient +[[autodoc]] models.vllm_model.VLLMModel From e46b1d3f4e8b4d0f91c7b7b2332c0c72f8e32e54 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 14:08:53 +0100 Subject: [PATCH 07/36] Remove AdapterModel that requires peft --- docs/source/package_reference/models.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/package_reference/models.mdx b/docs/source/package_reference/models.mdx index 4af43a7b3..cf5b3b3e4 100644 --- a/docs/source/package_reference/models.mdx +++ b/docs/source/package_reference/models.mdx @@ -2,7 +2,7 @@ [[autodoc]] models.base_model.BaseModel -[[autodoc]] models.adapter_model.AdapterModel +{/* [[autodoc]] models.adapter_model.AdapterModel */} [[autodoc]] models.delta_model.DeltaModel From 17c8088ec1999db59ad1eced9667fd310d5e7feb Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 14:13:17 +0100 Subject: [PATCH 08/36] Remove NanotronLightevalModel and VLLMModel that require nanotron and vllm --- docs/source/package_reference/models.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/package_reference/models.mdx b/docs/source/package_reference/models.mdx index cf5b3b3e4..af3149a22 100644 --- a/docs/source/package_reference/models.mdx +++ b/docs/source/package_reference/models.mdx @@ -12,6 +12,6 @@ [[autodoc]] models.tgi_model.ModelClient -[[autodoc]] models.nanotron_model.NanotronLightevalModel +{/* [[autodoc]] models.nanotron_model.NanotronLightevalModel */} -[[autodoc]] models.vllm_model.VLLMModel +{/* [[autodoc]] models.vllm_model.VLLMModel */} From ee937bbe839e3d0f8731bc48f49fca102a9f3cec Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 14:22:11 +0100 Subject: [PATCH 09/36] Fix markdown comment syntax --- docs/source/package_reference/models.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/package_reference/models.mdx b/docs/source/package_reference/models.mdx index af3149a22..7a82f5a46 100644 --- a/docs/source/package_reference/models.mdx +++ b/docs/source/package_reference/models.mdx @@ -2,7 +2,7 @@ [[autodoc]] models.base_model.BaseModel -{/* [[autodoc]] models.adapter_model.AdapterModel */} +[//]: # ([[autodoc]] models.adapter_model.AdapterModel) [[autodoc]] models.delta_model.DeltaModel @@ -12,6 +12,6 @@ [[autodoc]] models.tgi_model.ModelClient -{/* [[autodoc]] models.nanotron_model.NanotronLightevalModel */} +[//]: # ([[autodoc]] models.nanotron_model.NanotronLightevalModel) -{/* [[autodoc]] models.vllm_model.VLLMModel */} +[//]: # ([[autodoc]] models.vllm_model.VLLMModel) From 6ad6a2fc9a4d7b45d95f1b6b9c22723def09ca16 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 14:54:45 +0100 Subject: [PATCH 10/36] Add Metrics docs --- docs/source/_toctree.yml | 2 ++ docs/source/package_reference/metrics.mdx | 35 +++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 docs/source/package_reference/metrics.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 883f1ca9f..9167cd078 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -30,6 +30,8 @@ title: API - sections: - sections: + - local: package_reference/metrics + title: Metrics - local: package_reference/models title: Models - local: package_reference/pipeline diff --git a/docs/source/package_reference/metrics.mdx b/docs/source/package_reference/metrics.mdx new file mode 100644 index 000000000..52c88b05c --- /dev/null +++ b/docs/source/package_reference/metrics.mdx @@ -0,0 +1,35 @@ +# Metrics + +## Corpus Metrics + +[[autodoc]] metrics.metrics_corpus.CorpusLevelF1Score + +[[autodoc]] metrics.metrics_corpus.CorpusLevelPerplexityMetric + +[[autodoc]] metrics.metrics_corpus.CCorpusLevelTranslationMetric + +## Sample Metrics + +[[autodoc]] metrics.metrics_sample.ExactMatches +[[autodoc]] metrics.metrics_sample.F1_score +[[autodoc]] metrics.metrics_sample.LoglikelihoodAcc +[[autodoc]] metrics.metrics_sample.NormalizedMultiChoiceProbability +[[autodoc]] metrics.metrics_sample.Probability +[[autodoc]] metrics.metrics_sample.Recall +[[autodoc]] metrics.metrics_sample.MRR +[[autodoc]] metrics.metrics_sample.ROUGE +[[autodoc]] metrics.metrics_sample.BertScore +[[autodoc]] metrics.metrics_sample.Extractiveness +[[autodoc]] metrics.metrics_sample.Faithfulness +[[autodoc]] metrics.metrics_sample.BLEURT +[[autodoc]] metrics.metrics_sample.BLEU +[[autodoc]] metrics.metrics_sample.StringDistance +[[autodoc]] metrics.metrics_sample.JudgeLLM +[[autodoc]] metrics.metrics_sample.JudgeLLMMTBench +[[autodoc]] metrics.metrics_sample.JudgeLLMMixEval +[[autodoc]] metrics.metrics_sample.JudgeLLMMixEval +[[autodoc]] metrics.metrics_sample.MajAtK + +## LLM-as-a-Judge + +[[autodoc]] metrics.llm_as_judge.JudgeLM From 7874f1bd8af94704bd3be367cfa7fda2883566e7 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 14:56:58 +0100 Subject: [PATCH 11/36] Fix typo --- docs/source/package_reference/metrics.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/package_reference/metrics.mdx b/docs/source/package_reference/metrics.mdx index 52c88b05c..d7e38fd8f 100644 --- a/docs/source/package_reference/metrics.mdx +++ b/docs/source/package_reference/metrics.mdx @@ -6,7 +6,7 @@ [[autodoc]] metrics.metrics_corpus.CorpusLevelPerplexityMetric -[[autodoc]] metrics.metrics_corpus.CCorpusLevelTranslationMetric +[[autodoc]] metrics.metrics_corpus.CorpusLevelTranslationMetric ## Sample Metrics From bb1a20ac00821e846c922c2d619b73ebd9cbff62 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:01:48 +0100 Subject: [PATCH 12/36] Remove Main classes section --- docs/source/_toctree.yml | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 9167cd078..60d0a146d 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -29,14 +29,12 @@ title: Available Tasks title: API - sections: - - sections: - - local: package_reference/metrics - title: Metrics - - local: package_reference/models - title: Models - - local: package_reference/pipeline - title: Pipeline - - local: package_reference/tasks - title: Tasks - title: Main classes + - local: package_reference/metrics + title: Metrics + - local: package_reference/models + title: Models + - local: package_reference/pipeline + title: Pipeline + - local: package_reference/tasks + title: Tasks title: Reference From d281f10f6a8cf15f86602352acf49e7627d43e27 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:06:25 +0100 Subject: [PATCH 13/36] Add Datasets docs --- docs/source/_toctree.yml | 2 ++ docs/source/package_reference/datasets.mdx | 8 ++++++++ 2 files changed, 10 insertions(+) create mode 100644 docs/source/package_reference/datasets.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 60d0a146d..3719863a6 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -29,6 +29,8 @@ title: Available Tasks title: API - sections: + - local: package_reference/datasets + title: Datasets - local: package_reference/metrics title: Metrics - local: package_reference/models diff --git a/docs/source/package_reference/datasets.mdx b/docs/source/package_reference/datasets.mdx new file mode 100644 index 000000000..3594581b5 --- /dev/null +++ b/docs/source/package_reference/datasets.mdx @@ -0,0 +1,8 @@ +# Datasets + +[[autodoc]] data.DynamicBatchDataset +[[autodoc]] data.LoglikelihoodDataset +[[autodoc]] data.LoglikelihoodSingleTokenDataset +[[autodoc]] data.GenerativeTaskDataset +[[autodoc]] data.GenerativeTaskDatasetNanotron +[[autodoc]] data.GenDistributedSampler From 812ef3530abcd96c99089ac365aa154c8ca203a0 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:21:03 +0100 Subject: [PATCH 14/36] Create Main classes section with Pipeline --- docs/source/_toctree.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 3719863a6..44e4d608a 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -29,14 +29,16 @@ title: Available Tasks title: API - sections: + - sections: + - local: package_reference/pipeline + title: Pipeline + title: Main classes - local: package_reference/datasets title: Datasets - local: package_reference/metrics title: Metrics - local: package_reference/models title: Models - - local: package_reference/pipeline - title: Pipeline - local: package_reference/tasks title: Tasks title: Reference From 632e89b046d546113bce1ed9bab73695c55b1988 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:25:25 +0100 Subject: [PATCH 15/36] Add EvaluationTracker docs --- docs/source/_toctree.yml | 2 ++ docs/source/package_reference/evaluation_tracker.mdx | 3 +++ 2 files changed, 5 insertions(+) create mode 100644 docs/source/package_reference/evaluation_tracker.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 44e4d608a..b2a1a4172 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -30,6 +30,8 @@ title: API - sections: - sections: + - local: package_reference/evaluation_tracker + title: EvaluationTracker - local: package_reference/pipeline title: Pipeline title: Main classes diff --git a/docs/source/package_reference/evaluation_tracker.mdx b/docs/source/package_reference/evaluation_tracker.mdx new file mode 100644 index 000000000..87dc90b7a --- /dev/null +++ b/docs/source/package_reference/evaluation_tracker.mdx @@ -0,0 +1,3 @@ +# EvaluationTracker + +[[autodoc]] logging.evaluation_tracker.EvaluationTracker From 3e53ddb8919ac298b8970e315715e9de6449ba07 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:39:01 +0100 Subject: [PATCH 16/36] Add ModelConfig docs --- docs/source/_toctree.yml | 2 ++ docs/source/package_reference/model_config.mdx | 12 ++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 docs/source/package_reference/model_config.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index b2a1a4172..062f7b4d2 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -32,6 +32,8 @@ - sections: - local: package_reference/evaluation_tracker title: EvaluationTracker + - local: package_reference/model_config + title: ModelConfig - local: package_reference/pipeline title: Pipeline title: Main classes diff --git a/docs/source/package_reference/model_config.mdx b/docs/source/package_reference/model_config.mdx new file mode 100644 index 000000000..c70258bb5 --- /dev/null +++ b/docs/source/package_reference/model_config.mdx @@ -0,0 +1,12 @@ +# ModelConfig + +[[autodoc]] models.model_config.BaseModelConfig + +[[autodoc]] models.model_config.AdapterModelConfig +[[autodoc]] models.model_config.DeltaModelConfig +[[autodoc]] models.model_config.InferenceEndpointModelConfig +[[autodoc]] models.model_config.InferenceModelConfig +[[autodoc]] models.model_config.TGIModelConfig +[[autodoc]] models.model_config.VLLMModelConfig + +[[autodoc]] models.model_config.create_model_config From ea6af22fb18eec38213eb4513d71dd577c5a1b25 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:41:48 +0100 Subject: [PATCH 17/36] Add ParallelismManager to Pipeline docs --- docs/source/package_reference/pipeline.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/package_reference/pipeline.mdx b/docs/source/package_reference/pipeline.mdx index aa0aeff3b..3473abb3d 100644 --- a/docs/source/package_reference/pipeline.mdx +++ b/docs/source/package_reference/pipeline.mdx @@ -1,5 +1,13 @@ # Pipeline +## Pipeline + [[autodoc]] pipeline.Pipeline +## PipelineParameters + [[autodoc]] pipeline.PipelineParameters + +## ParallelismManager + +[[autodoc]] pipeline.ParallelismManager From 7a413accec0f18afe46bfd9389a9af22524f5f4c Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:59:23 +0100 Subject: [PATCH 18/36] Add inter-links from using-the-python-api --- docs/source/using-the-python-api.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/using-the-python-api.mdx b/docs/source/using-the-python-api.mdx index 82238c7f1..364559a3d 100644 --- a/docs/source/using-the-python-api.mdx +++ b/docs/source/using-the-python-api.mdx @@ -1,8 +1,8 @@ # Using the Python API Lighteval can be used from a custom python script. To evaluate a model you will -need to setup an `evaluation_tracker`, `pipeline_parameters`, `model_config` -and a `pipeline`. +need to setup an [`EvaluationTracker`], [`PipelineParameters`], [`model_config`](package_reference/model_config) +and a [`Pipeline`]. After that, simply run the pipeline and save the results. From 4e9c80b6246ac62c16f319503907941a559298b7 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Fri, 29 Nov 2024 16:12:24 +0100 Subject: [PATCH 19/36] Fix inter-links --- docs/source/using-the-python-api.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/using-the-python-api.mdx b/docs/source/using-the-python-api.mdx index 364559a3d..2a12c4fac 100644 --- a/docs/source/using-the-python-api.mdx +++ b/docs/source/using-the-python-api.mdx @@ -1,8 +1,8 @@ # Using the Python API -Lighteval can be used from a custom python script. To evaluate a model you will -need to setup an [`EvaluationTracker`], [`PipelineParameters`], [`model_config`](package_reference/model_config) -and a [`Pipeline`]. +Lighteval can be used from a custom python script. To evaluate a model you will need to setup an +[`~logging.evaluation_tracker.EvaluationTracker`], [`~pipeline.PipelineParameters`], +[`model_config`](package_reference/model_config) and a [`~pipeline.Pipeline`]. After that, simply run the pipeline and save the results. From 9955186cf6457cdddceb3ef0d757a4de073c8ccb Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 10:09:46 +0100 Subject: [PATCH 20/36] Add more Metrics docs --- docs/source/package_reference/metrics.mdx | 42 +++++++++++++++++++---- 1 file changed, 35 insertions(+), 7 deletions(-) diff --git a/docs/source/package_reference/metrics.mdx b/docs/source/package_reference/metrics.mdx index d7e38fd8f..0a99073de 100644 --- a/docs/source/package_reference/metrics.mdx +++ b/docs/source/package_reference/metrics.mdx @@ -1,35 +1,63 @@ # Metrics -## Corpus Metrics +## Metrics +### Metrics +[[autodoc]] metrics.metrics.Metrics +### Metric +[[autodoc]] metrics.utils.metric_utils.Metric +### CorpusLevelMetric +[[autodoc]] metrics.utils.metric_utils.CorpusLevelMetric +### SampleLevelMetric +[[autodoc]] metrics.utils.metric_utils.SampleLevelMetric +## Corpus Metrics +### CorpusLevelF1Score [[autodoc]] metrics.metrics_corpus.CorpusLevelF1Score - +### CorpusLevelPerplexityMetric [[autodoc]] metrics.metrics_corpus.CorpusLevelPerplexityMetric - +### CorpusLevelTranslationMetric [[autodoc]] metrics.metrics_corpus.CorpusLevelTranslationMetric +### matthews_corrcoef +[[autodoc]] metrics.metrics_corpus.matthews_corrcoef ## Sample Metrics - +### ExactMatches [[autodoc]] metrics.metrics_sample.ExactMatches +### F1_score [[autodoc]] metrics.metrics_sample.F1_score +### LoglikelihoodAcc [[autodoc]] metrics.metrics_sample.LoglikelihoodAcc +### NormalizedMultiChoiceProbability [[autodoc]] metrics.metrics_sample.NormalizedMultiChoiceProbability +### Probability [[autodoc]] metrics.metrics_sample.Probability +### Recall [[autodoc]] metrics.metrics_sample.Recall +### MRR [[autodoc]] metrics.metrics_sample.MRR +### ROUGE [[autodoc]] metrics.metrics_sample.ROUGE +### BertScore [[autodoc]] metrics.metrics_sample.BertScore +### Extractiveness [[autodoc]] metrics.metrics_sample.Extractiveness +### Faithfulness [[autodoc]] metrics.metrics_sample.Faithfulness +### BLEURT [[autodoc]] metrics.metrics_sample.BLEURT -[[autodoc]] metrics.metrics_sample.BLEU +### BLEU +[[autodoc]] metrics.metrics_sample. +### StringDistance [[autodoc]] metrics.metrics_sample.StringDistance +### JudgeLLM [[autodoc]] metrics.metrics_sample.JudgeLLM +### JudgeLLMMTBench [[autodoc]] metrics.metrics_sample.JudgeLLMMTBench +### JudgeLLMMixEval [[autodoc]] metrics.metrics_sample.JudgeLLMMixEval -[[autodoc]] metrics.metrics_sample.JudgeLLMMixEval +### MajAtK [[autodoc]] metrics.metrics_sample.MajAtK ## LLM-as-a-Judge - +### JudgeLM [[autodoc]] metrics.llm_as_judge.JudgeLM From 82a8fcbb04e824ddd0aa729e89b1a8999ff8144a Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 10:17:13 +0100 Subject: [PATCH 21/36] Comment Metrics enum --- docs/source/package_reference/metrics.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/package_reference/metrics.mdx b/docs/source/package_reference/metrics.mdx index 0a99073de..8b4e85fc4 100644 --- a/docs/source/package_reference/metrics.mdx +++ b/docs/source/package_reference/metrics.mdx @@ -1,8 +1,8 @@ # Metrics ## Metrics -### Metrics -[[autodoc]] metrics.metrics.Metrics +[//]: # (### Metrics) +[//]: # ([[autodoc]] metrics.metrics.Metrics) ### Metric [[autodoc]] metrics.utils.metric_utils.Metric ### CorpusLevelMetric From 6a08f011f0f9e6322700f74781c251b4e0cb6d25 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 10:22:29 +0100 Subject: [PATCH 22/36] Fix typo --- docs/source/package_reference/metrics.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/package_reference/metrics.mdx b/docs/source/package_reference/metrics.mdx index 8b4e85fc4..f2203f6d5 100644 --- a/docs/source/package_reference/metrics.mdx +++ b/docs/source/package_reference/metrics.mdx @@ -46,7 +46,7 @@ ### BLEURT [[autodoc]] metrics.metrics_sample.BLEURT ### BLEU -[[autodoc]] metrics.metrics_sample. +[[autodoc]] metrics.metrics_sample.BLEU ### StringDistance [[autodoc]] metrics.metrics_sample.StringDistance ### JudgeLLM From 95ac6d52816dc6988f565105975446e793767f00 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 13:38:19 +0100 Subject: [PATCH 23/36] Add explanation and GH issue to comment in Metrics enum --- docs/source/package_reference/metrics.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/package_reference/metrics.mdx b/docs/source/package_reference/metrics.mdx index f2203f6d5..0945531e0 100644 --- a/docs/source/package_reference/metrics.mdx +++ b/docs/source/package_reference/metrics.mdx @@ -1,6 +1,7 @@ # Metrics ## Metrics +[//]: # (TODO: aenum.Enum raises error when generating docs: not supported by inspect.signature. See: https://github.com/ethanfurman/aenum/issues/44) [//]: # (### Metrics) [//]: # ([[autodoc]] metrics.metrics.Metrics) ### Metric From 5962be66d001e29f16aba134426f45f574380e31 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 13:50:59 +0100 Subject: [PATCH 24/36] Add inter-link to Metrics --- docs/source/adding-a-custom-task.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/adding-a-custom-task.mdx b/docs/source/adding-a-custom-task.mdx index bcaa932ff..77d53caa9 100644 --- a/docs/source/adding-a-custom-task.mdx +++ b/docs/source/adding-a-custom-task.mdx @@ -45,8 +45,9 @@ def prompt_fn(line, task_name: str = None): ) ``` -Then, you need to choose a metric, you can either use an existing one (defined -in `lighteval/metrics/metrics.py`) or [create a custom one](adding-a-new-metric)). +Then, you need to choose a metric: you can either use an existing one (defined +in [`lighteval.metrics.metrics.Metrics`]) or [create a custom one](adding-a-new-metric)). +[//]: # (TODO: Replace lighteval.metrics.metrics.Metrics with ~metrics.metrics.Metrics once its autodoc is added) ```python custom_metric = SampleLevelMetric( From 6eb234804296746f3406bc0669112c558c1e6a57 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 10:34:40 +0100 Subject: [PATCH 25/36] Add subsection titles to LightevalTask --- docs/source/package_reference/tasks.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/package_reference/tasks.mdx b/docs/source/package_reference/tasks.mdx index 4f8914f52..1ccd1e0b8 100644 --- a/docs/source/package_reference/tasks.mdx +++ b/docs/source/package_reference/tasks.mdx @@ -1,10 +1,10 @@ # Tasks ## LightevalTask - -[[autodoc]] tasks.lighteval_task.LightevalTask - +### LightevalTaskConfig [[autodoc]] tasks.lighteval_task.LightevalTaskConfig +### LightevalTask +[[autodoc]] tasks.lighteval_task.LightevalTask ## PromptManager From bb4c95c160114e99b9803cb2c5c4f3efbc8bbac2 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 10:42:16 +0100 Subject: [PATCH 26/36] Add inter-link to LightevalTaskConfig --- docs/source/adding-a-custom-task.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/adding-a-custom-task.mdx b/docs/source/adding-a-custom-task.mdx index 77d53caa9..752c4e547 100644 --- a/docs/source/adding-a-custom-task.mdx +++ b/docs/source/adding-a-custom-task.mdx @@ -60,7 +60,8 @@ custom_metric = SampleLevelMetric( ) ``` -Then, you need to define your task. You can define a task with or without subsets. +Then, you need to define your task using [`~tasks.lighteval_task.LightevalTaskConfig`]. +You can define a task with or without subsets. To define a task with no subsets: ```python From 7153bfe0bb8dd0b5c7d4e4750985204b9491ec4b Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 13:39:19 +0100 Subject: [PATCH 27/36] Add inter-link to section heading anchor --- docs/source/adding-a-new-metric.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/adding-a-new-metric.mdx b/docs/source/adding-a-new-metric.mdx index e8562af4f..8540ad42d 100644 --- a/docs/source/adding-a-new-metric.mdx +++ b/docs/source/adding-a-new-metric.mdx @@ -1,8 +1,8 @@ # Adding a New Metric First, check if you can use one of the parametrized functions in -[src.lighteval.metrics.metrics_corpus]() or -[src.lighteval.metrics.metrics_sample](). +[Corpus Metrics](package_reference/metrics#corpus-metrics) or +[Sample Metrics](package_reference/metrics#sample-metrics). If not, you can use the `custom_task` system to register your new metric: From ae8ce6213810877d8b2b7eee415f458eca3167a3 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 14:06:59 +0100 Subject: [PATCH 28/36] Add more Metrics docs --- docs/source/package_reference/metrics.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/package_reference/metrics.mdx b/docs/source/package_reference/metrics.mdx index 0945531e0..57c656966 100644 --- a/docs/source/package_reference/metrics.mdx +++ b/docs/source/package_reference/metrics.mdx @@ -10,6 +10,12 @@ [[autodoc]] metrics.utils.metric_utils.CorpusLevelMetric ### SampleLevelMetric [[autodoc]] metrics.utils.metric_utils.SampleLevelMetric +### MetricGrouping +[[autodoc]] metrics.utils.metric_utils.MetricGrouping +### CorpusLevelMetricGrouping +[[autodoc]] metrics.utils.metric_utils.CorpusLevelMetricGrouping +### SampleLevelMetricGrouping +[[autodoc]] metrics.utils.metric_utils.SampleLevelMetricGrouping ## Corpus Metrics ### CorpusLevelF1Score From 9849a96aa0f380f9d0d76187dbb10d4fab32a43b Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 14:09:20 +0100 Subject: [PATCH 29/36] Add inter-link to SampleLevelMetric and Grouping --- docs/source/adding-a-new-metric.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/adding-a-new-metric.mdx b/docs/source/adding-a-new-metric.mdx index 8540ad42d..35fc975f8 100644 --- a/docs/source/adding-a-new-metric.mdx +++ b/docs/source/adding-a-new-metric.mdx @@ -49,7 +49,8 @@ def agg_function(items): return score ``` -Finally, you can define your metric. If it's a sample level metric, you can use the following code: +Finally, you can define your metric. If it's a sample level metric, you can use the following code +with [`~metrics.utils.metric_utils.SampleLevelMetric`]: ```python my_custom_metric = SampleLevelMetric( @@ -62,7 +63,8 @@ my_custom_metric = SampleLevelMetric( ) ``` -If your metric defines multiple metrics per sample, you can use the following code: +If your metric defines multiple metrics per sample, you can use the following code +with [`~metrics.utils.metric_utils.SampleLevelMetricGrouping`]: ```python custom_metric = SampleLevelMetricGrouping( From c5250e7798e4eb88e3313c2fdbd8804061d40fe6 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 14:19:52 +0100 Subject: [PATCH 30/36] Add inter-link to LightevalTaskConfig --- docs/source/contributing-to-multilingual-evaluations.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/contributing-to-multilingual-evaluations.mdx b/docs/source/contributing-to-multilingual-evaluations.mdx index 25779bc38..0d0855d75 100644 --- a/docs/source/contributing-to-multilingual-evaluations.mdx +++ b/docs/source/contributing-to-multilingual-evaluations.mdx @@ -51,7 +51,7 @@ Browse the list of all templates [here](https://github.com/huggingface/lighteval Then, when ready, to define your own task, you should: 1. create a Python file as indicated in the above guide 2. import the relevant templates for your task type (XNLI, Copa, Multiple choice, Question Answering, etc) -3. define one or a list of tasks for each relevant language and evaluation formulation (for multichoice) using our parametrizable `LightevalTaskConfig` class +3. define one or a list of tasks for each relevant language and evaluation formulation (for multichoice) using our parametrizable [`~tasks.lighteval_task.LightevalTaskConfig`] class ```python your_tasks = [ @@ -101,7 +101,7 @@ your_tasks = [ 4. then, you can go back to the guide to test if your task is correctly implemented! > [!TIP] -> All `LightevalTaskConfig` parameters are strongly typed, including the inputs to the template function. Make sure to take advantage of your IDE's functionality to make it easier to correctly fill these parameters. +> All [`~tasks.lighteval_task.LightevalTaskConfig`] parameters are strongly typed, including the inputs to the template function. Make sure to take advantage of your IDE's functionality to make it easier to correctly fill these parameters. -Once everything is good, open a PR, and we'll be happy to review it! \ No newline at end of file +Once everything is good, open a PR, and we'll be happy to review it! From f2ead25e7df3b3302dd45a7729e2d455d0959d30 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Sat, 30 Nov 2024 14:21:04 +0100 Subject: [PATCH 31/36] Fix section title with trailing colon --- docs/source/metric-list.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/metric-list.mdx b/docs/source/metric-list.mdx index 0ab03afb9..c7aefefd2 100644 --- a/docs/source/metric-list.mdx +++ b/docs/source/metric-list.mdx @@ -69,7 +69,7 @@ These metrics need the model to generate an output. They are therefore slower. - `quasi_exact_match_gsm8k`: Fraction of instances where the normalized prediction matches the normalized gold (normalization done for gsm8k, where latex symbols, units, etc are removed) - `maj_at_8_gsm8k`: Majority choice evaluation, using the gsm8k normalisation for the predictions and gold -## LLM-as-Judge: +## LLM-as-Judge - `llm_judge_gpt3p5`: Can be used for any generative task, the model will be scored by a GPT3.5 model using the OpenAI API - `llm_judge_llama_3_405b`: Can be used for any generative task, the model will be scored by a Llama 3.405B model using the HuggingFace API - `llm_judge_multi_turn_gpt3p5`: Can be used for any generative task, the model will be scored by a GPT3.5 model using the OpenAI API. It is used for multiturn tasks like mt-bench. From b2d82e3e68055ffb9a4c6c94933c08479481481d Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Tue, 3 Dec 2024 07:31:27 +0100 Subject: [PATCH 32/36] Add sections to Models docs --- docs/source/package_reference/models.mdx | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/source/package_reference/models.mdx b/docs/source/package_reference/models.mdx index 7a82f5a46..a04c9eef9 100644 --- a/docs/source/package_reference/models.mdx +++ b/docs/source/package_reference/models.mdx @@ -1,17 +1,30 @@ # Models -[[autodoc]] models.base_model.BaseModel +## Model +### LightevalModel +[[autodoc]] models.abstract_model.LightevalModel +## Accelerate and Transformers Models +### BaseModel +[[autodoc]] models.base_model.BaseModel +[//]: # (TODO: Fix import error) +[//]: # (### AdapterModel) [//]: # ([[autodoc]] models.adapter_model.AdapterModel) - +### DeltaModel [[autodoc]] models.delta_model.DeltaModel +## Inference Endpoints and TGI Models +### InferenceEndpointModel [[autodoc]] models.endpoint_model.InferenceEndpointModel - -[[autodoc]] models.abstract_model.LightevalModel - +### ModelClient [[autodoc]] models.tgi_model.ModelClient +[//]: # (TODO: Fix import error) +[//]: # (## Nanotron Model) +[//]: # (### NanotronLightevalModel) [//]: # ([[autodoc]] models.nanotron_model.NanotronLightevalModel) +[//]: # (TODO: Fix import error) +[//]: # (## VLLM Model) +[//]: # (### VLLMModel) [//]: # ([[autodoc]] models.vllm_model.VLLMModel) From c4ea6998d64339f2e098be9925979aec8bfa0f1d Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Tue, 3 Dec 2024 07:33:11 +0100 Subject: [PATCH 33/36] Move Models docs to Main classes section --- docs/source/_toctree.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 062f7b4d2..8a3666ea5 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -32,6 +32,8 @@ - sections: - local: package_reference/evaluation_tracker title: EvaluationTracker + - local: package_reference/models + title: Models - local: package_reference/model_config title: ModelConfig - local: package_reference/pipeline @@ -41,8 +43,6 @@ title: Datasets - local: package_reference/metrics title: Metrics - - local: package_reference/models - title: Models - local: package_reference/tasks title: Tasks title: Reference From 39e145b63f50995b7581d14fa3ad4ba1f2dc0c61 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Tue, 3 Dec 2024 07:40:54 +0100 Subject: [PATCH 34/36] Document you can pass either model or model config to Pipeline --- docs/source/using-the-python-api.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/using-the-python-api.mdx b/docs/source/using-the-python-api.mdx index 2a12c4fac..2e160a679 100644 --- a/docs/source/using-the-python-api.mdx +++ b/docs/source/using-the-python-api.mdx @@ -1,8 +1,9 @@ # Using the Python API -Lighteval can be used from a custom python script. To evaluate a model you will need to setup an +Lighteval can be used from a custom python script. To evaluate a model you will need to set up an [`~logging.evaluation_tracker.EvaluationTracker`], [`~pipeline.PipelineParameters`], -[`model_config`](package_reference/model_config) and a [`~pipeline.Pipeline`]. +a [`model`](package_reference/models) or a [`model_config`](package_reference/model_config), +and a [`~pipeline.Pipeline`]. After that, simply run the pipeline and save the results. From 83043b3f20ee97dd449e0af356f501028e5c2896 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Tue, 3 Dec 2024 08:00:09 +0100 Subject: [PATCH 35/36] Move Datasets docs to Tasks docs --- docs/source/_toctree.yml | 2 -- docs/source/package_reference/datasets.mdx | 8 -------- docs/source/package_reference/tasks.mdx | 9 +++++++++ 3 files changed, 9 insertions(+), 10 deletions(-) delete mode 100644 docs/source/package_reference/datasets.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 8a3666ea5..c916aaebe 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -39,8 +39,6 @@ - local: package_reference/pipeline title: Pipeline title: Main classes - - local: package_reference/datasets - title: Datasets - local: package_reference/metrics title: Metrics - local: package_reference/tasks diff --git a/docs/source/package_reference/datasets.mdx b/docs/source/package_reference/datasets.mdx deleted file mode 100644 index 3594581b5..000000000 --- a/docs/source/package_reference/datasets.mdx +++ /dev/null @@ -1,8 +0,0 @@ -# Datasets - -[[autodoc]] data.DynamicBatchDataset -[[autodoc]] data.LoglikelihoodDataset -[[autodoc]] data.LoglikelihoodSingleTokenDataset -[[autodoc]] data.GenerativeTaskDataset -[[autodoc]] data.GenerativeTaskDatasetNanotron -[[autodoc]] data.GenDistributedSampler diff --git a/docs/source/package_reference/tasks.mdx b/docs/source/package_reference/tasks.mdx index 1ccd1e0b8..c1a84b00a 100644 --- a/docs/source/package_reference/tasks.mdx +++ b/docs/source/package_reference/tasks.mdx @@ -27,3 +27,12 @@ [[autodoc]] tasks.requests.GreedyUntilRequest [[autodoc]] tasks.requests.GreedyUntilMultiTurnRequest + +## Datasets + +[[autodoc]] data.DynamicBatchDataset +[[autodoc]] data.LoglikelihoodDataset +[[autodoc]] data.LoglikelihoodSingleTokenDataset +[[autodoc]] data.GenerativeTaskDataset +[[autodoc]] data.GenerativeTaskDatasetNanotron +[[autodoc]] data.GenDistributedSampler From 0893e55d4c29655da6906881ac606b604f7c7537 Mon Sep 17 00:00:00 2001 From: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com> Date: Tue, 3 Dec 2024 08:01:15 +0100 Subject: [PATCH 36/36] Add logging docs --- docs/source/_toctree.yml | 2 ++ docs/source/package_reference/logging.mdx | 12 ++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 docs/source/package_reference/logging.mdx diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index c916aaebe..3daa40529 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -43,4 +43,6 @@ title: Metrics - local: package_reference/tasks title: Tasks + - local: package_reference/logging + title: Logging title: Reference diff --git a/docs/source/package_reference/logging.mdx b/docs/source/package_reference/logging.mdx new file mode 100644 index 000000000..9fd01154e --- /dev/null +++ b/docs/source/package_reference/logging.mdx @@ -0,0 +1,12 @@ +# Loggers + +## GeneralConfigLogger +[[autodoc]] logging.info_loggers.GeneralConfigLogger +## DetailsLogger +[[autodoc]] logging.info_loggers.DetailsLogger +## MetricsLogger +[[autodoc]] logging.info_loggers.MetricsLogger +## VersionsLogger +[[autodoc]] logging.info_loggers.VersionsLogger +## TaskConfigLogger +[[autodoc]] logging.info_loggers.TaskConfigLogger