Skip to content

Commit 7ca14b3

Browse files
gonfecogonfeco
committed
Fix documentation
1 parent 9627a20 commit 7ca14b3

25 files changed

Lines changed: 1463 additions & 248 deletions

‎QQuantLib/AE/ae_class.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ class AE:
3737
ae_type : string
3838
string with the desired AE algorithm:
3939
MLAE, CQPEAE, IQPEAE, IQAE, RQAE
40-
kwars : dictionary
40+
kwargs : dictionary
4141
dictionary that allows the configuration of the AE algorithm. \\
4242
The different configration keys of the different AE algorithms \\
4343
can be provided.
44-
"""
44+
"""
4545
def __init__(self, oracle=None, target=None, index=None, ae_type=None, **kwargs):
4646
"""
4747

‎QQuantLib/AE/ae_classical_qpe.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ class CQPEAE:
4848
dictionary that allows the configuration of the CQPEAE algorithm: \\
4949
Implemented keys:
5050
51-
qpu : QLM solver
52-
solver for simulating the resulting circuits
53-
shots : int
54-
number of measurements
55-
mcz_qlm : bool
56-
for using or not QLM implementation of the multi controlled Z
57-
gate
51+
qpu : kwargs, QLM solver
52+
solver for simulating the resulting circuits
53+
shots : kwargs, int
54+
number of measurements
55+
mcz_qlm : kwargs, bool
56+
for using or not QLM implementation of the multi controlled Z
57+
gate
5858
"""
5959

6060
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/ae_iterative_quantum_pe.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ class IQPEAE:
4444
dictionary that allows the configuration of the IQPEAE algorithm: \\
4545
Implemented keys:
4646
47-
qpu : QLM solver
48-
solver for simulating the resulting circutis
49-
shots : int
50-
number of measurements
51-
mcz_qlm : bool
52-
for using or not QLM implementation of the multi controlled Z
53-
gate
47+
qpu : kwargs, QLM solver
48+
solver for simulating the resulting circutis
49+
shots : kwargs, int
50+
number of measurements
51+
mcz_qlm : kwargs, bool
52+
for using or not QLM implementation of the multi controlled Z
53+
gate
5454
"""
5555

5656
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/extended_real_quantum_ae.py‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -314,19 +314,18 @@ class eRQAE:
314314
qubits which mark the register to do the amplitude
315315
estimation
316316
317-
kwars : dictionary
318-
dictionary that allows the configuration of the IQAE algorithm: \\
319-
Implemented keys:
320-
321-
qpu : QLM solver
322-
solver for simulating the resulting circuits
323-
epsilon : int
324-
precision
325-
gamma : float
326-
accuracy
327-
mcz_qlm : bool
328-
for using or not QLM implementation of the multi controlled Z
329-
gate
317+
kwargs : dictionary
318+
dictionary that allows the configuration of the IQAE algorithm
319+
320+
qpu : kwargs, QLM solver
321+
solver for simulating the resulting circuits
322+
epsilon : kwargs, int
323+
precision
324+
gamma : kwargs, float
325+
accuracy
326+
mcz_qlm : kwargs, bool
327+
for using or not QLM implementation of the multi controlled Z
328+
gate
330329
"""
331330

332331
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/iterative_quantum_ae.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,21 @@ class IQAE:
4141
qubits which mark the register to do the amplitude
4242
estimation
4343
44-
kwars : dictionary
44+
kwargs : dictionary
4545
dictionary that allows the configuration of the IQAE algorithm: \\
4646
Implemented keys:
4747
48-
qpu : QLM solver
49-
solver for simulating the resulting circuits
50-
epsilon : float
51-
precision
52-
alpha : float
53-
accuracy
54-
shots : int
55-
number of measurements on each iteration
56-
mcz_qlm : bool
57-
for using or not QLM implementation of the multi controlled Z
58-
gate
48+
qpu : kwargs, QLM solver
49+
solver for simulating the resulting circuits
50+
epsilon : kwargs, float
51+
precision
52+
alpha : kwargs, float
53+
accuracy
54+
shots : kwargs, int
55+
number of measurements on each iteration
56+
mcz_qlm : kwargs, bool
57+
for using or not QLM implementation of the multi controlled Z
58+
gate
5959
"""
6060

6161
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/maximum_likelihood_ae.py‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,22 @@ class MLAE:
4141
index : list of ints
4242
qubits which mark the register to do the amplitude
4343
estimation
44-
kwars : dictionary
45-
dictionary that allows the configuration of the MLAE algorithm: \\
46-
Implemented keys:
47-
48-
qpu : QLM solver
49-
solver for simulating the resulting circuits
50-
schedule : list of two lists
51-
the schedule for the algorithm
52-
optimizer :
53-
an optimizer with just one possible entry
54-
delta : float
55-
tolerance to avoid division by zero warnings
56-
ns : int
57-
number of grid points for brute scipy optimizer
58-
mcz_qlm : bool
59-
for using or not QLM implementation of the multi controlled Z
60-
gate
44+
kwargs : dictionary
45+
dictionary that allows the configuration of the MLAE algorithm
46+
47+
qpu : kwargs, QLM solver
48+
solver for simulating the resulting circuits
49+
schedule : kwargs, list of two lists
50+
the schedule for the algorithm
51+
optimizer : kwargs,
52+
an optimizer with just one possible entry
53+
delta : kwargs, float
54+
tolerance to avoid division by zero warnings
55+
ns : kwargs, int
56+
number of grid points for brute scipy optimizer
57+
mcz_qlm : kwargs, bool
58+
for using or not QLM implementation of the multi controlled Z
59+
gate
6160
"""
6261

