qiskit-serverless 0.11.0__tar.gz

qiskit_serverless-0.11.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.1
+Name: qiskit_serverless
+Version: 0.11.0
+Keywords: qiskit serverless quantum computing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+[![Stability](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/Qiskit-Extensions/qiskit-serverless/releases)
+[![Client verify process](https://github.com/Qiskit-Extensions/qiskit-serverless/actions/workflows/client-verify.yaml/badge.svg)](https://github.com/Qiskit-Extensions/qiskit-serverless/actions/workflows/client-verify.yaml)
+[![License](https://img.shields.io/github/license/qiskit-community/quantum-prototype-template?label=License)](https://github.com/qiskit-community/quantum-prototype-template/blob/main/LICENSE.txt)
+[![Code style: Black](https://img.shields.io/badge/Code%20style-Black-000.svg)](https://github.com/psf/black)
+[![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-informational)](https://www.python.org/)
+[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%200.39.0-6133BD)](https://github.com/Qiskit/qiskit)
+
+# Qiskit Serverless client
+
+![diagram](https://raw.githubusercontent.com/Qiskit-Extensions/qiskit-serverless/main/docs/images/qs_diagram.png)
+
+# Installation
+
+```shell
+pip install qiskit_serverless
+```
+
+## Documentation
+
+Full docs can be found at https://qiskit-extensions.github.io/qiskit-serverless/
+
+## Usage
+
+### Step 1: write pattern
+
+```python
+  from qiskit_serverless import distribute_task, get, get_arguments, save_result
+
+   from qiskit import QuantumCircuit
+   from qiskit.circuit.random import random_circuit
+   from qiskit.primitives import Sampler
+   from qiskit.quantum_info import SparsePauliOp
+
+   # 1. let's annotate out function to convert it
+   # to distributed async function
+   # using `distribute_task` decorator
+   @distribute_task()
+   def distributed_sample(circuit: QuantumCircuit):
+       """Calculates quasi dists as a distributed function."""
+       return Sampler().run(circuit).result().quasi_dists[0]
+
+
+   # 2. our program will have one arguments
+   # `circuits` which will store list of circuits
+   # we want to sample in parallel.
+   # Let's use `get_arguments` funciton
+   # to access all program arguments
+   arguments = get_arguments()
+   circuits = arguments.get("circuits", [])
+
+   # 3. run our functions in a loop
+   # and get execution references back
+   function_references = [
+       distributed_sample(circuit)
+       for circuit in circuits
+   ]
+
+   # 4. `get` function will collect all
+   # results from distributed functions
+   collected_results = get(function_references)
+
+   # 5. `save_result` will save results of program execution
+   # so we can access it later
+   save_result({
+       "quasi_dists": collected_results
+   })
+```
+ 
+
+### Step 2: run pattern
+
+```python
+   from qiskit_serverless import ServerlessProvider, QiskitPattern
+   from qiskit.circuit.random import random_circuit
+
+   serverless = ServerlessProvider(
+       username="<USERNAME>", 
+       password="<PASSWORD>",
+       host="<GATEWAY_ADDRESS>",
+   )
+
+   # create program
+   program = QiskitPattern(
+       title="Quickstart",
+       entrypoint="pattern.py",
+       working_dir="./src"
+   )
+
+   # create inputs to our program
+   circuits = []
+   for _ in range(3):
+       circuit = random_circuit(3, 2)
+       circuit.measure_all()
+       circuits.append(circuit)
+
+   # run program
+   job = serverless.run(
+       program=program,
+       arguments={
+           "circuits": circuits
+       }
+   )
+```
+
+### Step 3: monitor job status
+
+```python
+   job.status()
+   # 'DONE'
+    
+   # or get logs
+   job.logs()
+```
+
+
+### Step 4: get results
+
+```python
+   job.result()
+   # {"quasi_dists": [
+   #  {"0": 0.25, "1": 0.25, "2": 0.2499999999999999, "3": 0.2499999999999999},
+   #  {"0": 0.1512273969460124, "1": 0.0400459556274728, "6": 0.1693190975212014, "7": 0.6394075499053132},
+   #  {"0": 0.25, "1": 0.25, "4": 0.2499999999999999, "5": 0.2499999999999999}
+   # ]}
+```

qiskit_serverless-0.11.0/README.md

@@ -0,0 +1,125 @@
+[![Stability](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/Qiskit-Extensions/qiskit-serverless/releases)
+[![Client verify process](https://github.com/Qiskit-Extensions/qiskit-serverless/actions/workflows/client-verify.yaml/badge.svg)](https://github.com/Qiskit-Extensions/qiskit-serverless/actions/workflows/client-verify.yaml)
+[![License](https://img.shields.io/github/license/qiskit-community/quantum-prototype-template?label=License)](https://github.com/qiskit-community/quantum-prototype-template/blob/main/LICENSE.txt)
+[![Code style: Black](https://img.shields.io/badge/Code%20style-Black-000.svg)](https://github.com/psf/black)
+[![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-informational)](https://www.python.org/)
+[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%200.39.0-6133BD)](https://github.com/Qiskit/qiskit)
+
+# Qiskit Serverless client
+
+![diagram](https://raw.githubusercontent.com/Qiskit-Extensions/qiskit-serverless/main/docs/images/qs_diagram.png)
+
+# Installation
+
+```shell
+pip install qiskit_serverless
+```
+
+## Documentation
+
+Full docs can be found at https://qiskit-extensions.github.io/qiskit-serverless/
+
+## Usage
+
+### Step 1: write pattern
+
+```python
+  from qiskit_serverless import distribute_task, get, get_arguments, save_result
+
+   from qiskit import QuantumCircuit
+   from qiskit.circuit.random import random_circuit
+   from qiskit.primitives import Sampler
+   from qiskit.quantum_info import SparsePauliOp
+
+   # 1. let's annotate out function to convert it
+   # to distributed async function
+   # using `distribute_task` decorator
+   @distribute_task()
+   def distributed_sample(circuit: QuantumCircuit):
+       """Calculates quasi dists as a distributed function."""
+       return Sampler().run(circuit).result().quasi_dists[0]
+
+
+   # 2. our program will have one arguments
+   # `circuits` which will store list of circuits
+   # we want to sample in parallel.
+   # Let's use `get_arguments` funciton
+   # to access all program arguments
+   arguments = get_arguments()
+   circuits = arguments.get("circuits", [])
+
+   # 3. run our functions in a loop
+   # and get execution references back
+   function_references = [
+       distributed_sample(circuit)
+       for circuit in circuits
+   ]
+
+   # 4. `get` function will collect all
+   # results from distributed functions
+   collected_results = get(function_references)
+
+   # 5. `save_result` will save results of program execution
+   # so we can access it later
+   save_result({
+       "quasi_dists": collected_results
+   })
+```
+ 
+
+### Step 2: run pattern
+
+```python
+   from qiskit_serverless import ServerlessProvider, QiskitPattern
+   from qiskit.circuit.random import random_circuit
+
+   serverless = ServerlessProvider(
+       username="<USERNAME>", 
+       password="<PASSWORD>",
+       host="<GATEWAY_ADDRESS>",
+   )
+
+   # create program
+   program = QiskitPattern(
+       title="Quickstart",
+       entrypoint="pattern.py",
+       working_dir="./src"
+   )
+
+   # create inputs to our program
+   circuits = []
+   for _ in range(3):
+       circuit = random_circuit(3, 2)
+       circuit.measure_all()
+       circuits.append(circuit)
+
+   # run program
+   job = serverless.run(
+       program=program,
+       arguments={
+           "circuits": circuits
+       }
+   )
+```
+
+### Step 3: monitor job status
+
+```python
+   job.status()
+   # 'DONE'
+    
+   # or get logs
+   job.logs()
+```
+
+
+### Step 4: get results
+
+```python
+   job.result()
+   # {"quasi_dists": [
+   #  {"0": 0.25, "1": 0.25, "2": 0.2499999999999999, "3": 0.2499999999999999},
+   #  {"0": 0.1512273969460124, "1": 0.0400459556274728, "6": 0.1693190975212014, "7": 0.6394075499053132},
+   #  {"0": 0.25, "1": 0.25, "4": 0.2499999999999999, "5": 0.2499999999999999}
+   # ]}
+```

qiskit_serverless-0.11.0/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = ["setuptools>=69.2.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+filterwarnings = ["ignore:::.*qiskit.opflow.*", "ignore:::.*qiskit.primitives.*"]

qiskit_serverless-0.11.0/qiskit_serverless/__init__.py

@@ -0,0 +1,51 @@
+# This code is a Qiskit project.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+.. currentmodule:: qiskit_serverless
+
+.. autosummary::
+    :toctree: ../stubs/
+
+    QiskitServerlessException
+"""
+# pylint: disable=W0404
+from importlib_metadata import version as metadata_version, PackageNotFoundError
+
+from .core import (
+    BaseProvider,
+    BaseClient,
+    distribute_task,
+    distribute_qiskit_function,
+    get,
+    put,
+    get_refs_by_status,
+    ServerlessProvider,
+    ServerlessClient,
+    IBMServerlessProvider,
+    IBMServerlessClient,
+    RayProvider,
+    RayClient,
+    LocalProvider,
+    LocalClient,
+    save_result,
+    Configuration,
+)
+from .exception import QiskitServerlessException
+from .core.function import QiskitPattern, QiskitFunction
+from .serializers import get_arguments
+
+try:
+    __version__ = metadata_version("qiskit_serverless")
+except PackageNotFoundError:  # pragma: no cover
+    # package is not installed
+    pass

qiskit_serverless-0.11.0/qiskit_serverless/core/__init__.py

@@ -0,0 +1,89 @@
+# This code is a Qiskit project.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+============================================
+Core module (:mod:`qiskit_serverless.core`)
+============================================
+
+.. currentmodule:: qiskit_serverless.core
+
+Qiskit Serverless core module classes and functions
+====================================================
+
+Core abstractions
+-----------------
+
+.. autosummary::
+    :toctree: ../stubs/
+
+    ServerlessClient
+    IBMServerlessClient
+    BaseClient
+    RayClient
+    LocalClient
+    ComputeResource
+    Job
+    GatewayJobClient
+    BaseJobClient
+    RayJobClient
+    save_result
+    QiskitPattern
+    QiskitFunction
+    Target
+    CircuitMeta
+    fetch_execution_meta
+    distribute_task
+    distribute_program
+    distribute_qiskit_function
+    get
+    put
+    get_refs_by_status
+
+"""
+
+from .client import (
+    BaseProvider,
+    BaseClient,
+    ComputeResource,
+    ServerlessProvider,
+    ServerlessClient,
+    IBMServerlessProvider,
+    IBMServerlessClient,
+    LocalProvider,
+    LocalClient,
+    RayProvider,
+    RayClient,
+)
+
+from .job import (
+    BaseJobClient,
+    RayJobClient,
+    GatewayJobClient,
+    LocalJobClient,
+    Job,
+    save_result,
+    Configuration,
+)
+from .function import QiskitPattern, QiskitFunction
+from .decorators import (
+    remote,
+    get,
+    put,
+    get_refs_by_status,
+    fetch_execution_meta,
+    distribute_task,
+    distribute_qiskit_function,
+    distribute_program,
+    Target,
+    CircuitMeta,
+)