Skip to content

This repository hosts an open seizure detection benchmarking platform.

License

Notifications You must be signed in to change notification settings

esl-epfl/szcore

Repository files navigation

SzCORE

Background

This repository hosts an open seizure detection benchmarking platform. The aim is to provide an open source platform for the community to submit their seizure detection algorithms and provide automatic benchmark results on various high quality datasets.

Usage

Users can submit a containerized algorithm by opening a PR adding a yaml file in the algorithms directory. The yaml file should describe their algorithm following our schema (see example) and point to a publicly available docker image based on our template (see config/template.Dockerfile).

Once the PR is merged, this image is used to execute the algorithm on GitHub actions, compute performance metrics and update a static website hosted on GitHub pages.

Data flow

overview

Algorithm submission

To submit an algorithm, you will need to take the following steps:

  1. Fork the repository into your namespace
  2. Add a yaml file describing your algorithm in algorithms/
    • You can start by copying gotman.yaml to get the right structure and adapt the contents.
  3. Build a docker image containing your algorithm by adapting our template.Dockerfile
    • It is important to ensure that CMD (at the end of template) runs inference by reading and writing to the predefined paths.
    • Note that inference happens offline, all dependencies must be downloaded in the build step.
  4. Push the image to a public image registry (e.g. docker.io), making sure it is pulbicly accessible.
    • Make sure the image key in your yaml file points to your custom image. It will be used in the benchmark.
  5. open a Pull Request
    • The yaml file and docker image will be verified by automatic CI checks.
  6. Once all checks pass, we will merge the PR, adding your algorithm to the benchmark.

Acknowledgement

This project was developed as part of the ORD for the Sciences hackathon organized by EPFL Open Science and SDSC by the team "zinalrothorn", composed of @EishaMazhar, @danjjl, @esthertsw and @cmdoret.

SzCORE originated from the synergy of the Pedesite consortium (EPFL-ESL, ETH-IIS, CHUV, EPFL-LTS4).

About

This repository hosts an open seizure detection benchmarking platform.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages