From a761113ed79810550152d0508a945cc605de87bb Mon Sep 17 00:00:00 2001 From: Robin Date: Mon, 16 Feb 2026 17:41:26 +0100 Subject: [PATCH] update contributors and docs --- .all-contributorsrc | 81 ++++++++++++++++++- .../guides/running-benchmarks/modalities.md | 5 +- docs/source/index.rst | 2 +- 3 files changed, 83 insertions(+), 5 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 56f0387..a17aec0 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,4 +1,81 @@ { "projectName": "CODES-Benchmark", - "projectOwner": "AstroAI-Lab" -} \ No newline at end of file + "projectOwner": "AstroAI-Lab", + "files": [ + "README.md" + ], + "commitType": "docs", + "commitConvention": "angular", + "contributorsPerLine": 7, + "contributors": [ + { + "login": "robin-janssen", + "name": "Robin Janssen", + "avatar_url": "https://avatars.githubusercontent.com/u/82322346?v=4", + "profile": "https://github.com/robin-janssen", + "contributions": [ + "code", + "content", + "data", + "doc", + "design", + "example", + "ideas", + "infra", + "maintenance", + "plugin", + "projectManagement", + "question", + "research", + "review", + "tool", + "test", + "talk", + "userTesting" + ] + }, + { + "login": "TobiBu", + "name": "Tobias Buck", + "avatar_url": "https://avatars.githubusercontent.com/u/7574273?v=4", + "profile": "https://tobibu.github.io", + "contributions": [ + "ideas", + "infra", + "projectManagement", + "research", + "review", + "talk", + "mentoring" + ] + }, + { + "login": "lorenzobranca", + "name": "Lorenzo Branca", + "avatar_url": "https://avatars.githubusercontent.com/u/57775402?v=4", + "profile": "https://github.com/lorenzobranca", + "contributions": [ + "data", + "ideas", + "research", + "test", + "talk" + ] + }, + { + "login": "Immi000", + "name": "Immanuel Sulzer", + "avatar_url": "https://avatars.githubusercontent.com/u/100942429?v=4", + "profile": "https://github.com/Immi000", + "contributions": [ + "code", + "content", + "data", + "design", + "doc", + "infra", + "userTesting" + ] + } + ] +} diff --git a/docs/source/guides/running-benchmarks/modalities.md b/docs/source/guides/running-benchmarks/modalities.md index d27bfbb..10f6ad1 100644 --- a/docs/source/guides/running-benchmarks/modalities.md +++ b/docs/source/guides/running-benchmarks/modalities.md @@ -37,7 +37,7 @@ Interpolation studies remove every _n_-th timestep, forcing the surrogate to rec align: center alt: Interpolation modality example --- -Interpolation MAE over time for several interval widths. Wider gaps create bigger spikes but also highlight which surrogates remain stable. +Interpolation MAE over time for several interval widths. When the distance between time steps increases, one can often observe error spikes between them. ``` ## Extrapolation @@ -61,7 +61,7 @@ Sparse training reduces the number of observations before fitting, emulating lim align: center alt: Sparse modality example --- -Down-sampling trajectories shows how MAE changes with fewer observations; FCNN tends to degrade earlier than the latent models. +Reducing the numer of samples (sets of trajectories) shows how MAE changes with fewer observations, revealing how efficiently the model extracts information from samples, and equivalently informing whether more training data could help improve this surrogate's performance. ``` ## Batch scaling @@ -69,3 +69,4 @@ Down-sampling trajectories shows how MAE changes with fewer observations; FCNN t Batch scaling sweeps different batch sizes and records how accuracy/timing behave. This is useful to identify sweet spots for throughput without impacting convergence too heavily. Combine the results with the `timing` evaluation to compare throughput across surrogates. See the :doc:`configuration reference ` for the exact YAML schema and defaults. + diff --git a/docs/source/index.rst b/docs/source/index.rst index ba44527..01e3f1e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,7 +12,7 @@ CODES Benchmark * **Extend the Stack** — :doc:`guides/extending-benchmark` shows how to add datasets or surrogates without rewriting orchestration glue. * **API Reference** — :doc:`api-reference` explains how the generated package docs are organized and links to each module. -Looking for a bird’s-eye view first? Start with the **User Guide**. Already configuring experiments or integrating your own model? Skip ahead to the **API Reference**. Either way, the sidebar mirrors the sections below so you are one click away from the next step. +Looking for a bird’s-eye view first? Start with the **User Guide**. Already configuring experiments or integrating your own model? Skip ahead to the **API Reference**. The sidebar mirrors the sections below so you are one click away from the next step. .. toctree:: :maxdepth: 2