To run experiments on your machine, clone this repo with

git clone https://github.com/lightning-uq-box/uq-box-experiments.git
cd uq-box-experiments

Then proceed to install required packages and navigate the directories to run experiments as outlined below.

We expect a minimum Python version of 3.10. You can set up a conda environment and install the necessary packages inside.

conda create -n myEnvName python=3.10
conda activate myEnvName

pip install git+https://github.com/microsoft/torchgeo.git
pip install git+https://github.com/lightning-uq-box/lightning-uq-box.git
pip install pip install huggingface-hub

We also use WandB for experiment logging.

pip install wandb

The experiments for each dataset can be found in their respective directory:

• Tropical Cyclone
• Digital Typhoon
• SKIPPD

The contain a run_script.py which will execute and experiment and store evaluated results for all datasplits. Experiments are configured based on yaml files that are stored in a configs subdiretory of each dataset experiment directory. We have three "types" of config files:

• dataset.yaml configuration specific to the dataset and datamodule
• trainer.yaml configuration of experiment naming and Lightning Trainer
• model_name.yaml configuration of specific hyperparameters to a model

To run experiments on your machine, you need to make the following changes:

In dataset.yaml files, adapt the root argument to your preferred local directory. Dataset download instructions are given in each respective directory.

datamodule:
  root: "Change the root directory to one where data should be downloaded to"

In trainer.yaml files,

experiment:
  experiment_name: "name of experiment will be included in experiment run name"
  exp_dir: "Directory where to store experiment output"
wandb: # configure wandb here
  project: "name of project"
  entity: "name of user or entity"
  mode: "mode to run wandb in"

Analysis of experiments was conducted via jupyter notebooks. They expect an experiment directory holding different model runs and will scrape over them to collect all experiment outputs so that they are available for whatevery analysis one might desire.

To run the notebooks with the above environmennt, you also need to install:

pip install ipykernel
pip install ipywidgets