From a8c3ead31af723be083f7669592be3fcc2734e4b Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Mon, 29 Apr 2024 18:10:33 -0500 Subject: [PATCH 1/6] Remove discussion about user's compute env from knitting docs --- README.md | 6 +----- docs/index.rst | 4 ---- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index 61e1fb8bf..3e68eba96 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,7 @@ ### About -Circuit Knitting is the process of decomposing a quantum circuit into smaller circuits, executing those smaller circuits on a quantum processor(s), and then knitting their results into a reconstruction of the original circuit's outcome. - -Each tool in the CKT partitions a user's problem into quantum and classical components to enable efficient use of resources constrained by scaling limits, i.e. size of quantum processors and classical compute capability. It can assign the execution of "quantum code" to QPUs or QPU simulators and "classical code" to various heterogeneous classical resources such as CPUs, GPUs, and TPUs made available via hybrid cloud, on-prem, data centers, etc. - -The toolbox enables users to run parallelized and hybrid (quantum + classical) workloads without worrying about allocating and managing underlying infrastructure. +Circuit Knitting is the process of decomposing a larger quantum circuit into many smaller circuits, executing those circuits on a quantum processor(s), and then knitting their results into a reconstruction of the original circuit's outcome. The toolbox currently contains the following tools: - Circuit Cutting [[1-6]](#references) diff --git a/docs/index.rst b/docs/index.rst index 643a972ed..98e310ecd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,10 +8,6 @@ Circuit Knitting Toolbox Circuit Knitting is the process of decomposing a quantum circuit into smaller circuits, executing those smaller circuits on a quantum processor(s), and then knitting their results into a reconstruction of the original circuit's outcome. -The toolbox currently contains the following tools: - -- Circuit Cutting - This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy `_. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. Citing this project From 7c1fc860f7210445064d054c79f1a1f903622e01 Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Mon, 29 Apr 2024 18:11:42 -0500 Subject: [PATCH 2/6] revert deletion in index.rat --- docs/index.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 98e310ecd..643a972ed 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,6 +8,10 @@ Circuit Knitting Toolbox Circuit Knitting is the process of decomposing a quantum circuit into smaller circuits, executing those smaller circuits on a quantum processor(s), and then knitting their results into a reconstruction of the original circuit's outcome. +The toolbox currently contains the following tools: + +- Circuit Cutting + This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy `_. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. Citing this project From d51d0ad631f2591a0873d81e985763d0361c33fa Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Mon, 29 Apr 2024 18:14:20 -0500 Subject: [PATCH 3/6] link to explanatory --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e68eba96..d7a592ade 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,8 @@ Circuit Knitting is the process of decomposing a larger quantum circuit into man The toolbox currently contains the following tools: - Circuit Cutting [[1-6]](#references) - + +For a more detailed discussion on circuit cutting, check out our [technical guide](https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/explanation/index.html#overview-of-circuit-cutting). ---------------------------------------------------------------------------------------------------- ### Documentation From ac9c451c8fa385f21d598ca8c1cead9367e537d0 Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Mon, 29 Apr 2024 18:20:28 -0500 Subject: [PATCH 4/6] Add blurb to docs/index --- docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 643a972ed..d460a19a8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,8 @@ The toolbox currently contains the following tools: - Circuit Cutting +For a more detailed discussion on circuit cutting, check out our `technical guide `. + This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy `_. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. Citing this project From 771e1d9e36fb71d1b06edc1b1f4e2932c69588ea Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Mon, 29 Apr 2024 18:28:08 -0500 Subject: [PATCH 5/6] fix link --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index d460a19a8..75912529f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,9 +12,9 @@ The toolbox currently contains the following tools: - Circuit Cutting -For a more detailed discussion on circuit cutting, check out our `technical guide `. +For a more detailed discussion on circuit cutting, check out our `technical guide `__. -This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy `_. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. +This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy `__. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. Citing this project ------------------- From af439e8c6254ac9c12ebd9f267ccceefd0b2a57a Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Tue, 30 Apr 2024 10:14:49 -0500 Subject: [PATCH 6/6] Update docs/index.rst Co-authored-by: Jim Garrison --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 75912529f..34893a581 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,7 +12,7 @@ The toolbox currently contains the following tools: - Circuit Cutting -For a more detailed discussion on circuit cutting, check out our `technical guide `__. +For a more detailed discussion on circuit cutting, check out our `technical guide <./circuit_cutting/explanation/index.rst#overview-of-circuit-cutting>`__. This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy `__. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`.