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 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/) 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 ", "David Chapela ", 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 + )