qLDPCOrg / qLDPCOrg/qLDPC

standardizing decoder performance results

Open
#311 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
255
Forks
38
Avg merge
11h 19m
Merged PRs (30d)
9

Description

One of the attractions of using qLDPC to measure code performance is that it integrates other commonly used decoders (MWPM, BP-OSD, ...). This will be even more attractive if circuit noise is added to work uniformly with different decoders. This is more useable than working with individual packages (pymatching, ldpc,...) and figure out the details for each.

It would be nice if code.get_logical_error_rate_func returns results that are consistent across different decoders (when possible).

  • "logical error rate" would be split into block logical rate (if any of logicals is wrong) and average (number of logicals that are wrong)

  • even though LER is the important metric, it helps if "word error rate" and "bit error rate" are also reported; this is using terminology
    from them classical side. The majority of codes in the literature are CSS codes and are decoded as classical codes.

Anyway, something to keep in mind if these are minor tweaks to the code.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at code.get_logical_error_rate_func and review how the integrated MWPM and BP-OSD decoders currently report results. Clarify consistent definitions for block and average logical error rates, plus word and bit error rates, and determine how circuit noise should fit; done means the supported decoders expose comparable metrics.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.