Skip to content

Commit a5df837

Browse files
authored
Update algorithms docs for Aqua (qiskit-community/qiskit-aqua#900)
* Update algorithm docs for new categories * Add custom words
1 parent 28fe110 commit a5df837

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# copyright notice, and modified files need to carry a notice indicating
1313
# that they have been altered from the originals.
1414

15-
"""Quantum SVM algorithm."""
15+
"""The Quantum SVM algorithm."""
1616

1717
from typing import Dict, Optional, Union
1818
import logging
@@ -42,7 +42,7 @@
4242

4343
class QSVM(QuantumAlgorithm):
4444
"""
45-
Quantum SVM algorithm.
45+
The Quantum SVM algorithm.
4646
4747
A key concept in classification methods is that of a kernel. Data cannot typically be
4848
separated by a hyperplane in its original space. A common technique used to find such a

qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# that they have been altered from the originals.
1414

1515
"""
16-
The Sklearn SVM algorithm.
16+
The Sklearn SVM algorithm (classical).
1717
"""
1818

1919
from typing import Dict, Optional
@@ -36,12 +36,12 @@
3636

3737
class SklearnSVM(ClassicalAlgorithm):
3838
"""
39-
The Sklearn SVM algorithm.
39+
The Sklearn SVM algorithm (classical).
4040
41-
SVM Classical uses a classical approach to experiment with feature map classification
42-
problems. See also the quantum classifier :class:`QSVM`.
41+
This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map
42+
classification problems. See also the quantum classifier :class:`QSVM`.
4343
44-
Internally, SVM Classical will run the binary classification or multiclass classification
44+
Internally, this algorithm will run the binary classification or multiclass classification
4545
based on how many classes the data has. If the data has more than 2 classes then a
4646
*multiclass_extension* is required to be supplied. Aqua provides several
4747
:mod:`~qiskit.aqua.components.multiclass_extensions`.

0 commit comments

Comments
 (0)