From b255a9155e233811c223b93b9d91d05d96b0b2a8 Mon Sep 17 00:00:00 2001 From: Anno Knierim <anno.knierim@tu-dortmund.de> Date: Wed, 31 Jul 2024 16:49:58 +0200 Subject: [PATCH] Update Readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index b3901bc..9509747 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,22 @@ $ romf-optim ``` All optional arguments of the CLI tools can be printed by adding the `--help` flag. +### Pre-trained Models +We have provided pre-trained models in the `trained_models` directory. +The ROLF model can be loaded and evaluated using the `classification_viewer.ipynb` notebook +found in the `notebooks` directory. This notebook can also be used to evaluate checkpoints +of models trained via `rolf-train`. + +### Monitoring +The training progress of ROLF can be monitored using [TensorBoard](https://www.tensorflow.org/tensorboard): +``` +$ tensorboard --logdir <path/to/checkpoints/directory> +``` +The hyperparameter optimization can be monitored using [Optuna Dashboard](https://optuna-dashboard.readthedocs.io/en/latest/): +``` +$ optuna-dashboard <path/to/database.sqlite3> +``` + ## References [1] Griese, F., Kummer, J., & Rustige, L., ***"Radio Galaxy Dataset (v0.1.3)"***, Zenodo (2022). [https://zenodo.org/doi/10.5281/zenodo.7113623](https://zenodo.org/doi/10.5281/zenodo.7113623)