iqm-benchmarks 1.3__tar.gz

iqm_benchmarks-1.3/.github/workflows/main.yml

@@ -0,0 +1,60 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request' || startsWith(github.ref, 'refs/tags/')
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11.3
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: pip install tox==4.16.0
+      - name: Check Python packages
+        run: python -m pip check
+      - name: Run tests
+        run: tox -e test
+
+  run_benchmark:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' || github.event_name == 'schedule'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11.3
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: pip install tox==4.16.0
+      - name: Run benchmark
+        run: tox -e benchmark -- --backend=${{ github.event.inputs.backend || 'iqmfakeadonis' }}
+      - name: Upload benchmark results
+        uses: actions/upload-artifact@v2
+        with:
+          name: benchmark-results
+          path: Outputs
+

iqm_benchmarks-1.3/.github/workflows/publish.yml

@@ -0,0 +1,49 @@
+name: Upload package to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Fetch all history for all tags and branches
+        run: git fetch --prune --unshallow
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build==1.0.3
+      - name: Build distribution
+        run: python -m build
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: ./dist
+
+  push_to_pypi:
+    runs-on: ubuntu-latest
+    needs:
+    - build
+    environment:
+      name: pypi
+      url: https://pypi.org/p/iqm-benchmarks
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distribution packages
+        uses: actions/download-artifact@v4
+      - name: Publish distribution packages to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+            attestations: false

iqm_benchmarks-1.3/.github/workflows/tag_and_release.yml

@@ -0,0 +1,45 @@
+name: Create tag and release
+
+on:
+  pull_request:
+    paths:
+      - 'CHANGELOG.rst'
+  push:
+    branches:
+      - main
+    paths:
+      - 'CHANGELOG.rst'
+
+jobs:
+
+  check_version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+            fetch-depth: 0
+      - name: Verify changelog version
+        run: bash ./tag-from-pipeline.sh verify_changelog_version
+
+  create_tag_and_release:
+    needs: check_version
+    runs-on: ubuntu-latest
+    if: |
+      github.ref == 'refs/heads/main' &&
+      github.event.head_commit.message != 'skip ci'
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Create new tag and release
+        run: bash ./tag-from-pipeline.sh create_new_tag
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  # GitHub works so that events ('release' event in this case) triggered while using the GITHUB_TOKEN will not create a
+  # new workflow run. This means the publishing workflow will not be triggered even though a new release is successfully
+  # created by the above job create_tag_and_release. Here we trigger the said workflow manually.
+  trigger_publishing:
+    needs: create_tag_and_release
+    uses: ./.github/workflows/publish.yml

iqm_benchmarks-1.3/.gitignore

