squlearn 0.9.0__tar.gz → 0.10.0__tar.gz

{squlearn-0.9.0 → squlearn-0.10.0}/.github/workflows/doc_checks.yml

@@ -2,6 +2,13 @@ name: Documentation check
 on:
 - pull_request
 
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   doc_checks:
     runs-on: ubuntu-latest
@@ -9,10 +16,8 @@ jobs:
       QISKIT_SETTINGS: ${{github.workspace}}/docs/qiskit_settings.conf
 
     steps:
-        - name: Cancel Workflow Action
-          uses: styfle/cancel-workflow-action@0.11.0
 
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@v5
 
         - uses: sQUlearn/sphinx-action@master
           with:

squlearn-0.10.0/.github/workflows/elaborate_tests.yaml

@@ -0,0 +1,202 @@
+name: Elaborate Tests
+on:
+  pull_request:
+    types: [review_requested]
+  schedule:
+    - cron: '23 1 * * *'
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${
+      (github.event_name == 'pull_request' && github.event.pull_request.number || github.ref_name)
+    }
+  cancel-in-progress: true
+
+jobs:
+  pytest_minimal_requirements:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python -m venv venv_minimal
+          source venv_minimal/bin/activate
+          python -m pip install --upgrade pip
+          pip install toml autoray==0.7.2 matplotlib-inline==0.1.7
+          python3 install_lowest_dependencies.py
+      - name: Test with pytest
+        run: |
+          source venv_minimal/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: clean
+        run: |
+          rm -rf venv_minimal
+
+  pytest_qiskit_0_46:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python -m venv venv_qiskit_0_46
+          source venv_qiskit_0_46/bin/activate
+          python -m pip install --upgrade pip
+          pip install . qiskit==0.46.3 qiskit-ibm-runtime==0.20.0 autoray==0.7.2
+      - name: Test with pytest
+        run: |
+          source venv_qiskit_0_46/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: clean
+        run: |
+          rm -rf venv_qiskit_0_46
+
+  pytest_qiskit_1:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python -m venv venv_qiskit_1
+          source venv_qiskit_1/bin/activate
+          python -m pip install --upgrade pip
+          pip install . qiskit==1.1.2 qiskit-algorithms==0.3.0 qiskit-ibm-runtime==0.27.1 autoray==0.7.2
+      - name: Test with pytest
+        run: |
+          source venv_qiskit_1/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: clean
+        run: |
+          rm -rf venv_qiskit_1
+
+  pytest_full:
+    name: Tests + Examples on ubuntu-latest with Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: |
+            ${{
+              matrix.python-version
+            }}
+      - name: Install dependencies
+        run: |
+          python -m venv venv_latest
+          source venv_latest/bin/activate
+          python -m pip install --upgrade pip
+          pip install .[examples]
+      - name: Install old autoray
+        if: matrix.python-version == '3.9'
+        run: |
+          source venv_latest/bin/activate
+          pip install autoray==0.7.2
+      - name: Test with pytest
+        run: |
+          source venv_latest/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: Test examples
+        run: |
+          source venv_latest/bin/activate
+          pip install nbmake
+          pytest --nbmake --nbmake-timeout 600 examples/
+      - name: clean
+        run: |
+          rm -rf venv_latest
+
+  pytest_windows:
+    name: Test on windows-latest with Python ${{ matrix.python-version }}
+    runs-on: windows-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: |
+            ${{
+              matrix.python-version
+            }}
+      - name: Install dependencies
+        run: |
+          python -m venv venv_latest
+          .\venv_latest\Scripts\python.exe -m pip install --upgrade pip
+          .\venv_latest\Scripts\pip.exe install .
+      - name: Install old autoray
+        if: matrix.python-version == '3.9'
+        run: |
+          .\venv_latest\Scripts\pip.exe install autoray==0.7.2
+      - name: Test with pytest
+        run: |
+          .\venv_latest\Scripts\pip.exe install pytest
+          .\venv_latest\Scripts\pytest.exe tests/
+      - name: clean
+        run: |
+          rm -Recurse -Force venv_latest
+  
+  pytest_macos:
+    name: Test on macos-latest with Python ${{ matrix.python-version }}
+    runs-on: macos-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: |
+            ${{
+              matrix.python-version
+            }}
+      - name: Install dependencies
+        run: |
+          python -m venv venv_latest
+          source venv_latest/bin/activate
+          python -m pip install --upgrade pip
+          pip install .
+      - name: Install old autoray
+        if: matrix.python-version == '3.9'
+        run: |
+          source venv_latest/bin/activate
+          pip install autoray==0.7.2
+      - name: Test with pytest
+        run: |
+          source venv_latest/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: clean
+        run: |
+          rm -rf venv_latest

