Merge pull request #238 from mit-han-lab/docs_ii

Same Docs Updates as #231 without DM

.github/workflows/functional_tests.yaml

@@ -25,8 +25,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest qiskit-aer qiskit-ibmq-provider
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        python -m pip install flake8 pytest qiskit-aer qiskit_ibm_runtime
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

docs/requirements.txt

@@ -0,0 +1,7 @@
+furo @ git+https://github.com/frogcjn/torchquantum-doc-furo-theme.git
+nbsphinx
+recommonmark
+
+torchquantum>=0.1
+opt_einsum
+qiskit_ibm_runtime

docs/source/conf.py

@@ -29,7 +29,6 @@
 import sys
 import os
 sys.path.insert(0, os.path.abspath('../..'))
-import furo
 
 #import pathlib
 #sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
@@ -160,4 +159,4 @@
 display_gitlab = False
 show_source = True
 # -- Options for EPUB output
-epub_show_urls = 'footnote'
+epub_show_urls = 'footnote'

readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

requirements.txt

@@ -8,7 +8,7 @@ opt_einsum
 pathos>=0.2.7
 pylatexenc>=2.10
 pyscf>=2.0.1
-qiskit>=0.39.0
+qiskit>=0.39.0,<1.0.0
 recommonmark
 
 scipy>=1.5.2

torchquantum/util/utils.py

@@ -30,7 +30,7 @@
 import torch.nn as nn
 import torch.nn.functional as F
 from opt_einsum import contract
-from qiskit import IBMQ
+from qiskit_ibm_runtime import QiskitRuntimeService
 from qiskit.exceptions import QiskitError
 from qiskit.providers.aer.noise.device.parameters import gate_error_values
 from torchpack.utils.config import Config
@@ -738,7 +738,6 @@ def get_success_rate(properties, transpiled_circ):
 
     return success_rate
 
-
 def get_provider(backend_name, hub=None):
     """
         Get the provider object for a specific backend from IBM Quantum.
@@ -753,13 +752,9 @@ def get_provider(backend_name, hub=None):
     # mass-inst-tech-1 or MIT-1
     if backend_name in ["ibmq_casablanca", "ibmq_rome", "ibmq_bogota", "ibmq_jakarta"]:
         if hub == "mass" or hub is None:
-            provider = IBMQ.get_provider(
-                hub="ibm-q-research", group="mass-inst-tech-1", project="main"
-            )
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/mass-inst-tech-1/main")
         elif hub == "mit":
-            provider = IBMQ.get_provider(
-                hub="ibm-q-research", group="MIT-1", project="main"
-            )
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/MIT-1/main")
         else:
             raise ValueError(f"not supported backend {backend_name} in hub " f"{hub}")
     elif backend_name in [
@@ -769,33 +764,25 @@ def get_provider(backend_name, hub=None):
         "ibmq_guadalupe",
         "ibmq_montreal",
     ]:
-        provider = IBMQ.get_provider(hub="ibm-q-ornl", group="anl", project="csc428")
+        provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-ornl/anl/csc428")
     else:
         if hub == "mass" or hub is None:
             try:
-                provider = IBMQ.get_provider(
-                    hub="ibm-q-research", group="mass-inst-tech-1", project="main"
-                )
+                provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/mass-inst-tech-1/main")
             except QiskitError:
                 # logger.warning(f"Cannot use MIT backend, roll back to open")
                 logger.warning(f"Use the open backend")
-                provider = IBMQ.get_provider(hub="ibm-q", group="open", project="main")
+                provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q/open/main")
         elif hub == "mit":
-            provider = IBMQ.get_provider(
-                hub="ibm-q-research", group="MIT-1", project="main"
-            )
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/MIT-1/main")
         else:
-            provider = IBMQ.get_provider(hub="ibm-q", group="open", project="main")
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q/open/main")
 
     return provider
 
 
 def get_provider_hub_group_project(hub="ibm-q", group="open", project="main"):
-    provider = IBMQ.get_provider(
-        hub=hub,
-        group=group,
-        project=project,
-    )
+    provider = QiskitRuntimeService(channel = "ibm_quantum", instance = f"{hub}/{group}/{project}")
     return provider
 
 
@@ -1085,4 +1072,4 @@ def clone_model(model_to_clone):#i have to note:this clone_model function was ma
         state_dict_minus_shift[key] +=  shift_rate
 
         gradient_of_par[idx-2] = (expectation_plus_shift - expectation_minus_shift) * 0.5
-    return gradient_of_par
+    return gradient_of_par