From 738a132d499f7e179960878e82b4ab46dda7dfa1 Mon Sep 17 00:00:00 2001
From: David Chapela de la Campa <david.chapela.delacampa@gmail.com>
Date: Fri, 7 Feb 2025 01:57:24 +0200
Subject: [PATCH 1/3] Update GitHub workflow

---
 .github/workflows/simod.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/simod.yml b/.github/workflows/simod.yml
index c86c8b80..ecb35738 100644
--- a/.github/workflows/simod.yml
+++ b/.github/workflows/simod.yml
@@ -157,7 +157,7 @@ jobs:
           echo "version=$(poetry version --short)" >> "$GITHUB_OUTPUT"
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: simod-${{ steps.get_version.outputs.version }}-py${{ matrix.python-version }}
           path: dist

From b25b2ffc1e22c95018d114c934ce7ad803e19cc9 Mon Sep 17 00:00:00 2001
From: David Chapela de la Campa <david.chapela.delacampa@gmail.com>
Date: Fri, 7 Feb 2025 01:57:37 +0200
Subject: [PATCH 2/3] Add documentation badges to README.md

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 1d237c75..b8887ddf 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
 
 ![Simod](https://github.com/AutomatedProcessImprovement/Simod/actions/workflows/simod.yml/badge.svg)
 ![version](https://img.shields.io/github/v/tag/AutomatedProcessImprovement/simod)
+[![Documentation Status](https://readthedocs.org/projects/simod/badge/?version=latest)](https://simod.readthedocs.io/en/latest/)
 
 SIMOD combines process mining and machine learning techniques to automate the discovery and tuning of Business Process
 Simulation models from event logs extracted from enterprise information systems (ERPs, CRM, case management systems,
@@ -111,3 +112,8 @@ Coverage:
 ```shell
 poetry run pytest -m "not integration" --cov=simod
 ```
+
+### Documentation
+
+For more details about the installation, usage, and implementation **visit the documentation here:**  
+📖 ️ [https://simod.readthedocs.io/en/latest/](https://simod.readthedocs.io/en/latest/)

From 2737705bf80ec057ced074d853f155e369a9a89d Mon Sep 17 00:00:00 2001
From: David Chapela de la Campa <david.chapela.delacampa@gmail.com>
Date: Fri, 7 Feb 2025 01:57:54 +0200
Subject: [PATCH 3/3] Improve runtime reporting

---
 pyproject.toml     |  2 +-
 src/simod/simod.py | 11 +++++++++--
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 6f130546..8566fa5f 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "simod"
-version = "5.1.3"
+version = "5.1.4"
 authors = [
     "Ihar Suvorau <ihar.suvorau@gmail.com>",
     "David Chapela <david.chapela@ut.ee>",
diff --git a/src/simod/simod.py b/src/simod/simod.py
index f9cfd93e..64316a89 100644
--- a/src/simod/simod.py
+++ b/src/simod/simod.py
@@ -405,5 +405,12 @@ def _export_runtimes(
         file_path: Path,
         runtimes: RuntimeMeter
 ):
-    with open(file_path, "w") as f:
-        json.dump(runtimes.runtimes, f)
+    with open(file_path, "w") as file:
+        json.dump(
+            runtimes.runtimes | {'explanation': f"Add '{RuntimeMeter.PREPROCESSING}' with '{RuntimeMeter.TOTAL}' "
+                                                f"for the runtime of the entire SIMOD pipeline and preprocessing "
+                                                f"stage. '{RuntimeMeter.EVALUATION}', if reported, should be left out "
+                                                f"as it measures the quality assessment of the final BPS model (i.e., "
+                                                f"it is not part of the discovery process."},
+            file
+        )