Skip to content

Commit dc95588

Browse files
committed
doc fix
1 parent fa59e63 commit dc95588

File tree

4 files changed

+7
-4
lines changed

4 files changed

+7
-4
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
MACOSX_DEPLOYMENT_TARGET: "10.15"
5454
CIBW_BUILD: "${{ matrix.os_dist.dist }}"
5555
CIBW_ARCHS_MACOS: "${{ matrix.os_dist.macosarch }}"
56-
CIBW_TEST_REQUIRES: pytest stim sinter pygltflib
56+
CIBW_TEST_REQUIRES: pytest stim~=1.14.dev sinter pygltflib
5757
CIBW_TEST_COMMAND: pytest {project}/src
5858
steps:
5959
- uses: actions/checkout@v3

doc/chromobius.pyi

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,8 @@ class CompiledDecoder:
240240
>>> # Decode with Chromobius.
241241
>>> dem = repetition_color_code.detector_error_model()
242242
>>> decoder = chromobius.compile_decoder_for_dem(dem)
243-
>>> pred, weights = decoder.predict_obs_flips_from_dets_bit_packed(dets)
243+
>>> result = decoder.predict_weighted_obs_flips_from_dets_bit_packed(dets)
244+
>>> pred, weights = result
244245
"""
245246
def compile_decoder_for_dem(
246247
dem: stim.DetectorErrorModel,

doc/chromobius_api_reference.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,7 @@ def predict_weighted_obs_flips_from_dets_bit_packed(
351351
>>> # Decode with Chromobius.
352352
>>> dem = repetition_color_code.detector_error_model()
353353
>>> decoder = chromobius.compile_decoder_for_dem(dem)
354-
>>> pred, weights = decoder.predict_obs_flips_from_dets_bit_packed(dets)
354+
>>> result = decoder.predict_weighted_obs_flips_from_dets_bit_packed(dets)
355+
>>> pred, weights = result
355356
"""
356357
```

src/chromobius/pybind/chromobius.pybind.cc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,8 @@ PYBIND11_MODULE(chromobius, m) {
315315
>>> # Decode with Chromobius.
316316
>>> dem = repetition_color_code.detector_error_model()
317317
>>> decoder = chromobius.compile_decoder_for_dem(dem)
318-
>>> pred, weights = decoder.predict_obs_flips_from_dets_bit_packed(dets)
318+
>>> result = decoder.predict_weighted_obs_flips_from_dets_bit_packed(dets)
319+
>>> pred, weights = result
319320
)DOC")
320321
.data());
321322

0 commit comments

Comments
 (0)