add example of function usage

unitaryfund · Aug 13, 2024 · f8725eb · f8725eb
1 parent 7570704
commit f8725eb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/mitiq/rem/inverse_confusion_matrix.py b/mitiq/rem/inverse_confusion_matrix.py
@@ -25,6 +25,10 @@ def sample_probability_vector(
 
     Returns:
         A list of sampled bitstrings.
+
+    Example:
+        >>> sample_probability_vector([0, 1/2, 1/4, 1/4], 4)
+        ['01', '10', '11', '11']
     """
     num_values = len(probability_vector)
     if not np.log2(num_values).is_integer():