Align dependencies (qiskit, sphinx) (#21)

* chore(deps): bump qiskit and pandoc * remove qridge * chore(docs): align docs
mspronesti · Apr 18, 2023 · 9604b85 · 9604b85
1 parent 134d65b
commit 9604b85
Show file tree

Hide file tree

Showing 15 changed files with 41 additions and 417 deletions.
diff --git a/docs/apidoc/qlearnkit.algorithms.qridge.rst b/docs/apidoc/qlearnkit.algorithms.qridge.rst
diff --git a/docs/apidoc/qlearnkit.algorithms.rst b/docs/apidoc/qlearnkit.algorithms.rst
@@ -9,7 +9,6 @@ Subpackages
 
    qlearnkit.algorithms.qkmeans
    qlearnkit.algorithms.qknn
-   qlearnkit.algorithms.qridge
    qlearnkit.algorithms.qsvm
 
 Submodules

diff --git a/docs/apidoc/qlearnkit.nn.rst b/docs/apidoc/qlearnkit.nn.rst
@@ -4,6 +4,22 @@ qlearnkit.nn package
 Submodules
 ----------
 
+qlearnkit.nn.qae module
+-----------------------
+
+.. automodule:: qlearnkit.nn.qae
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qlearnkit.nn.qml\_mixin module
+------------------------------
+
+.. automodule:: qlearnkit.nn.qml_mixin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 qlearnkit.nn.qrnn module
 ------------------------
 
@@ -12,6 +28,14 @@ qlearnkit.nn.qrnn module
    :undoc-members:
    :show-inheritance:
 
+qlearnkit.nn.quanv module
+-------------------------
+
+.. automodule:: qlearnkit.nn.quanv
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git a/qlearnkit/algorithms/__init__.py b/qlearnkit/algorithms/__init__.py
@@ -3,7 +3,6 @@
 from .qknn import QKNeighborsClassifier, QKNeighborsRegressor
 from .qsvm import QSVClassifier
 from .qkmeans import QKMeans
-from .qridge import QRidgeRegressor
 
 __all__ = [
     "QuantumEstimator",
@@ -12,5 +11,4 @@
     "QKNeighborsRegressor",
     "QSVClassifier",
     "QKMeans",
-    "QRidgeRegressor"
 ]
diff --git a/qlearnkit/algorithms/qknn/qknn_classifier.py b/qlearnkit/algorithms/qknn/qknn_classifier.py
@@ -119,9 +119,9 @@ def _majority_voting(self,
         n_queries = self.X_train.shape[0]
         if n_queries == 1:
             # case of 1D array
-            labels, _ = stats.mode(k_nearest)
+            labels, _ = stats.mode(k_nearest, keepdims=True)
         else:
-            labels, _ = stats.mode(k_nearest, axis=1)
+            labels, _ = stats.mode(k_nearest, keepdims=True, axis=1)
 
         # eventually flatten the np.ndarray
         # returned by stats.mode

diff --git a/qlearnkit/algorithms/qridge/__init__.py b/qlearnkit/algorithms/qridge/__init__.py
diff --git a/qlearnkit/algorithms/qridge/qridge.py b/qlearnkit/algorithms/qridge/qridge.py
diff --git a/qlearnkit/nn/quanv.py b/qlearnkit/nn/quanv.py
@@ -36,7 +36,7 @@ class Quanv2DLayer(Module, QmlMixin):
     **References:**
 
     [1] Henderson et al.,
-        `Quantum Long Short-Term Memory <https://arxiv.org/pdf/1904.04767.pdf>`_
+        `Quanvolutional Neural Networks: Powering Image Recognition with Quantum Circuits <https://arxiv.org/pdf/1904.04767.pdf>`_
 
     Args:
         n_qubits:

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,9 +1,5 @@
-qiskit-aer>=0.10.3
-qiskit-terra>=0.20.0
-qiskit-machine-learning>=0.3.1
-scikit-learn==1.0.2
-scipy==1.7.3
-numpy==1.22.0
+-r requirements.txt
+qiskit-aer
 pytest==6.2.5
 pytest-cov==3.0.0
 pytest-xdist==2.5.0
@@ -16,11 +12,12 @@ sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
 sphinx-autodoc-typehints==1.14.0
-sphinx-gallery
+sphinx-gallery==0.10.1
 pandoc>=1.1.0
 sphinx-rtd-theme
 nbsphinx
 nbsphinx-link
+nbformat==5.4.0
 matplotlib>=3.3
 flake8==4.0.1
 jupyter
@@ -29,4 +26,4 @@ pre-commit
 # However, for the developement of the nn package,
 # they are needed, here's why they are included here.
 pennylane
-torch
+torch
diff --git a/requirements.txt b/requirements.txt
@@ -1,7 +1,6 @@
-qiskit-terra>=0.20.0
-qiskit-aer>=0.10.3
-qiskit-machine-learning>=0.3.1
-scikit-learn==1.0.2
-scipy==1.7.3
-numpy==1.22.0
+qiskit-terra==0.22.0
+qiskit-machine-learning==0.4.0
+scikit-learn>=1.0.2
+scipy>=1.10
+numpy<1.24
 
diff --git a/test/qknn/test_knn_classifier.py b/test/qknn/test_knn_classifier.py
@@ -4,7 +4,7 @@
 from qlearnkit.algorithms import QKNeighborsClassifier
 from qlearnkit.encodings import AmplitudeEncoding
 
-from qiskit import Aer
+from qiskit_aer import Aer
 from qiskit.utils import QuantumInstance, algorithm_globals
 
 seed = 42

diff --git a/test/qknn/test_knn_regressor.py b/test/qknn/test_knn_regressor.py
@@ -4,7 +4,7 @@
 from qlearnkit.algorithms import QKNeighborsRegressor
 from qlearnkit.encodings import AmplitudeEncoding
 
-from qiskit import Aer
+from qiskit_aer import Aer
 from qiskit.utils import QuantumInstance, algorithm_globals
 
 seed = 42

diff --git a/test/test_kmeans.py b/test/test_kmeans.py
@@ -5,7 +5,7 @@
 from qlearnkit.algorithms import QKMeans
 import pytest
 
-from qiskit import Aer
+from qiskit_aer import Aer
 from qiskit.utils import QuantumInstance, algorithm_globals
 
 seed = 42