Skip to content

Commit

Permalink
Merge branch 'main' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
robin-janssen committed Oct 18, 2024
2 parents a05490f + 531ab83 commit 055a58f
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 5 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,31 @@
# CODES Benchmark

[![codecov](https://codecov.io/github/robin-janssen/CODES-Benchmark/branch/develop/graph/badge.svg?token=TNF9ISCAJK)](https://codecov.io/github/robin-janssen/CODES-Benchmark)

![Static Badge](https://img.shields.io/badge/license-GPLv3-blue)


## Benchmarking Coupled ODE Surrogates

This repo aims to provide a way of benchmarking surrogate models for coupled ODE systems, as can be found in the context of chemical reaction networks.

Full documentation can be found on the new [website](https://robin-janssen.github.io/CODES-Benchmark/).
<img src="docs/_static/favicon-96x96.png" alt="CODES Logo" width="20"/>

The main documentation can be found on the [CODES website](https://codes-docs.web.app/index.html).

<picture>
<!-- Dark mode SVG -->
<source media="(prefers-color-scheme: dark)" srcset="docs/_static/book-solid-white.svg">
<!-- Light mode SVG -->
<source media="(prefers-color-scheme: light)" srcset="docs/_static/book-solid.svg">
<!-- Fallback image (light mode by default) -->
<img width="20" alt="CODES API Docs" src="docs/_static/book-solid.svg">
</picture>

The technical API documentation is hosted on this [GitHub Page](https://robin-janssen.github.io/CODES-Benchmark/).

## Motivation

There are many efforts to use machine learning models ("surrogates") to replace the costly numerics required involved in solving coupled ODEs. But for the end user, it is not obvious how to choose the right surrogate for a given task. Usually, the best choice depends on both the dataset and the target application.
There are many efforts to use machine learning models ("surrogates") to replace the costly numerics involved in solving coupled ODEs. But for the end user, it is not obvious how to choose the right surrogate for a given task. Usually, the best choice depends on both the dataset and the target application.

Dataset specifics - how "complex" is the dataset?
- How many samples are there?
Expand Down Expand Up @@ -147,4 +159,4 @@ pip install -r requirements.txt

The installation is now complete. To be able to run and evaluate the benchmark, you need to first set up a configuration YAML file. There is one provided, but it should be configured. For more information, check the [configuration page](https://robin-janssen.github.io/CODES-Benchmark/documentation.html#config). There, we also offer an interactive Config-Generator tool with some explanations to help you set up your benchmark.

You can also add your own datasets and models to the benchmark to evaluate them against each other or some of our baseline models. For more information on how to do this, please refer to the [documentation](https://robin-janssen.github.io/CODES-Benchmark/documentation.html).
You can also add your own datasets and models to the benchmark to evaluate them against each other or some of our baseline models. For more information on how to do this, please refer to the [documentation](https://robin-janssen.github.io/CODES-Benchmark/documentation.html).
3 changes: 3 additions & 0 deletions docs/_static/book-solid-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/_static/book-solid.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
},
{
"name": "CODES Docs",
"url": "https://immi000.github.io/CODES-Benchmark-Docs/index.html",
"url": "https://codes-docs.web.app",
"icon": "_static/favicon-96x96.png", # Make sure this is the correct path to the favicon
"type": "local",
},
Expand Down

0 comments on commit 055a58f

Please sign in to comment.