Add sinter.TaskStats.with_edits

quantumlib · Jul 30, 2024 · 9cb172e · 9cb172e
1 parent da00d11
commit 9cb172e
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/doc/sinter_api.md b/doc/sinter_api.md
@@ -31,6 +31,7 @@ API references for stable versions are kept on the [stim github wiki](https://gi
 - [`sinter.TaskStats`](#sinter.TaskStats)
     - [`sinter.TaskStats.to_anon_stats`](#sinter.TaskStats.to_anon_stats)
     - [`sinter.TaskStats.to_csv_line`](#sinter.TaskStats.to_csv_line)
+    - [`sinter.TaskStats.with_edits`](#sinter.TaskStats.with_edits)
 - [`sinter.better_sorted_str_terms`](#sinter.better_sorted_str_terms)
 - [`sinter.collect`](#sinter.collect)
 - [`sinter.comma_separated_key_values`](#sinter.comma_separated_key_values)
@@ -829,6 +830,25 @@ def to_csv_line(
     """
 ```
 
+<a name="sinter.TaskStats.with_edits"></a>
+```python
+# sinter.TaskStats.with_edits
+
+# (in class sinter.TaskStats)
+def with_edits(
+    self,
+    *,
+    strong_id: Optional[str] = None,
+    decoder: Optional[str] = None,
+    json_metadata: Optional[Any] = None,
+    shots: Optional[int] = None,
+    errors: Optional[int] = None,
+    discards: Optional[int] = None,
+    seconds: Optional[float] = None,
+    custom_counts: Optional[Counter[str]] = None,
+) -> sinter.TaskStats:
+```
+
 <a name="sinter.better_sorted_str_terms"></a>
 ```python
 # sinter.better_sorted_str_terms