Skip to content

Commit c6899ad

Browse files
fix See Also section in docstrings (#373)
1 parent 58bb9b1 commit c6899ad

12 files changed

Lines changed: 938 additions & 63 deletions

File tree

examples/kernel/example_projected_kernel.ipynb

Lines changed: 927 additions & 41 deletions
Large diffs are not rendered by default.

src/squlearn/kernel/loss/ode_loss.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ class ODELoss(KernelLossBase):
7777
eta=1.2,
7878
)
7979
80-
See Also
81-
--------
80+
See Also:
8281
squlearn.kernel.QKODE : Quantum Kernel for ODE solving.
8382
8483
References

src/squlearn/kernel/qgpc.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ class QGPC(GaussianProcessClassifier, SerializableModelMixin):
3333
(``num_qubits=``), or (if supported) the number of layers (``num_layers=``)
3434
of the underlying encoding circuit.
3535
36-
See Also
37-
--------
36+
See Also:
3837
squlearn.kernel.QSVC : Quantum Support Vector classification.
3938
4039
References

src/squlearn/kernel/qgpr.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ class QGPR(BaseEstimator, RegressorMixin, SerializableModelMixin):
6060
(``num_qubits=``), or (if supported) the number of layers (``num_layers=``)
6161
of the underlying encoding circuit.
6262
63-
See Also
64-
--------
63+
See Also:
6564
squlearn.kernel.QKRR : Quantum Gaussian Process regression.
6665
squlearn.kernel.QSVR : Quantum Support Vector regression.
6766

src/squlearn/kernel/qkode.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ class QKODE(QKRR):
5656
k_testtrain (np.ndarray) :
5757
Kernel matrix of shape (n_test, n_train) which is evaluated at the predict step.
5858
59-
See Also
60-
--------
59+
See Also:
6160
squlearn.kernel.loss.ODELoss : Loss function for ODEs.
6261
6362
References

src/squlearn/kernel/qkrr.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,7 @@ class QKRR(BaseEstimator, RegressorMixin, SerializableModelMixin):
5858
k_testtrain (np.ndarray) :
5959
Kernel matrix of shape (n_test, n_train) which is evaluated at the predict step
6060
61-
See Also
62-
--------
61+
See Also:
6362
squlearn.kernel.QGPR : Quantum Gaussian Process regression.
6463
squlearn.kernel.QSVR : Quantum Support Vector regression.
6564

src/squlearn/kernel/qsvc.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ class QSVC(SVC, SerializableModelMixin):
3838
adjusted via kwargs such as the number of qubits (``num_qubits``), or (if supported)
3939
the number of layers (``num_layers``).
4040
41-
See Also
42-
--------
41+
See Also:
4342
squlearn.kernel.QSVR : Quantum Support Vector Regression
4443
4544
**Example**

src/squlearn/kernel/qsvr.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ class QSVR(SVR, SerializableModelMixin):
3939
underlying encoding circuit can be adjusted via kwargs such as the number of qubits
4040
(``num_qubits``), or (if supported) the number of layers (``num_layers``).
4141
42-
See Also
43-
--------
42+
See Also:
4443
squlearn.kernel.QSVC : Quantum Support Vector Classification
4544
4645
**Example**

src/squlearn/qnn/qnnc.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ class QNNClassifier(BaseQNN, ClassifierMixin):
7777
specified, the estimator will used. Possible values are ``"estimator"`` or
7878
``"sampler"``.
7979
80-
See Also
81-
--------
80+
See Also:
8281
squlearn.qnn.QNNRegressor : Quantum Neural Network for Regression.
8382
8483
**Example**

src/squlearn/qnn/qnnr.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ class QNNRegressor(BaseQNN, RegressorMixin):
7777
specified, the estimator will used. Possible values are ``"estimator"`` or
7878
``"sampler"``.
7979
80-
See Also
81-
--------
80+
See Also:
8281
squlearn.qnn.QNNClassifier : Quantum Neural Network for Classification.
8382
8483
**Example**

0 commit comments

Comments
 (0)