Merge pull request #164 from AutomatedProcessImprovement/documentation

Improve runtime report and finish documentation

Author: david-chapela

.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

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/)

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 <[email protected]>",
     "David Chapela <[email protected]>",

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
+        )