Steppable Optimizer (#8170)

* All Changes so far * Revert "All Changes so far" This reverts commit 871f29e. * All changes again * tests * Formated documentation Gradient Descent * Reviewed Documentation * Dealing with CALLBACK * Fixing documentation * Documentation * Apply suggestions from code review Co-authored-by: Daniel J. Egger <38065505+eggerdj@users.noreply.github.com> * GD docs * Fixed format of documentation * Typo * Imported files CMAES * Testing * Forgot to add nit to result * Started stopping conditions * Fixed comments * Changes * merge and black * Fixed documentation * IDK why docs is missing optimize * make black * Updated Documentation * Updated Documentation * Remove CMAES and merge * Removed CMAES * Learning Rate Class * Lint * RENO and unittests * Removed attribute documentation * Fixed variable name * Added Learning Rate * Fixed unittestt * Fixes * Apply suggestions from code review Co-authored-by: Julien Gacon <gaconju@gmail.com> * Fixing utils? * lint * Fixed Reno? * Update releasenotes/notes/steppable-optimizers-9d9b48ba78bd58bb.yaml Co-authored-by: Julien Gacon <gaconju@gmail.com> * Apply suggestions from code review Co-authored-by: Julien Gacon <gaconju@gmail.com> * Fixed documentation typo * Removed properties * Apply suggestions from code review Co-authored-by: Daniel J. Egger <38065505+eggerdj@users.noreply.github.com> * Fixed comments * Learning Rate init * LearningRate init * Update qiskit/algorithms/optimizers/utils/learning_rate.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * changes * changes * I can't fix the documentation * Accidentaly merged with an other branch * remains Co-authored-by: Daniel J. Egger <38065505+eggerdj@users.noreply.github.com> Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Qiskit · Aug 29, 2022 · 231961d · 231961d
1 parent f2bf191
commit 231961d
Show file tree

Hide file tree

Showing 10 changed files with 967 additions and 109 deletions.
diff --git a/qiskit/algorithms/__init__.py b/qiskit/algorithms/__init__.py
@@ -264,6 +264,7 @@
 from .evolvers.trotterization import TrotterQRTE
 from .evolvers.variational.var_qite import VarQITE
 from .evolvers.variational.var_qrte import VarQRTE
+
 from .evolvers.pvqd import PVQD, PVQDResult
 
 __all__ = [

diff --git a/qiskit/algorithms/optimizers/__init__.py b/qiskit/algorithms/optimizers/__init__.py
@@ -1,6 +1,6 @@
 # This code is part of Qiskit.
 #
-# (C) Copyright IBM 2018, 2020.
+# (C) Copyright IBM 2018, 2022.
 #
 # This code is licensed under the Apache License, Version 2.0. You may
 # obtain a copy of this license in the LICENSE.txt file in the root directory
@@ -39,6 +39,25 @@
    Optimizer
    Minimizer
 
+Steppable Optimizer Base Class
+==============================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   optimizer_utils
+
+.. autosummary::
+   :toctree: ../stubs/
+   :nosignatures:
+
+   SteppableOptimizer
+   AskData
+   TellData
+   OptimizerState
+
+
+
 Local Optimizers
 ================
 
@@ -53,6 +72,7 @@
    L_BFGS_B
    GSLS
    GradientDescent
+   GradientDescentState
    NELDER_MEAD
    NFT
    P_BFGS
@@ -110,7 +130,7 @@
 from .cg import CG
 from .cobyla import COBYLA
 from .gsls import GSLS
-from .gradient_descent import GradientDescent
+from .gradient_descent import GradientDescent, GradientDescentState
 from .imfil import IMFIL
 from .l_bfgs_b import L_BFGS_B
 from .nelder_mead import NELDER_MEAD
@@ -120,6 +140,7 @@
 from .nlopts.direct_l_rand import DIRECT_L_RAND
 from .nlopts.esch import ESCH
 from .nlopts.isres import ISRES
+from .steppable_optimizer import SteppableOptimizer, AskData, TellData, OptimizerState
 from .optimizer import Minimizer, Optimizer, OptimizerResult, OptimizerSupportLevel
 from .p_bfgs import P_BFGS
 from .powell import POWELL
@@ -134,6 +155,10 @@
 __all__ = [
     "Optimizer",
     "OptimizerSupportLevel",
+    "SteppableOptimizer",
+    "AskData",
+    "TellData",
+    "OptimizerState",
     "OptimizerResult",
     "Minimizer",
     "ADAM",
@@ -142,6 +167,7 @@
     "COBYLA",
     "GSLS",
     "GradientDescent",
+    "GradientDescentState",
     "L_BFGS_B",
     "NELDER_MEAD",
     "NFT",