From 626e7292845b17e899dd6d1404c0f2ff5f7afbdc Mon Sep 17 00:00:00 2001 From: Aaron Spring <aaron.spring@mpimet.mpg.de> Date: Mon, 3 May 2021 09:23:54 +0000 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d009ffa..a8b75e9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # S2S AI Challenge Template This is a template repository with running examples how to join and contribute to -the s2s-ai-challenge. +the `s2s-ai-challenge`. You were likely referred here from the [public website](https://s2s-ai-challenge.github.io/). +The competition starts in June, so examples are still work in progress +and joining the competition not possible until then. + Find an overview of [repositories and websites](https://renkulab.io/gitlab/aaron.spring/s2s-ai-challenge/-/wikis/Flow-of-information:-Where-do-I-find-what%3F) ## Introduction @@ -23,7 +26,11 @@ Fork this template renku project from https://renkulab.io/projects/aaron.spring/ <img src="docs/screenshots/fork_renku.png" width="300"> -### 2. Make the project private +Name your fork `s2s-ai-challenge-$TEAMNAME`. + +### 2. Fill our [registration form](https://docs.google.com/forms/d/1KEnATjaLOtV-o4N8PLinPXYnpba7egKsCCH_efriCb4). + +### 3. Make the project private Now check out the gitlab repository by clicking on "View in gitlab". Under "Settings" - "General" - "Visibility" you can set your project private. @@ -32,10 +39,10 @@ Under "Settings" - "General" - "Visibility" you can set your project private. Now other people cannot steal your idea/code. -### 3. Add the `scorer` user to your repo with Reporter permissions +### 4. Add the `scorer` user to your repo with Reporter permissions The scorer is not yet ready, but will follow this [verification notebook](https://renkulab.io/gitlab/aaron.spring/s2s-ai-competition-bootstrap/-/blob/master/notebooks/verification_RPSS.ipynb). -### 4. Add a gitlab variable with key `COMPETITION` and name `S2S-AI` +### 5. Add a gitlab variable with key `COMPETITION` and name `S2S-AI` In the gitlab repository, under "Settings" -> "CI/CD" -> "Variables", add the `COMPETITION` key with value `S2S-AI`, so the `scorer` bot knows where to search for submissions. @@ -45,7 +52,7 @@ for submissions. ## Contribute -### 5. Start jupyter +### 6. Start jupyter The simplest way to contribute is right from the Renku platform - just click on the `Environments` tab in your renku project and start a new session. This will start an interactive environment right in your browser. @@ -58,15 +65,15 @@ To work with the project anywhere outside the Renku platform, click the `Settings` tab where you will find the git repo URLs - use `git` to clone the project on whichever machine you want. -### 6. Train your Machine Learning model -using training data from https://github.com/ecmwf-lab/climetlab-s2s-ai-challenge or renku datasets +### 7. Train your Machine Learning model +using training data via [climetlab](https://github.com/ecmwf-lab/climetlab-s2s-ai-challenge) or renku datasets -### 7. Let the Machine Learning model perform subseasonal 2020 predictions +### 8. Let the Machine Learning model perform subseasonal 2020 predictions and save them as `netcdf` files. The submissions have to placed in the `submissions` folder with filename `submission_your_choice.nc`, see [example](https://renkulab.io/gitlab/aaron.spring/s2s-ai-competition-bootstrap/-/blob/master/submissions/submission_rb_prediction_2020.nc). -### 8. `git commit` training pipeline and netcdf submission +### 9. `git commit` training pipeline and netcdf submission For later verification of the organizers, reproducibility and scoring of submissions, the training notebook/pipeline and submission file ML_prediction.nc with `git lfs`. After commiting, `git tag submission-method_name-number` @@ -78,7 +85,7 @@ git tag "submission-my_method-0.0.1" # if this is to be checked by scorer git push --tags ``` -### 9. RPSS scoring by `scorer` bot +### 10. RPSS scoring by `scorer` bot The `scorer` will fetch your tagged submissions, score them with RPSS against recalibrated ECMWF real-time forecasts. Your score will be added to the leaderboard at https://s2s-ai-challenge.github.io/#leaderboard -- GitLab