{squlearn-0.9.0 → squlearn-0.10.0}/.github/workflows/format.yml

@@ -2,23 +2,27 @@ name: Formatting check
 on:
 - pull_request
 
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   black:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Cancel Workflow Action
-        uses: styfle/cancel-workflow-action@0.11.0
-
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v6
         with:
-          python-version: 3.9
+          python-version: 3.13
 
       - name: Install dependencies
         run: pip install black[jupyter]
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Run Black
         run: |

{squlearn-0.9.0 → squlearn-0.10.0}/.github/workflows/publish.yml

@@ -14,14 +14,14 @@ jobs:
         id-token: write
       steps:
         - name: Set up Python
-          uses: actions/setup-python@v2
+          uses: actions/setup-python@v6
           with:
             python-version: 3.9
 
         - name: Install dependencies
           run: pip install flit
 
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@v5
         
         - name: Build
           run: flit build

{squlearn-0.9.0 → squlearn-0.10.0}/.github/workflows/publish_docs.yml

@@ -12,9 +12,9 @@ jobs:
         QISKIT_SETTINGS: ${{github.workspace}}/docs/qiskit_settings.conf
       steps:
           - name: Checkout Source Code
-            uses: actions/checkout@v4
+            uses: actions/checkout@v5
           - name: Checkout GH Pages
-            uses: actions/checkout@v4
+            uses: actions/checkout@v5
             with:
               repository: sQUlearn/squlearn.github.io
               fetch-depth: 0

squlearn-0.10.0/.github/workflows/quick_tests.yaml

@@ -0,0 +1,50 @@
+name: Quick Tests
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${
+      (github.event_name == 'pull_request' && github.event.pull_request.number || github.ref_name)
+    }
+  cancel-in-progress: true
+
+jobs:
+  pytest:
+    name: Tests on ubuntu-latest with Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: |
+            ${{
+              matrix.python-version
+            }}
+      - name: Install dependencies
+        run: |
+          python -m venv venv_latest
+          source venv_latest/bin/activate
+          python -m pip install --upgrade pip
+          pip install .
+      - name: Install old autoray
+        if: matrix.python-version == '3.9'
+        run: |
+          source venv_latest/bin/activate
+          pip install autoray==0.7.2
+      - name: Test with pytest
+        run: |
+          source venv_latest/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: clean
+        run: |
+          rm -rf venv_latest

squlearn-0.10.0/.github/workflows/stale.yml

@@ -0,0 +1,20 @@
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '30 1 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v10
+        with:
+          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 1 year.'
+          stale-pr-message: 'This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 1 year.'
+          close-issue-message: 'This issue was closed because it has been stalled for 1 year with no activity.'
+          close-pr-message: 'This PR was closed because it has been stalled for 1 year with no activity.'
+          days-before-stale: 30
+          days-before-close: 365
+          exempt-issue-labels: 'bug,eternal'
+          exempt-all-issue-milestones: 'true'
+          exempt-all-issue-assignees: 'true'

