Skip to content

Commit eadd461

Browse files
committed
update execution docs
1 parent 7b12ab3 commit eadd461

File tree

2 files changed

+21
-33
lines changed

2 files changed

+21
-33
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,48 @@
11
# xtclim
2+
23
## ML-based extreme events detection and characterization (CERFACS)
34

45
The code is adapted from CERFACS' [repository](https://github.com/cerfacs-globc/xtclim/tree/master).
5-
The implementation of a pipeline with itwinai framework is shown below.
6+
The implementation of a pipeline with itwinai framework is shown below.
7+
8+
## Method
69

7-
## Method
810
Convolutional Variational AutoEncoder.
911

1012
## Input
13+
1114
"3D daily images", daily screenshots of Europe for three climate variables (maximum temperature, precipitation, wind).
1215

13-
## Output
16+
## Output
17+
1418
Error between original and reconstructed image: postprocessed for analysis in the `scenario_season_comparison.ipynb` file.
1519

16-
## Idea
20+
## Idea
21+
1722
The more unusual an image (anomaly), the higher error.
1823

1924
## Information on files
2025

21-
In the preprocessing folder, the `preprocess_functions_2d_ssp.py` class loads NetCDF files from a `data` folder, which has to be specified in `dataset_root` in the config file `pipeline.yaml` (please change the location). The data can be found [here](https://b2drop.eudat.eu/s/rtAadDNYDWBkxjJ). The given class normalizes and adjusts the data for the network. The function `preprocess_2d_seasons.py` splits the data into seasonal files. Preprocessed data is stored in the `input` folder.
26+
In the preprocessing folder, the `preprocess_functions_2d_ssp.py` class loads NetCDF files from a `data` folder,
27+
which has to be specified in `dataset_root` in the config file `config.yaml` (please change the location).
28+
The data can be found [here](https://b2drop.eudat.eu/s/rtAadDNYDWBkxjJ). The given class normalizes
29+
and adjusts the data for the network. The function `preprocess_2d_seasons.py` splits the data into
30+
seasonal files. Preprocessed data is stored in the `input` folder.
2231

23-
The file `train.py` trains the network. Caution: It will overwrite the weights of the network already saved in outputs (unless you change the path name `outputs/cvae_model_3d.pth` in the script).
32+
The file `train.py` trains the network. Caution: It will overwrite the weights of the network already
33+
saved in outputs (unless you change the path name `outputs/cvae_model_3d.pth` in the script).
2434

2535
The `anomaly.py` file evaluates the network on the available datasets - train, test, and projection.
2636

27-
## How to launch pipeline
37+
## How to launch training workflow
2838

29-
The config file `pipeline.yaml` contains all the steps to execute the workflow. You can launch it from the root of the repository with:
39+
The config file `config.yaml` contains all the steps to execute the workflow.
40+
You can launch it from the root of the repository with:
3041

3142
```bash
32-
python train.py -p pipeline.yaml
33-
43+
itwinai exec-pipeline --config config.yaml
3444
```
3545

3646
## TODOs
47+
3748
Integration of post-processing step + distributed strategies

train.py

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)