Skip to content

Fix "See Also" docstrings #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MoritzWillmann merged 1 commit into from
Jan 7, 2026
Merged

Fix "See Also" docstrings #373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
968 changes: 927 additions & 41 deletions examples/kernel/example_projected_kernel.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions src/squlearn/kernel/loss/ode_loss.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,7 @@ class ODELoss(KernelLossBase):
eta=1.2,
)

See Also
--------
See Also:
squlearn.kernel.QKODE : Quantum Kernel for ODE solving.

References
Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/kernel/qgpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ class QGPC(GaussianProcessClassifier, SerializableModelMixin):
(``num_qubits=``), or (if supported) the number of layers (``num_layers=``)
of the underlying encoding circuit.

See Also
--------
See Also:
squlearn.kernel.QSVC : Quantum Support Vector classification.

References
Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/kernel/qgpr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ class QGPR(BaseEstimator, RegressorMixin, SerializableModelMixin):
(``num_qubits=``), or (if supported) the number of layers (``num_layers=``)
of the underlying encoding circuit.

See Also
--------
See Also:
squlearn.kernel.QKRR : Quantum Gaussian Process regression.
squlearn.kernel.QSVR : Quantum Support Vector regression.

Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/kernel/qkode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ class QKODE(QKRR):
k_testtrain (np.ndarray) :
Kernel matrix of shape (n_test, n_train) which is evaluated at the predict step.

See Also
--------
See Also:
squlearn.kernel.loss.ODELoss : Loss function for ODEs.

References
Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/kernel/qkrr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,7 @@ class QKRR(BaseEstimator, RegressorMixin, SerializableModelMixin):
k_testtrain (np.ndarray) :
Kernel matrix of shape (n_test, n_train) which is evaluated at the predict step

See Also
--------
See Also:
squlearn.kernel.QGPR : Quantum Gaussian Process regression.
squlearn.kernel.QSVR : Quantum Support Vector regression.

Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/kernel/qsvc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ class QSVC(SVC, SerializableModelMixin):
adjusted via kwargs such as the number of qubits (``num_qubits``), or (if supported)
the number of layers (``num_layers``).

See Also
--------
See Also:
squlearn.kernel.QSVR : Quantum Support Vector Regression

**Example**
Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/kernel/qsvr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ class QSVR(SVR, SerializableModelMixin):
underlying encoding circuit can be adjusted via kwargs such as the number of qubits
(``num_qubits``), or (if supported) the number of layers (``num_layers``).

See Also
--------
See Also:
squlearn.kernel.QSVC : Quantum Support Vector Classification

**Example**
Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/qnn/qnnc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,7 @@ class QNNClassifier(BaseQNN, ClassifierMixin):
specified, the estimator will used. Possible values are ``"estimator"`` or
``"sampler"``.

See Also
--------
See Also:
squlearn.qnn.QNNRegressor : Quantum Neural Network for Regression.

**Example**
Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/qnn/qnnr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,7 @@ class QNNRegressor(BaseQNN, RegressorMixin):
specified, the estimator will used. Possible values are ``"estimator"`` or
``"sampler"``.

See Also
--------
See Also:
squlearn.qnn.QNNClassifier : Quantum Neural Network for Classification.

**Example**
Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/qrc/qrc_classifier.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ class QRCClassifier(BaseQRC, ClassifierMixin):
parameters are given.
caching (bool): Whether to cache the results of the evaluated expectation values.

See Also
--------
See Also:
squlearn.qrc.QRCRegressor: Quantum Reservoir Computing for Regression.
squlearn.qrc.base_qrc.BaseQRC: Base class for Quantum Reservoir Computing.

Expand Down
3 changes: 1 addition & 2 deletions src/squlearn/qrc/qrc_regressor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ class QRCRegressor(BaseQRC, RegressorMixin):
parameters are given.
caching (bool): Whether to cache the results of the evaluated expectation values.

See Also
--------
See Also:
squlearn.qrc.QRCClassifier: Quantum Reservoir Computing for Classification.
squlearn.qrc.base_qrc.BaseQRC: Base class for Quantum Reservoir Computing.

Expand Down
Loading