Skip to content

Commit 171080c

Browse files
committed
PR feedback: add example
1 parent fbc51b6 commit 171080c

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

src/bloqade/submission/ir/task_results.py

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,29 @@ def simulate_task_results(self, shots: int = 1) -> "QuEraTaskResults":
8989
"""Simulate the task results as probabilties.
9090
9191
Args:
92-
shots (int): Number of shots, Defaults to 1
92+
shots (int): Number of shots, Defaults to 1.
93+
94+
Returns:
95+
task_result (QuEraTaskResults): Result of task simulation
96+
For example:
97+
```python
98+
{
99+
"task_status": "Completed",
100+
"shot_outputs": [
101+
{
102+
"shot_status": "Completed",
103+
"pre_sequence": [1],
104+
"post_sequence": [1]
105+
},
106+
....
107+
{
108+
"shot_status": "Completed",
109+
"pre_sequence": [1],
110+
"post_sequence": [1]
111+
}
112+
],
113+
}
114+
```
93115
"""
94116
bit_strings, probabilities = zip(*self.probabilities)
95117

0 commit comments

Comments
 (0)