{squlearn-0.9.0 → squlearn-0.10.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: squlearn
-Version: 0.9.0
+Version: 0.10.0
 Summary: A library for quantum machine learning following the scikit-learn standard.
 Keywords: quantum,machine learning,qml
 Author-email: David Kreplin <david.kreplin@ipa.fraunhofer.de>, Moritz Willmann <moritz.willmann@ipa.fraunhofer.de>, Jan Schnabel <jan.schnabel@ipa.fraunhofer.de>, Frederic Rapp <frederic.rapp@ipa.fraunhofer.de>, Manuel Hagelüken <manuel.hagelueken@ipa.fraunhofer.de>, Marco Roth <marco.roth@ipa.fraunhofer.de>
 Maintainer-email: David Kreplin <david.kreplin@ipa.fraunhofer.de>, Moritz Willmann <moritz.willmann@ipa.fraunhofer.de>
-Requires-Python: >=3.9,<3.13
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
@@ -33,7 +33,7 @@ Requires-Dist: pylint ; extra == "dev"
 Requires-Dist: pytest ; extra == "dev"
 Requires-Dist: ipykernel ; extra == "docs"
 Requires-Dist: jupyter-sphinx ; extra == "docs"
-Requires-Dist: matplotlib>=3.5.1 ; extra == "docs"
+Requires-Dist: matplotlib>=3.4.1 ; extra == "docs"
 Requires-Dist: myst-parser ; extra == "docs"
 Requires-Dist: nbsphinx ; extra == "docs"
 Requires-Dist: nbsphinx_link ; extra == "docs"
@@ -44,7 +44,7 @@ Requires-Dist: sphinx-rtd-theme<3.0.0 ; extra == "docs"
 Requires-Dist: sphinx-sitemap ; extra == "docs"
 Requires-Dist: scikit-learn!=1.7.1 ; extra == "docs"
 Requires-Dist: jupyter ; extra == "examples"
-Requires-Dist: matplotlib>=3.5.1 ; extra == "examples"
+Requires-Dist: matplotlib>=3.4.1 ; extra == "examples"
 Requires-Dist: mlflow ; extra == "examples"
 Requires-Dist: numpy>=1.24.1 ; extra == "examples"
 Requires-Dist: pandas ; extra == "examples"

{squlearn-0.9.0 → squlearn-0.10.0}/docs/conf.py

@@ -112,6 +112,7 @@ intersphinx_mapping = {
     "qiskit-ibm-runtime": ("https://quantum.cloud.ibm.com/docs/api/qiskit-ibm-runtime/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/", None),
     "sklearn": ("https://scikit-learn.org/stable/", None),
+    "sympy": ("https://docs.sympy.org/latest/", None),
 }
 
 suppress_warnings = ["myst.header", "config.cache"]

squlearn-0.9.0/docs/examples/example_qnn_ode_solver.nblink → squlearn-0.10.0/docs/examples/example_ode_solver.nblink

@@ -1,5 +1,5 @@
 {
-    "path": "../../examples/tutorials/qnn_ode_solver.ipynb",
+    "path": "../../examples/tutorials/ode_solver.ipynb",
     "extra-media": [
         "../../examples/tutorials/images"
     ]

{squlearn-0.9.0 → squlearn-0.10.0}/docs/examples/examples_index.rst

@@ -11,4 +11,4 @@ Examples
     example_kernel_grid_search
     example_quantum_bayesian_optimization
     example_qnn_backend_mitigation
-    example_qnn_ode_solver
+    example_ode_solver

{squlearn-0.9.0 → squlearn-0.10.0}/docs/modules/classes.rst

@@ -4,10 +4,11 @@
 API Reference
 =============
 
-
+High Level API
+==============
 
 QML Regressors
-=====================================
+--------------
 
 .. currentmodule:: squlearn
 
@@ -22,9 +23,8 @@ QML Regressors
    qnn.QNNRegressor
    qrc.QRCRegressor
 
-
 QML Classifiers
-======================================
+---------------
 
 .. currentmodule:: squlearn
 
@@ -38,6 +38,18 @@ QML Classifiers
    qnn.QNNClassifier
    qrc.QRCClassifier
 
+ODE Solvers
+-----------
+
+.. currentmodule:: squlearn
+
+.. autosummary::
+   :nosignatures:
+   :toctree: generated/
+   :template: class.rst
+
+   kernel.QKODE
+
 Circuit Design
 ====================================
 
@@ -183,6 +195,7 @@ Quantum Kernel Core
 
    kernel.loss.negative_log_likelihood.NLL
    kernel.loss.target_alignment.TargetAlignment
+   kernel.loss.ODELoss
 
 QNN Core
 ------------------------------------
@@ -204,6 +217,7 @@ QNN Core
    qnn.lowlevel_qnn.lowlevel_qnn_qulacs.LowLevelQNNQulacs
    qnn.lowlevel_qnn.lowlevel_qnn_base.LowLevelQNNBase
    qnn.loss.SquaredLoss
+   qnn.loss.MeanSquaredError
    qnn.loss.CrossEntropyLoss
    qnn.loss.VarianceLoss
    qnn.loss.ODELoss