Add mode parameter #1584
Merged
Add mode parameter #1584
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ptristan3
added
the
Changelog: Deprecation
ptristan3
added
the
Changelog: New Feature
Pull Request Test Coverage Report for Build 8739878057Details
💛 - Coveralls |
jyu00
requested changes
Apr 5, 2024
Comment on lines
+171
to
+172
| def mode(self) -> Optional[Session | Batch]: | ||
| """Return the execution mode used by this primitive. |
There was a problem hiding this comment.
We can't just remove the session attribute without deprecating it first.
jyu00
reviewed
Apr 5, 2024
qiskit_ibm_runtime/estimator.py
Outdated
| "The session argument is going to be consolidated into the mode param.", | ||
| ) | ||
| if isinstance(mode, str) or isinstance(backend, str): | ||
| raise ValueError( |
There was a problem hiding this comment.
As mentioned earlier, this needs to be deprecated first.
qiskit_ibm_runtime/estimator.py
Outdated
Comment on lines
255
to
256
| mode: Optional[Union[IBMBackend, Session, Batch]] = None, | ||
| backend: Optional[IBMBackend] = None, |
There was a problem hiding this comment.
We don't actually need to change V1 primitive since we are deprecating it already
jyu00
reviewed
Apr 12, 2024
test/unit/test_ibm_primitives_v2.py
Outdated
Comment on lines
160
to
166
| def test_init_with_session_backend_str(self, primitive): | ||
| """Test initializing a primitive with a backend name using session.""" | ||
| backend_name = "ibm_gotham" | ||
|
|
||
| with patch("qiskit_ibm_runtime.base_primitive.QiskitRuntimeService"): | ||
| with self.assertRaises(ValueError) as exc: | ||
| inst = primitive(session=backend_name) | ||
| self.assertIsNone(inst.session) | ||
| self.assertIn("session must be of type Session or None", str(exc.exception)) | ||
| inst = primitive(session=backend_name) | ||
| self.assertIsNone(inst.mode) |
There was a problem hiding this comment.
I don't see the point of having this test now. It was added to ensure one couldn't specify a backend name as a session (which was allowed way back). Now that it no longer raises an error but violates type hint, I'm not sure what the test is trying to cover.
Co-authored-by: Jessie Yu <[email protected]>
Co-authored-by: Jessie Yu <[email protected]>
Co-authored-by: Jessie Yu <[email protected]>
# Conflicts: # qiskit_ibm_runtime/base_primitive.py
kt474
approved these changes
Apr 17, 2024
|
This was merged after qiskit-ibm-runtime 0.23.0 was released. Since this change first appears in 0.24.0, the deprecation warnings should refer to 0.24.0, not 0.23.0 |
Sorry we missed this, we'll fix in a patch release |
garrison
added a commit
to Qiskit/qiskit-addon-cutting
that referenced
this pull request
Jun 12, 2024
This is necessary to prevent a `DeprecationWarning` under qiskit-ibm-runtime 0.24, which is currently visible in the [first](https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/tutorials/01_gate_cutting_to_reduce_circuit_width.html) and third tutorials and is due to the merging of Qiskit/qiskit-ibm-runtime#1584. qiskit-ibm-runtime 0.24 depends on qiskit>=1.1, so I had to bump the qiskit version as well. Technically, this version bump is only required by the notebooks, not the actual CKT library, but the "minimum version tests" aren't equipped to deal with situations where the notebooks have a different minimum version than the library.
garrison
added a commit
to Qiskit/qiskit-addon-cutting
that referenced
this pull request
Jun 17, 2024
This is necessary to prevent a `DeprecationWarning` under qiskit-ibm-runtime 0.24, which is currently visible in the [first](https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/tutorials/01_gate_cutting_to_reduce_circuit_width.html) and third tutorials and is due to the merging of Qiskit/qiskit-ibm-runtime#1584. qiskit-ibm-runtime 0.24 depends on qiskit>=1.1, so I had to bump the qiskit version as well. Technically, this version bump is only required by the notebooks, not the actual CKT library, but the "minimum version tests" aren't equipped to deal with situations where the notebooks have a different minimum version than the library.
garrison
added a commit
to Qiskit/qiskit-addon-cutting
that referenced
this pull request
Jun 17, 2024
This is necessary to prevent a `DeprecationWarning` under qiskit-ibm-runtime 0.24, which is currently visible in the [first](https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/tutorials/01_gate_cutting_to_reduce_circuit_width.html) and third tutorials and is due to the merging of Qiskit/qiskit-ibm-runtime#1584. This means that the notebooks now depend on qiskit-ibm-runtime 0.24, which depends on qiskit>=1.1. The "minimum version tests" aren't equipped to deal with situations where the notebooks have a different minimum version than the library. For this reason I've disabled the "minimum version tests" on the current stable branch going forward for the notebooks only. I don't want to bump the minimum version of any library on the stable branch, but I _do_ want to update our code examples to the latest version of qiskit-ibm-runtime.
garrison
added a commit
to Qiskit/qiskit-addon-cutting
that referenced
this pull request
Jul 8, 2024
…628) This is necessary to prevent a `DeprecationWarning` under qiskit-ibm-runtime 0.24, which is currently visible in the [first](https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/tutorials/01_gate_cutting_to_reduce_circuit_width.html) and third tutorials and is due to the merging of Qiskit/qiskit-ibm-runtime#1584. This means that the notebooks now depend on qiskit-ibm-runtime 0.24, which depends on qiskit>=1.1. The "minimum version tests" aren't equipped to deal with situations where the notebooks have a different minimum version than the library. For this reason I've disabled the "minimum version tests" on the current stable branch going forward for the notebooks only. I don't want to bump the minimum version of any library on the stable branch, but I _do_ want to update our code examples to the latest version of qiskit-ibm-runtime.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
modeparam to Sampler and Estimator. the new param can be:Backend,Session,Batch, orNoneSessionandBackendparamsDetails and comments
Fixes #1556