-
Notifications
You must be signed in to change notification settings - Fork 90
/
template.yml
130 lines (106 loc) · 6.12 KB
/
template.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
#######################################################
## This is a code entry in the error correction zoo. ##
## https://github.com/errorcorrectionzoo ##
#######################################################
# Use UTF-8 unicode encoding
# AMS-TeX commands are rendered inside \( ... \) using MathJaX.
# Allowed external bibliographic references are
# \cite{arxiv:#.#} or \cite{arxiv:quant-ph/#} (PREFERRED),
# \cite{doi:#}, or, as a last resort
# \cite{manual:{(enter citation line incl. author and year here)}}
# External websites such as code tables, coding theory packages, github pages linked as
# \url{https://example.com/example}
# \href{https://example.com/example}{link text}
# Internal references to codes are
# \hyperref[code:code_id]{link text}
# Delete instructional comments when submitting
# code id, physical, logical are all lower case
code_id: no_spaces_lower_case
physical: qubits
logical: qubits
# Apostrophes are denoted by two apostrophe characters, i.e., ''
# Code title (SINGULAR) + first reference(s) (optional).
name: 'Important-last-name favorite code'
introduced: '\cite{doi:10.1070/RM1997v052n06ABEH002155}'
# Anything applicable to a larger parent set of codes (see below) should go in
# that entry instead of here.
description: |
First paragraph is a short standalone description, containing no references to figures.
Subsequent paragraphs go into (possibly quantitative) details.
\subsection{Subsection headings work}
Important feature here
\paragraph{And so do paragraphs}
More discussion
# Long keys such as this one can be written in other YML formats, such as the one using the pipe symbol
# protection: |
# text...
# more text...
protection: 'Protects against ... Pauli noise. Approximate code with parameters ... for noise model ... .'
# This key starts a list of specific labeled subkeys; do not leave it
# empty. If empty, comment out. Also, indentations are important!
features:
# The fields below relate to specific properties of the code that are worth
# noting. In some cases (see below), there might be multiple pieces of
# information associated with a key (e.g., mutliple encoders/decoders,
# multiple facts about fault tolerance, etc.); in such cases, the key
# accepts a list of text entries, with one item per piece of information.
#
# Any keys below should be omitted if they do not apply.
rate: 'k/n, usually listed for a family of codes, but can be notable for a single one. Discussed alongside other parameters such as check operator weight, distance, etc.'
# This key that starts a list of strings, indexed by a dash and a space; do not leave it
# empty. If empty, comment out.
encoders:
- 'Specific description of a process that makes the states, usually for quantum codes.'
- 'Unitary circuit of depth ... \cite{arxiv:old-paper}.'
- 'Measurement-based preparation ... with ancilla overhead of ... .'
- 'Leave discussion of fault tolerance to fault-tolerance key.'
transversal_gates:
- 'Transversal ... gates \cite{doi:ok-paper}. Comment out if doesn''t apply.'
general_gates:
- 'Universal gate set achieved by either additional ... gate.'
- 'Magic-state distillation protocols'
- 'kth \term{Clifford hierarchy} gates obtained by ... circuits'
decoders:
- 'Details about how syndrome measurements are done; discuss overhead, if applicable.'
- 'MWPM decoding algorithm \cite{doi:good-paper} with ... overhead.'
- 'Just-in-time decoder with ... \cite{arxiv:awesome-paper}.'
fault_tolerance:
- 'Transversal gates are fault-tolerant w.r.t. ... noise \cite{doi:ok-paper}'
- 'Other fault-tolerant gadgets (measurements, encoders, error correcting steps)'
- 'Noise-model-preserving gadgets, noise-biased gates, fault-tolerant flag error correction'
- 'Pieceable fault tolerance.'
code_capacity_threshold:
- '\(1.5%\) error-correction threshold against some noise with *noiseless* decoder of some complexity \cite{arxiv:paper}.'
- '\(5.2\%\) asymptotic upper bound from some estimation algortihm (Monte Carlo, e.g.) that may or may not have a feasible decoder.'
threshold:
- '\(0.3\%\) error-correction threshold ... with *noisy* ... decoder of some complexity \cite{doi:good-paper}.'
- '\(10^{-5}\) computational threshold using concatenated scheme under ... noise with overhead of ... '
- '\(4.5\%\) asymptotic lower bound on fault-tolerant threshold with ... noise, ... overhead, and ... complexity.'
- '\(6.7\%\) threshold using magic-state distillation protocols assuming ... Clifford gates.'
# Propose a key that you feel is applicable to a large and interesting class of codes
#some_other_key:
# - 'detail'
realizations:
# List and explain the different "domains" of realizations in list items.
# Group closely related realizations into a single item. It's OK to have a
# single list item. Each item should more or less correspond to what would be
# said in a paragraph.
- 'Code used in DVDs \cite{doi:####...}, 5G, etc.'
- 'Realized in trapped-ion quantum devices \cite{arxiv:####.#####}, etc.'
notes:
- 'Bounds on \(n\), \(k\), or \(d\) for this class, unless mentioned in desciption.'
- 'Links to code tables, github, GAP algebra packages, more papers \cite{arxiv:####.#####}.'
- 'Connections to physics; based on \(H^4(\mathcal{BG},\mathbb{Z})\)'
- 'Can reference other codes, but try to put such connections in the relations keys below.'
- 'Anything noteworthy that''s not above or below.'
relations:
parents:
- code_id: code_id1
detail: 'The smallest code family that includes this code that is defined over the same physical space structure or alphabet.'
cousins:
- code_id: code_id2
detail: 'Codes described by a property shared by this code other than physical space (e.g., topological, Hamiltonian-based). Can move to parent if the property was integral in the initial construction/motivation of the code.'
- code_id: code_id3
detail: 'Code family of similar encoding but with different physical space structures (qudit vs. qubit surface code).'
- code_id: code_id4
detail: 'Codes (classical or quantum) related in other ways to this code.'