Added BP-OTS decoder implementation in LDPCDecodersExt file #489

adhirajj · 2025-04-08T02:00:57Z

If you want to submit an unfinished piece of work in order to get comments and discuss, please mark the pull request as a draft and ping the repository maintainer.

Please address only one topic or issue per pull request! Many small PRs are much easier to review and merge than one large PR.

Before merging, all changes and new functionality should be marked in the CHANGELOG file, but feel free to just leave your CHANGELOG notes in the PR description, to avoid merge conflicts with other requests modifying that file. The maintainer will add these CHANGELOG notes for you if you do so.

Before considering your pull request ready for review and merging make sure that all of the following are completed (please keep the clecklist as part of your PR):

The code is properly formatted and commented.
Substantial new functionality is documented within the docs.
All new functionality is tested.
All of the automated tests on github pass.
We recently started enforcing formatting checks. If formatting issues are reported in the new code you have written, please correct them. There will be plenty of old code that is flagged as we are slowly transitioning to enforced formatting. Please do not worry about or address older formatting issues -- keep your PR just focused on your planned contribution.

If possible, keep your git history not too wild (rebase and squash commits, keep commits small and semantically separated) so that review is easier.

Krastanov

as discussed in meeting:

Project.toml should have a new compat bount
bumping version in Project.toml
CHANGELOG
tests

Krastanov · 2025-04-08T13:49:54Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

 end

+#parity_checks method
+function parity_checks(d::BPOTSWrapperDecoder)


removed repetition in the latest commit

Krastanov · 2025-04-08T13:50:08Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

    errorrate = isnothing(errorrate) ? 0.0 : errorrate
    maxiter = isnothing(maxiter) ? n : maxiter
-    bfx = LDPCDecoders.BitFlipDecoder(Hx, errorrate, maxiter)
+    bfx = LDPCDecoders.BitFlipDecoder(Hx, errorrate, maxiter)   # uses 2 classical bit flip decoders


do not modify unrelated code

removed the change that was made by me

Krastanov · 2025-04-08T13:50:26Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

+# Make sure to also implement the parity_checks method
+function parity_checks(d::BPOTSWrapperDecoder)
+    return d.H
+end


removed this repetition

Krastanov · 2025-04-08T13:51:52Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

+# In QuantumCliffordLDPCDecodersExt.jl
+# Here's the fixed BPOTSWrapperDecoder implementation for your extension module


remove comments left over from asking the coding assistant for stuff

removed extra comments

Krastanov · 2025-04-08T13:53:46Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl


+# In QuantumCliffordLDPCDecodersExt.jl
+# Here's the fixed BPOTSWrapperDecoder implementation for your extension module
+struct BPOTSWrapperDecoder <: AbstractSyndromeDecoder


BPOTSDecoder just for consistency

changed name to BPOTSDecoder

Krastanov · 2025-04-08T13:58:51Z

you can add tests here

QuantumClifford.jl/test/test_ecc_decoder_all_setups.jl

Lines 67 to 83 in 5341f9d

    
           @testset "BitFlipDecoder decoder, good for sparse codes" begin 
        
               codes = [ 
        
                        QuantumReedMuller(3), 
        
                        QuantumReedMuller(4) 
        
                       ] 
        
               noise = 0.001 
        
               setups = [ 
        
                         CommutationCheckECCSetup(noise), 
        
                         NaiveSyndromeECCSetup(noise, 0), 
        
                         ShorSyndromeECCSetup(noise, 0), 
        
                        ] 
        
               for c in codes 
        
                   for s in setups 
        
                       for d in [c->BitFlipDecoder(c, maxiter=10)]

Krastanov

Looks good! There seems to be a small typo.

Could you also add a test, e.g. by including your decoder in this list https://github.com/QuantumSavory/QuantumClifford.jl/blob/master/test/test_ecc_decoder_all_setups.jl#L83

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

Krastanov · 2025-04-29T16:43:33Z

@adhirajj just a bump, let me know if you would not have a chance to look into finishing this PR

Krastanov · 2025-05-24T01:37:22Z

@adhirajj , could you check what is necessary to finish this PR? It seems the tests are still failing

Krastanov · 2025-09-25T19:20:15Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

+end
+
+function decode(d::BPOTSDecoder, syndrome_sample::AbstractVector{Bool})
+    # Validate input size


remove comments that are just a obvious statement, comments should provide insight about the code, not state things that are already obvious

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

