Merge branch 'main' into renovate/django-allauth-0.x

Author: IceKhan13

.github/workflows/update-component-versions.yaml

@@ -0,0 +1,70 @@
+name: Update Component Versions
+
+on:
+  workflow_dispatch:
+    inputs:
+      new_version:
+        description: 'version to update to'
+        required: true
+
+jobs:
+  update_component_versions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Install helm
+        shell: bash
+        run: |
+          curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
+      - name: Set variables
+        shell: bash
+        run: |
+          NEWNUM=${{ github.event.inputs.new_version }}
+          OLDTXT=$(git describe --tags $(git rev-list --tags --max-count=1))
+          OLDNUM="${OLDTXT:1}"
+          echo "NEWNUM=$NEWNUM" >> "$GITHUB_ENV"
+          echo "OLDNUM=$OLDNUM" >> "$GITHUB_ENV"
+      - name: Update observability chart
+        shell: bash
+        run: |
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/qs-observability/Chart.yaml
+          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/qs-observability/Chart.yaml
+      - name: Update quantum-serverless chart
+        shell: bash
+        run: |
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/quantum-serverless/Chart.yaml
+          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/quantum-serverless/Chart.yaml
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/quantum-serverless/charts/gateway/Chart.yaml
+          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/quantum-serverless/charts/gateway/Chart.yaml
+          sed -i "s/ray-node:${OLDNUM}/ray-node:${NEWNUM}/" charts/quantum-serverless/charts/gateway/values.yaml
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/quantum-serverless/charts/jupyter/Chart.yaml
+          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/quantum-serverless/charts/jupyter/Chart.yaml
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/quantum-serverless/charts/repository/Chart.yaml
+          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/quantum-serverless/charts/repository/Chart.yaml
+          sed -i "s/tag: \"${OLDNUM}\"/tag: \"${NEWNUM}\"/" charts/quantum-serverless/values.yaml
+          sed -i "s/tag: \"${OLDNUM}-py39\"/tag: \"${NEWNUM}-py39\"/" charts/quantum-serverless/values.yaml
+          sed -i "s/ray-node:${OLDNUM}/ray-node:${NEWNUM}/" charts/quantum-serverless/values.yaml
+          cd charts/quantum-serverless
+          helm dependency update
+          cd -
+      - name: Update client version
+        shell: bash
+        run: |
+          sed -i "s/${OLDNUM}/${NEWNUM}/" client/quantum_serverless/VERSION.txt
+      - name: Update compose
+        shell: bash
+        run: |
+          sed -i "s/VERSION:-${OLDNUM}/VERSION:-${NEWNUM}/g" docker-compose.yaml
+      - name: Update docs
+        shell: bash
+        run: |
+          sed -i "s/${OLDNUM}/${NEWNUM}/g" docs/deployment/cloud.rst
+      - name: Create PR
+        id: cpr
+        uses: peter-evans/create-pull-request@v5
+        with:
+          branch: "update-version-${{ github.event.inputs.new_version }}"
+          title: "update-version-${{ github.event.inputs.new_version }}"

README.md

@@ -71,20 +71,18 @@ For user convenience, this section assumes that users will deploy the infrastruc
 
 1. Access the JupyterLab environment
    Open `localhost:8888` in your web browser. The default token for the JupyterLab is `123`