@@ -0,0 +1,31 @@
+# Temporary and binary files
+*~
+*.swp
+__pycache__/
+*.pyc
+.ipynb_checkpoints/
+*.png
+*.jpg
+*.jpeg
+
+# Package files
+*.eggs/
+*.egg-info/
+*.egg-info/*
+
+# Environments
+/.tox/
+/.venv/
+
+# Build and docs folder/files
+/build/
+/dist/
+version.txt
+
+# OS generated files
+**/.DS_Store
+
+.idea/*
+
+/Outputs/
+/tests/Outputs/

iqm_benchmarks-1.3/CHANGELOG.rst

@@ -0,0 +1,26 @@
+=========
+Changelog
+=========
+
+Version 1.3
+===========
+
+* Further improvements to type hints, docstrings, and error messages.
+
+Version 1.2
+===========
+
+* Minor improvements to type hints, docstrings, and error messages.
+
+Version 1.1
+===========
+
+* Fixed bug preventing execution on a generic IQM Backend.
+* Randomized Benchmarking (Clifford, Interleaved and Mirror), Quantum Volume, CLOPS and GHZ state fidelity all functioning exclusively under new Benchmark base class.
+* Updated separate example Jupyter notebooks.
+
+Version 1.0
+===========
+
+* Published Randomized Benchmarking (Clifford, Interleaved and Mirror), Quantum Volume, CLOPS and GHZ state fidelity all functioning exclusively under new Benchmark base class.
+* Updated separate example Jupyter notebooks.

iqm_benchmarks-1.3/LICENSE

@@ -0,0 +1,205 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IQM
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+This repository contains also code from other authors, which is licensed under the following licences:
+* mGST under MIT License (in `src/mGST`) by Raphael Brieger, Ingo Roth, Martin Kliesch (see LICENSE file in mGST folder)

iqm_benchmarks-1.3/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.1
+Name: iqm-benchmarks
+Version: 1.3
+Summary: A package for implementation of Quantum Characterization, Verification and Validation (QCVV) techniques on IQM's hardware at gate level abstraction
+Author-email: IQM Finland Oy <developers@meetiqm.com>, Aniket Rath <aniket.rath@meetiqm.com>, Jami Rönkkö <jami@meetiqm.com>, Pedro Figueroa Romero <pedro.romero@meetiqm.com>, Vicente Pina Canelles <vicente.pina@meetiqm.com>, Raphael Brieger <raphael.brieger@meetiqm.com>, Stefan Seegerer <stefan.seegerer@meetiqm.com>
+Project-URL: Homepage, https://github.com/iqm-finland/iqm-benchmarks
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lmfit==1.3.1
+Requires-Dist: matplotlib==3.9.0
+Requires-Dist: more-itertools==10.1.0
+Requires-Dist: mthree==2.6.3
+Requires-Dist: networkx==2.8.8
+Requires-Dist: numpy>=1.24.2
+Requires-Dist: qiskit==0.45.3
+Requires-Dist: qiskit-aer==0.13.3
+Requires-Dist: qiskit-iqm==15.1
+Requires-Dist: scikit-optimize==0.10.2
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: uncertainties==3.2.1
+Requires-Dist: pycurl==7.45.3
+Requires-Dist: xarray==2024.6.0
+Requires-Dist: types-pycurl
+Provides-Extra: develop
+Requires-Dist: tox==4.16.0; extra == "develop"
+Provides-Extra: examples
+Requires-Dist: notebook==7.2.1; extra == "examples"
+Provides-Extra: mgst
+Requires-Dist: numpy<2.0; extra == "mgst"
+Requires-Dist: cvxpy==1.5.3; extra == "mgst"
+Requires-Dist: pygsti==0.9.12.3; extra == "mgst"
+Requires-Dist: tqdm==4.66.5; extra == "mgst"
+Requires-Dist: numba==0.60.0; extra == "mgst"
+Provides-Extra: test
+Requires-Dist: black==24.4.2; extra == "test"
+Requires-Dist: isort==5.13.2; extra == "test"
+Requires-Dist: mypy==1.10.1; extra == "test"
+Requires-Dist: pylint==3.2.5; extra == "test"
+Requires-Dist: pytest==7.4.4; extra == "test"
+Requires-Dist: pytest-cov==4.1.0; extra == "test"
+Requires-Dist: pytest-isort==3.1.0; extra == "test"
+Requires-Dist: pytest-mypy==0.10.3; extra == "test"
+Requires-Dist: pytest-pylint==0.21.0; extra == "test"
+
+# IQM Benchmarks
+
+The IQM Benchmarks is a suite of quantum characterization, verification, and validation (QCVV) tools for quantum computing. It is designed to be a comprehensive tool for benchmarking quantum hardware. The suite is designed to be modular, allowing users to easily add new benchmarks and customize existing ones. The suite is designed to be easy to use, with a simple API that allows users to run benchmarks with a single command.
+
+
+Below is a list of the benchmarks currently available in the suite:
+* Randomized Benchmarking: A suite of randomized benchmarking protocols for characterizing the performance of quantum gates (Clifford Randomized Benchmarking, Mirror Randomized Benchmarking, Interleaved Randomized Benchmarking).
+* Quantum Volume: A benchmark for characterizing the performance of quantum computers.
+* Q-Score: A benchmark that estimates the size of combinatorial optimization problems a given number of qubits can execute with meaningful results.
+* GHZ State Benchmarking: A benchmark for characterizing the performance of multi-qubit entangled states.
+
+
+The project is split into different benchmarks, all sharing the `Benchmark` class or the legacy `BenchmarkBase` class. Each individual benchmark takes as an argument their own `BenchmarkConfigurationBase` class. All the (legacy) benchmarks executed at once are wrapped by the `BenchmarkExperiment` class, which handles dependencies among the benchmarks, storing the results, producing the plots...
+
+
+## Installation _(latest release)_
+
+Usually it makes sense to use a new Conda environment (e.g. ``iqm-benchmarks``) to isolate your setup from the global Python installation. That way, you can play around without messing the rest of your system.
+
+Start a terminal in your machine, and type
+
+```
+conda create -n iqm-benchmarks python=3.11.2
+conda activate iqm-benchmarks
+```
+
+Then, you can install the latest release of the IQM Benchmarks by running:
+```bash
+$ pip install iqm-benchmarks
+```
+
+If you have already installed `iqm-benchmarks` and want to get the latest release you can add the --upgrade flag:
+
+```bash
+pip install iqm-benchmarks --upgrade
+```
+
+## Development mode _(latest changes: recommended)_
+
+To install in development mode with all required dependencies, you can instead clone the [repository](https://www.github.com/iqm-finland/iqm-benchmarks) and from the project directory run
+
+```bash
+python -m pip install -e ".[develop,test]" --upgrade --upgrade-strategy=eager
+```
+
+To run the tests, you can use the following command:
+
+```bash
+tox -e test
+```
+
+## Characterize Physical Hardware
+
+The IQM Benchmarks suite is designed to be used with real quantum hardware. To use the suite, you will need to have access to a quantum computer. The suite is designed to work with both IQM Resonance (IQM's quantum cloud service) and on-prem devices, but can be easily adapted to work with other quantum computing platforms.
+
+To use the suite with IQM Resonance, you will need to set up an account and obtain an API token. You can then set the `IQM_TOKEN` environment variable to your API token. The suite will automatically use this token to authenticate with IQM Resonance.
+
+```python
+import os
+os.environ["IQM_TOKEN"] = "your_token"
+```
+
+### Using a Jupyter notebook or Python script
+
+You can easily set up one or more benchmarks by defining a configuration for them. For example, for Randomized, Interleaved and Mirror Benchmarking, or Quantum Volume:
+
+```python
+from iqm.benchmarks.randomized_benchmarking.interleaved_rb.interleaved_rb import InterleavedRBConfiguration
+from iqm.benchmarks.randomized_benchmarking.mirror_rb.mirror_rb import MirrorRBConfiguration
+from iqm.benchmarks.quantum_volume.quantum_volume import QuantumVolumeConfiguration
+
+EXAMPLE_IRB = InterleavedRBConfiguration(
+    qubits_array=[[3,4],[8,9]],
+    sequence_lengths=[2**(m+1)-1 for m in range(7)],
+    num_circuit_samples=30,
+    shots=2**10,
+    calset_id=None,
+    parallel_execution=True,
+    interleaved_gate = "iSwapGate",
+    interleaved_gate_params = None,
+    simultaneous_fit = ["amplitude", "offset"],
+)
+
+EXAMPLE_MRB = MirrorRBConfiguration(
+    qubits_array=[[0,1],
+                  [0,1,3,4],
+                  [0,1,3,4,8,9],
+                  [0,1,3,4,8,9,13,14],
+                  [0,1,3,4,8,9,13,14,17,18]],
+    depths_array=[[2**m for m in range(9)],
+                  [2**m for m in range(8)],
+                  [2**m for m in range(7)],
+                  [2**m for m in range(6)],
+                  [2**m for m in range(5)]],
+    num_circuit_samples=10,
+    num_pauli_samples=5,
+    shots=2**8,
+    two_qubit_gate_ensemble={"CZGate": 0.7, "iSwapGate": 0.3}, # {GATE: PROBABILITY}
+    density_2q_gates=0.25,
+    calset_id=None,
+)
+
+EXAMPLE_QV = QuantumVolumeConfiguration(
+    num_circuits=500,
+    shots=2**8,
+    calset_id=None,
+    num_sigmas=2,
+    choose_qubits_routine="custom",
+    custom_qubits_array=[[0,1,2,3], [0,1,3,4]],
+    qiskit_optim_level=3,
+    optimize_sqg=True,
+    routing_method="sabre",
+    physical_layout="fixed",
+    max_gates_per_batch=60_000,
+    rem=True,
+    mit_shots=1_000,
+)
+```
+
+In order to execute them, you must specify a backend.
+* for IQM Resonance this can be given as a simple string, such as "garnet" (together with your IQM Token environment variable)
+* and for an on-prem device and IQM Resonance this can be defined using the URL of the quantum computer.
+
+Also, you need to reference the benchmark configuration you want to run:
+
+```python
+from iqm.benchmarks.randomized_benchmarking.mirror_rb.mirror_rb import *
+# import os
+# os.environ["IQM_TOKEN"] = "your_token"
+
+backend = IQMProvider("https://example-station.qc.iqm.fi/cocos/").get_backend()
+
+EXAMPLE_EXPERIMENT = MirrorRandomizedBenchmarking(backend, EXAMPLE_MRB)
+EXAMPLE_EXPERIMENT.run()
+```
+
+Full examples on how to run benchmarks and analyze the results can be found in the `examples` folder.
+
+### Scheduled benchmarks using a CI/CD Pipeline
+
+This repository can be setup to perform a scheduled (weekly, daily...) benchmark from a Gitlab/Github pipeline, executed on a real device. An example configuration is given in the `scheduled_experiments` folder.