6362
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/modified_iterative_quantum_ae.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,21 @@ class mIQAE:
4040
qubits which mark the register to do the amplitude
4141
estimation
4242
43-
kwars : dictionary
43+
kwargs : dictionary
4444
dictionary that allows the configuration of the IQAE algorithm: \\
4545
Implemented keys:
4646
47-
qpu : QLM solver
48-
solver for simulating the resulting circuits
49-
epsilon : float
50-
precision
51-
alpha : float
52-
accuracy
53-
shots : int
54-
number of measurements on each iteration
55-
mcz_qlm : bool
56-
for using or not QLM implementation of the multi controlled Z
57-
gate
47+
qpu : kwargs, QLM solver
48+
solver for simulating the resulting circuits
49+
epsilon : kwargs, float
50+
precision
51+
alpha : kwargs, float
52+
accuracy
53+
shots : kwargs, int
54+
number of measurements on each iteration
55+
mcz_qlm : kwargs, bool
56+
for using or not QLM implementation of the multi controlled Z
57+
gate
5858
"""
5959

6060
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/modified_real_quantum_ae.py‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,20 @@ class mRQAE:
4343
qubits which mark the register to do the amplitude
4444
estimation
4545
46-
kwars : dictionary
47-
dictionary that allows the configuration of the IQAE algorithm: \\
48-
Implemented keys:
49-
50-
qpu : QLM solver
51-
solver for simulating the resulting circuits
52-
q : int
53-
amplification ratio
54-
epsilon : int
55-
precision
56-
gamma : float
57-
accuracy
58-
mcz_qlm : bool
59-
for using or not QLM implementation of the multi controlled Z
60-
gate
46+
kwargs : dictionary
47+
dictionary that allows the configuration of the IQAE algorithm
48+
49+
qpu : kwargs, QLM solver
50+
solver for simulating the resulting circuits
51+
q : kwargs, int
52+
amplification ratio
53+
epsilon : kwargs, int
54+
precision
55+
gamma : kwargs, float
56+
accuracy
57+
mcz_qlm : kwargs, bool
58+
for using or not QLM implementation of the multi controlled Z
59+
gate
6160
"""
6261

6362
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/montecarlo_ae.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ class MCAE:
3434
qubits which mark the register to do the amplitude
3535
estimation
3636
37-
kwars : dictionary
37+
kwargs : dictionary
3838
dictionary that allows the configuration of the IQAE algorithm: \\
3939
Implemented keys:
4040
41-
qpu : QLM solver
42-
solver for simulating the resulting circuits
43-
shots : int
44-
number of measurements
45-
mcz_qlm : bool
46-
for using or not QLM implementation of the multi controlled Z
47-
gate
41+
qpu : kwargs, QLM solver
42+
solver for simulating the resulting circuits
43+
shots : kwargs, int
44+
number of measurements
45+
mcz_qlm : kwargs, bool
46+
for using or not QLM implementation of the multi controlled Z
47+
gate
4848
"""
4949

5050
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

‎QQuantLib/AE/real_quantum_ae.py‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,20 @@ class RQAE:
3939
qubits which mark the register to do the amplitude
4040
estimation
4141
42-
kwars : dictionary
43-
dictionary that allows the configuration of the IQAE algorithm: \\
44-
Implemented keys:
45-
46-
qpu : QLM solver
47-
solver for simulating the resulting circuits
48-
q : int
49-
amplification ratio
50-
epsilon : int
51-
precision
52-
gamma : float
53-
accuracy
54-
mcz_qlm : bool
55-
for using or not QLM implementation of the multi controlled Z
56-
gate
42+
kwargs : dictionary
43+
dictionary that allows the configuration of the IQAE algorithm
44+
45+
qpu : kwargs, QLM solver
46+
solver for simulating the resulting circuits
47+
q : kwargs, int
48+
amplification ratio
49+
epsilon : kwargs, int
50+
precision
51+
gamma : kwargs, float
52+
accuracy
53+
mcz_qlm : kwargs, bool
54+
for using or not QLM implementation of the multi controlled Z
55+
gate
5756
"""
5857

5958
def __init__(self, oracle: qlm.QRoutine, target: list, index: list, **kwargs):

0 commit comments

Comments
 (0)