Merge branch 'main' into new_structure

Signed-off-by: Shaobo-Zhou <109073755+Shaobo-Zhou@users.noreply.github.com>

Author: Shaobo-Zhou

.github/CONTRIBUTING.md

@@ -4,4 +4,4 @@
 # Contributing
 
 Thank you for your interest in contributing to MQT Predictor!
-An extensive contribution guide is available in our [documentation](https://mqt.readthedocs.io/projects/predictor/en/latest/CONTRIBUTING.html).
+An extensive contribution guide is available in our [documentation](https://mqt.readthedocs.io/projects/predictor/en/latest/contributing.html).

.github/workflows/cd.yml

@@ -10,11 +10,11 @@ on:
 jobs:
   build-sdist:
     name: 🐍 Packaging
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-sdist.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-sdist.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
 
   build-wheel:
     name: 🐍 Packaging
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-wheel-build.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-wheel-build.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
 
   deploy:
     if: github.event_name == 'release' && github.event.action == 'published'

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ concurrency:
 jobs:
   change-detection:
     name: 🔍 Change
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-change-detection.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-change-detection.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
 
   python-tests:
     name: 🐍 Test
@@ -24,15 +24,15 @@ jobs:
       fail-fast: false
       matrix:
         runs-on: [ubuntu-24.04, macos-14, windows-2022]
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-tests.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-tests.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
     with:
       runs-on: ${{ matrix.runs-on }}
 
   python-coverage:
     name: 🐍 Coverage
     needs: [change-detection, python-tests]
     if: fromJSON(needs.change-detection.outputs.run-python-tests)
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-coverage.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-coverage.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
     permissions:
       contents: read
       id-token: write
@@ -41,19 +41,19 @@ jobs:
     name: 🐍 Lint
     needs: change-detection
     if: fromJSON(needs.change-detection.outputs.run-python-tests)
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-linter.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-linter.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
 
   build-sdist:
     name: 🚀 CD
     needs: change-detection
     if: fromJSON(needs.change-detection.outputs.run-cd)
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-sdist.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-sdist.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
 
   build-wheel:
     name: 🚀 CD
     needs: change-detection
     if: fromJSON(needs.change-detection.outputs.run-cd)
-    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-wheel-build.yml@56cf3608b07dc10bda5b98d77ed6ad21ecf7ef5d # v1.17.0
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-wheel-build.yml@dbcd4474154dda0794838207274a3bccd4550de0 # v1.17.3
 
   # this job does nothing and is only used for branch protection
   required-checks-pass:

.github/workflows/templating.yml

@@ -14,11 +14,11 @@ jobs:
       pull-requests: write
     steps:
       - id: create-token
-        uses: actions/create-github-app-token@67018539274d69449ef7c02e8e71183d1719ab42 # v2.1.4
+        uses: actions/create-github-app-token@7e473efe3cb98aa54f8d4bac15400b15fad77d94 # v2.2.0
         with:
           app-id: ${{ secrets.APP_ID }}
           private-key: ${{ secrets.APP_PRIVATE_KEY }}
-      - uses: munich-quantum-toolkit/templates@ee3423de8b910ad0846d5f48edf47d5aebee222f # v1.1.9
+      - uses: munich-quantum-toolkit/templates@db1400818735d56b0b4fae9e84adbb096b444820 # v1.1.10
         with:
           token: ${{ steps.create-token.outputs.token }}
           name: Predictor

.pre-commit-config.yaml

@@ -57,7 +57,7 @@ repos:
 
   # Python linting and formatting using ruff
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.4
+    rev: v0.14.6
     hooks:
       - id: ruff-check
         args: ["--fix", "--show-fixes"]
@@ -104,7 +104,7 @@ repos:
 
   # Check for spelling
   - repo: https://github.com/crate-ci/typos
-    rev: v1.39.0
+    rev: v1.39.2
     hooks:
       - id: typos
 
@@ -119,22 +119,22 @@ repos:
 
   # Check best practices for scientific Python code
   - repo: https://github.com/scientific-python/cookie
-    rev: 2025.11.07
+    rev: 2025.11.21
     hooks:
       - id: sp-repo-review
         additional_dependencies: ["repo-review[cli]"]
 
   # Check JSON schemata
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.34.1
+    rev: 0.35.0
     hooks:
       - id: check-dependabot
       - id: check-github-workflows
       - id: check-readthedocs
 
   # Check the pyproject.toml file
   - repo: https://github.com/henryiii/validate-pyproject-schema-store
-    rev: 2025.11.04
+    rev: 2025.11.21
     hooks:
       - id: validate-pyproject
 

pyproject.toml

@@ -118,7 +118,7 @@ addopts = [
     "--strict-config",
     "--showlocals",
 ]
-log_cli_level = "INFO"
+log_level = "INFO"
 xfail_strict = true
 filterwarnings = [
     'error',

tests/conftest.py

@@ -0,0 +1,42 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+"""Clean-up fixtures for the tests."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+from mqt.predictor.ml.helper import get_path_training_data as ml_get_path_training_data
+from mqt.predictor.rl.helper import get_path_trained_model as rl_get_path_trained_model
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+
+@pytest.fixture(scope="session", autouse=True)
+def clean_rl_models() -> Generator[None]:
+    """Clean up trained RL models after test session."""
+    yield
+
+    for model in rl_get_path_trained_model().glob("*.zip"):
+        model.unlink()
+
+
+@pytest.fixture(scope="session", autouse=True)
+def clean_ml_models() -> Generator[None]:
+    """Clean up trained ML models after test session."""
+    yield
+
+    for model in (ml_get_path_training_data() / "trained_model").glob("*.joblib"):
+        model.unlink()
+
+    for data in (ml_get_path_training_data() / "training_data_aggregated").glob("*.npy"):
+        data.unlink()

tests/hellinger_distance/test_estimated_hellinger_distance.py

@@ -240,33 +240,6 @@ def test_train_and_qcompile_with_hellinger_model(source_path: Path, target_path:
         assert predicted_dev.description in get_available_device_names()
 
 
-def test_remove_files(source_path: Path, target_path: Path) -> None:
-    """Remove files created during testing."""
-    if source_path.exists():
-        for file in source_path.iterdir():
-            if file.suffix == ".qasm":
-                file.unlink()
-        source_path.rmdir()
-
-    if target_path.exists():
-        for file in target_path.iterdir():
-            if file.suffix == ".qasm":
-                file.unlink()
-        target_path.rmdir()
-
-    data_path = get_path_training_data() / "training_data_aggregated"
-    if data_path.exists():
-        for file in data_path.iterdir():
-            if file.suffix == ".npy":
-                file.unlink()
-
-    model_path = get_path_training_data() / "trained_model"
-    if model_path.exists():
-        for file in model_path.iterdir():
-            if file.suffix == ".joblib":
-                file.unlink()
-
-
 def test_predict_device_for_estimated_hellinger_distance_no_device_provided() -> None:
     """Test the error handling of the device selection predictor when no device is provided for the Hellinger distance model."""
     rng = np.random.default_rng()