-1. Write your first example program
-   In the JupyterLab, create a new file, `program.py`, in the `work` directory.
-   
-   Save [this example python code](https://qiskit-extensions.github.io/quantum-serverless/quickstart/index.html#id8).  
+1. Write your first example Qiskit Pattern.
+   In the JupyterLab, create a new file, `pattern.py`, in the `work` directory. You can include any arbitrary Python code in your program, or you can use the
+   [example Python file in this tutorial](https://github.com/Qiskit-Extensions/quantum-serverless/blob/main/docs/getting_started/basic/01_running_program.ipynb).
 
-   Now, you are ready to run the first program.
 1. Run the program
-   In the JupyterLab, create a new notebook in the same directory as your program, and execute [this python code](https://qiskit-extensions.github.io/quantum-serverless/quickstart/index.html#id9).
+   In the JupyterLab, create a new notebook in the same directory as your program, and execute [the tutorial code](https://github.com/Qiskit-Extensions/quantum-serverless/blob/main/docs/getting_started/basic/01_running_program.ipynb).
 
    You can check the job status and get the result.
 
    ```
    job.status()
-   # <JobStatus.SUCCEEDED: 'SUCCEEDED'>
+   # 'DONE'
 
    job.logs()
    # 2023-09-21 03:48:40,286\tINFO worker.py:1329 -- Using address 172.18.0.4:6379 set in the environment variable RAY_ADDRESS\n2023-09-21 03:48:40,286\tINFO worker.py:1458 -- Connecting to existing Ray cluster at address: 172.18.0.4:6379...\n2023-09-21 03:48:40,295\tINFO worker.py:1633 -- Connected to Ray cluster. View the dashboard at \x1b[1m\x1b[32m172.18.0.4:8265 \x1b[39m\x1b[22m\n
@@ -97,16 +95,18 @@ For user convenience, this section assumes that users will deploy the infrastruc
    That's all!
    
 For more detailed examples and explanations refer to the [Guide](https://qiskit-extensions.github.io/quantum-serverless/index.html):
-[Getting Started](https://qiskit-extensions.github.io/quantum-serverless/getting_started/index.html#),
-[Deployment](https://qiskit-extensions.github.io/quantum-serverless/deployment/index.html),
-[Development](https://qiskit-extensions.github.io/quantum-serverless/development/index.html).
+
+1. [Getting Started](https://qiskit-extensions.github.io/quantum-serverless/getting_started/index.html#)
+1. [Example Qiskit Patterns](https://qiskit-extensions.github.io/quantum-serverless/examples/index.html)
+1. [Infrastructure](https://qiskit-extensions.github.io/quantum-serverless/deployment/index.html)
+1. [Migrating from Qiskit Runtime programs](https://qiskit-extensions.github.io/quantum-serverless/migration/index.html)
 
 ----------------------------------------------------------------------------------------------------
 
 ### How to Give Feedback
 
 We encourage your feedback! You can share your thoughts with us by:
-- [Opening an issue](https://github.com/Qiskit-Extensions/quantum-serverless/issues) in the repository
+- Opening an [issue](https://github.com/Qiskit-Extensions/quantum-serverless/issues) in the repository
 
 
 ----------------------------------------------------------------------------------------------------
@@ -125,8 +125,8 @@ This project is meant to evolve rapidly and, as such, do not follow [Qiskit's de
 ----------------------------------------------------------------------------------------------------
 
 ## References and Acknowledgements
-[1] Qiskit Terra \
-    https://github.com/Qiskit/qiskit-terra
+[1] Qiskit \
+    https://github.com/Qiskit/qiskit
 
 [2] Client for IBM Qiskit Runtime \
     https://github.com/Qiskit/qiskit-ibm-runtime

client/README.md

@@ -106,7 +106,7 @@ Full docs can be found at https://qiskit-extensions.github.io/quantum-serverless
 
 ```python
    job.status()
-   # <JobStatus.SUCCEEDED: 'SUCCEEDED'>
+   # 'DONE'
 
    # or get logs
    job.logs()

client/quantum_serverless/core/job.py

@@ -132,7 +132,7 @@ def __init__(self, client: JobSubmissionClient):
         self._job_client = client
 
     def status(self, job_id: str):
-        return self._job_client.get_job_status(job_id)
+        return self._job_client.get_job_status(job_id).value
 
     def stop(self, job_id: str):
         return self._job_client.stop_job(job_id)
@@ -611,7 +611,7 @@ def __init__(
 
     def status(self):
         """Returns status of the job."""
-        return self._job_client.status(self.job_id)
+        return _map_status_to_serverless(self._job_client.status(self.job_id))
 
     def stop(self):
         """Stops the job from running."""
@@ -634,7 +634,7 @@ def result(self, wait=True, cadence=5, verbose=False):
         if wait:
             if verbose:
                 logging.info("Waiting for job result.")
-            while not self._in_terminal_state():
+            while not self.in_terminal_state():
                 time.sleep(cadence)
                 if verbose:
                     logging.info(".")
@@ -649,9 +649,9 @@ def result(self, wait=True, cadence=5, verbose=False):
 
         return results
 
-    def _in_terminal_state(self) -> bool:
+    def in_terminal_state(self) -> bool:
         """Checks if job is in terminal state"""
-        terminal_states = ["STOPPED", "SUCCEEDED", "FAILED"]
+        terminal_states = ["CANCELED", "DONE", "ERROR"]
         return self.status() in terminal_states
 
     def __repr__(self):
@@ -723,3 +723,20 @@ def save_result(result: Dict[str, Any]):
         logging.warning("Something went wrong: %s", response.text)
 
     return response.ok
+
+
+def _map_status_to_serverless(status: str) -> str:
+    """Map a status string from job client to the Qiskit terminology."""
+    status_map = {
+        "PENDING": "INITIALIZING",
+        "RUNNING": "RUNNING",
+        "STOPPED": "CANCELED",
+        "SUCCEEDED": "DONE",
+        "FAILED": "ERROR",
+        "QUEUED": "QUEUED",
+    }
+
+    try:
+        return status_map[status]
+    except KeyError:
+        return status

client/quantum_serverless/serializers/program_serializers.py

@@ -29,7 +29,7 @@
 import json
 import os
 from typing import Any, Dict
-
+from qiskit.primitives import SamplerResult, EstimatorResult
 from qiskit_ibm_runtime import QiskitRuntimeService
 from qiskit_ibm_runtime.utils.json import RuntimeDecoder, RuntimeEncoder
 
@@ -45,6 +45,16 @@ def default(self, obj: Any) -> Any:
                 "__type__": "QiskitRuntimeService",
                 "__value__": obj.active_account(),
             }
+        if isinstance(obj, SamplerResult):
+            return {
+                "__type__": "SamplerResult",
+                "__value__": {"quasi_dists": obj.quasi_dists, "metadata": obj.metadata},
+            }
+        if isinstance(obj, EstimatorResult):
+            return {
+                "__type__": "EstimatorResult",
+                "__value__": {"values": obj.values, "metadata": obj.metadata},
+            }
         return super().default(obj)
 
 
@@ -57,6 +67,10 @@ def object_hook(self, obj: Any) -> Any:
 
             if obj_type == "QiskitRuntimeService":
                 return QiskitRuntimeService(**obj["__value__"])
+            if obj_type == "SamplerResult":
+                return SamplerResult(**obj["__value__"])
+            if obj_type == "EstimatorResult":
+                return EstimatorResult(**obj["__value__"])
             return super().object_hook(obj)
         return obj
 

client/requirements-notebook.txt

@@ -5,6 +5,6 @@ ipywidgets==8.1.1
 circuit-knitting-toolbox==0.4.0
 matplotlib==3.7.1
 qiskit-ibmq-provider==0.20.2
-qiskit-aer==0.12.0
+qiskit-aer==0.13.0
 certifi==2023.7.22
 ipython==8.13.0

client/requirements.txt

@@ -1,8 +1,8 @@
 ray[default,data]>=2.6.3, <3
 requests>=2.31.0
 importlib-metadata>=5.2.0
-qiskit>=0.44.1
-qiskit-ibm-runtime>=0.12.0
+qiskit>=0.44.3
+qiskit-ibm-runtime>=0.13.0
 cloudpickle>=2.2.1
 tqdm>=4.65.0
 # opentelemetry

client/tests/core/test_pattern.py

@@ -1,7 +1,6 @@
 """Tests jobs."""
 import os
 
-from ray.dashboard.modules.job.common import JobStatus
 from testcontainers.compose import DockerCompose
 
 from quantum_serverless import QuantumServerless, BaseProvider
@@ -49,12 +48,12 @@ def test_program():
         wait_for_job_completion(job)
 
         assert "42" in job.logs()
-        assert job.status().is_terminal()
-        assert job.status() == JobStatus.SUCCEEDED
+        assert job.in_terminal_state()
+        assert job.status() == "DONE"
 
         recovered_job = serverless.get_job_by_id(job.job_id)
         assert recovered_job.job_id == job.job_id
         assert "42" in recovered_job.logs()
-        assert recovered_job.status().is_terminal()
-        assert recovered_job.status() == JobStatus.SUCCEEDED
+        assert recovered_job.in_terminal_state()
+        assert recovered_job.status() == "DONE"
         assert isinstance(job.stop(), bool)

client/tests/utils.py

@@ -18,6 +18,6 @@ def wait_for_job_completion(job: Job, timeout: int = 60):
     """Utility function that waits for job completion."""
     must_finish = time.time() + timeout
     while time.time() < must_finish:
-        if job.status().is_terminal():
+        if job.in_terminal_state():
             break
         time.sleep(1)

docs/requirements-doc.txt

@@ -15,5 +15,5 @@ reno>=3.5.0
 # the ~= specifier for it.
 black[jupyter]~=22.12
 sphinx-copybutton>=0.5.2
-qiskit-sphinx-theme~=1.15.2
+qiskit-sphinx-theme~=1.16.0
 tox>=4.0.0