Krastanov · 2025-09-25T19:23:02Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

+    if c isa Toric || c isa Surface
+        k = c isa Toric ? 2 : 1
+    else
+        k = n - s
+    end


This seems like a fragile piece of code, why are these special cased? Probably should use code_k code_n code_c functions.

Krastanov · 2025-09-25T19:23:48Z

CHANGELOG.md

+### Added
+- BP-OTS (Belief Propagation with Oscillating Trapping Sets) decoder for quantum LDPC codes in the LDPCDecoders extension


check how this looks like on master and format it similarly

…Decoder

…amespace

Krastanov · 2025-10-16T20:05:07Z

Project.toml

 HostCPUFeatures = "3e5b6fbb-0976-4d2c-9146-d79de83f2fb0"
 ILog2 = "2cd5bd5f-40a1-5050-9e10-fc8cdb6109f5"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+LDPCDecoders = "3c486d74-64b9-4c60-8b1a-13a564e77efb"


this needs to be moved back to a weak dependency

Krastanov · 2025-10-16T20:05:38Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

+Chytas et al., "Enhanced Message-Passing Decoding of Degenerate Quantum Codes 
+Utilizing Trapping Set Dynamics", IEEE Communications Letters, 2024
+"""
+


this empty line makes the docstring not attach to the struct

Krastanov · 2025-10-16T20:06:45Z

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl

-    bfx = LDPCDecoders.BitFlipDecoder(Hx, errorrate, maxiter)
    bfz = LDPCDecoders.BitFlipDecoder(Hz, errorrate, maxiter)
+    bfx = LDPCDecoders.BitFlipDecoder(Hx, errorrate, maxiter)


undo the permutation

Add BP-OTS decoder implementation in LDPCDecodersext file

723553b

Krastanov requested changes Apr 8, 2025

View reviewed changes

Project.toml and LDPCDecodersExt file updated

dc22784

Krastanov requested changes Apr 17, 2025

View reviewed changes

ext/QuantumCliffordLDPCDecodersExt/QuantumCliffordLDPCDecodersExt.jl Show resolved Hide resolved

Krastanov closed this Apr 29, 2025

Krastanov reopened this Apr 29, 2025

Fe-r-oz added enhancement New feature or request ECC Having to do with the ECC submodule labels May 1, 2025

Krastanov marked this pull request as draft May 24, 2025 01:37

Krastanov force-pushed the master branch from 8fa7920 to 63f8b8d Compare July 2, 2025 19:26

adhirajj added 2 commits September 15, 2025 11:35

fixes

22ce711

Fixes

0edd129

Krastanov requested changes Sep 25, 2025

View reviewed changes

adhirajj added 5 commits October 13, 2025 23:13

Fix BitFlipDecoder typo (missing bfx) and add parity_checks for BPOTS…

6921b45

…Decoder

Update CHANGELOG and add BPOTSDecoder tests

b6b3be4

Add BPOTSDecoder export and stub to make it accessible from package n…

65303da

…amespace

Add docstring to BPOTSDecoder struct in extension

faa92f4

Resolve merge conflicts with master

8627fc4

adhirajj marked this pull request as ready for review October 14, 2025 16:49

Resolve merge conflicts with upstream master

98f0c61

adhirajj requested a review from Krastanov October 14, 2025 18:15

Merge branch 'master' into bpots-branch

9f1baac

Krastanov reviewed Oct 16, 2025

View reviewed changes

adhirajj added 2 commits October 16, 2025 16:25

Fix docstring attachment and move LDPCDecoders to weakdeps

7c0fda2

Fixed docstring

0f3bea1

Merge remote changes

f1ffec7

		# In QuantumCliffordLDPCDecodersExt.jl
		# Here's the fixed BPOTSWrapperDecoder implementation for your extension module

		### Added
		- BP-OTS (Belief Propagation with Oscillating Trapping Sets) decoder for quantum LDPC codes in the LDPCDecoders extension

Added BP-OTS decoder implementation in LDPCDecodersExt file #489

Are you sure you want to change the base?

Added BP-OTS decoder implementation in LDPCDecodersExt file #489

Uh oh!

Conversation

adhirajj commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Krastanov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Krastanov commented Apr 8, 2025

Uh oh!

Krastanov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Krastanov commented Apr 29, 2025

Uh oh!

Krastanov commented May 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

adhirajj commented Apr 8, 2025 •

edited

Loading