Make it easier to access dumps and matrices from Python #2042
Conversation
This file contains hidden or 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
This adds some convenience accessors for getting dumps, messages, and matrices as separate entries from an invocation of `qsharp.run` and `qsharp.eval`. Previously, the only way to get a state dump from a run was the awkward:
```python
state = qsharp.StateDump(qsharp.run("DumpMachine()", shots=1, save_events=True)[0]["events"][0].state_dump())
```
This change preserves the existings "events" entry in the saved output, which has everything intermingled in the order from each shot, but also introduces dumps, messages, and matrices that will keep just the ordered output of that type. This makes the above pattern slightly better (and more discoverable):
```python
state = qsharp.run("DumpMachine()", shots=1, save_events=True)[0]["dumps"][0]
```
This adds similar functionality to `qsharp.eval` which now supports `save_events=True` to capture output, so for single shot execution you can use:
```python
state = qsharp.eval("DumpMachine()", save_events=True)["dumps"][0]
```
orpuente-MS
approved these changes
Dec 11, 2024
minestarks
reviewed
Dec 11, 2024
minestarks
reviewed
Dec 11, 2024
minestarks
approved these changes
Dec 12, 2024
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.
This adds some convenience accessors for getting dumps, messages, and matrices as separate entries from an invocation of
qsharp.runandqsharp.eval. Previously, the only way to get a state dump from a run was the awkward:This change preserves the existings "events" entry in the saved output, which has everything intermingled in the order from each shot, but also introduces dumps, messages, and matrices that will keep just the ordered output of that type. This makes the above pattern slightly better (and more discoverable):
This adds similar functionality to
qsharp.evalwhich now supportssave_events=Trueto capture output, so for single shot execution you can use: