release v2.5.0rc0 [optimtool.hybrid in beta]

Author: linjing-lab

README.md

@@ -56,6 +56,9 @@ pip install optimtool --upgrade
         |-- WanYuan.py
     |-- hybrid
         |-- __init__.py
+        |-- approt.py
+        |-- fista.py
+        |-- nesterov.py
     |-- unconstrain
         |-- __init__.py
         |-- gradient_descent.py
@@ -67,6 +70,7 @@ pip install optimtool --upgrade
     |-- _convert.py
     |-- _drive.py
     |-- _kernel.py
+    |-- _proxim.py
     |-- _search.py
     |-- _typing.py
     |-- _utils.py

README_en.md

@@ -67,6 +67,7 @@ pip install optimtool --upgrade
     |-- _convert.py
     |-- _drive.py
     |-- _kernel.py
+    |-- _proxim.py
     |-- _search.py
     |-- _typing.py
     |-- _utils.py

optimtool/__init__.py

@@ -32,4 +32,4 @@
 from ._version import __version__
 
 if sys.version_info < (3, 7, 0):
-    raise OSError(f'optimtool-2.4.4 requires Python >=3.7, but yours is {sys.version}')
+    raise OSError(f'optimtool-2.5.0rc0 requires Python >=3.7, but yours is {sys.version}')

optimtool/_proxim.py

@@ -0,0 +1,27 @@
+# Copyright (c) 2021 linjing-lab
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from .base import np
+
+l1 = lambda delta, tk: np.sign(delta) * np.max(np.abs(delta) - tk, 0)
+
+l2 = lambda delta, norm, tk: (1 - tk / norm) * delta if norm > tk else 0
+
+ln = lambda delta, tk: (delta + np.sqrt(delta**2 + 4 * tk)) / 2 # association appears in 2.5.0

optimtool/_version.py

@@ -18,4 +18,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-__version__ = '2.4.4'
+__version__ = '2.5.0rc0'

optimtool/hybrid/__init__.py

@@ -18,5 +18,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from . import approximate_point_gradient 
-# appear in v2.5.0
+from . import approt
+from . import fista
+from . import nesterov
+
+
+__hybrid__ = {
+    'Approximate Points': approt.__all__,
+    'FISTA': fista.__all__,
+    'Nesterov': nesterov.__all__
+} # access in v2.5.0

optimtool/hybrid/approt.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2021 linjing-lab
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+__all__ = [] # access in v2.5.0

optimtool/hybrid/fista.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2021 linjing-lab
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+__all__ = [] # access in v2.5.0

optimtool/hybrid/nesterov.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2021 linjing-lab
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+__all__ = [] # access in v2.5.0

setup.py

@@ -4,7 +4,7 @@
 from setuptools import setup
 
 if sys.version_info < (3, 7, 0):
-    raise OSError(f'optimtool-2.4.4 requires Python >=3.7, but yours is {sys.version}')
+    raise OSError(f'optimtool-2.5.0rc0 requires Python >=3.7, but yours is {sys.version}')
 
 if (3, 7, 0) <= sys.version_info < (3, 8, 0):
     # https://github.com/pypa/setuptools/issues/926#issuecomment-294369342
@@ -34,7 +34,7 @@
         _long_description = fp.read()
 except FileNotFoundError:
     _long_description = ''
- 
+
 setup(
       name='optimtool',  # pkg_name
       packages=[
@@ -77,10 +77,10 @@
             'Topic :: Software Development :: Libraries',
             'Topic :: Software Development :: Libraries :: Python Modules',
       ],
-      install_requires = [
+      install_requires=[
             'numpy>=1.21.0', 
             'sympy>=1.9',
             'matplotlib>=3.2.0'
       ],
-      # extras_require = []
+      # extras_require=[]
 )

tests/hybrid/_hybrid.ipynb

@@ -7,10 +7,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# load important dependencies \n",
-    "import numpy as np\n",
-    "import sympy as sp\n",
-    "import matplotlib.pyplot as plt"
+    "import optimtool as oo\n",
+    "from optimtool.base import np, sp, plt"
    ]
   },
   {
@@ -30,22 +28,6 @@
    "source": [
     "import optimtool.hybrid as oh"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2b7ce89f-6339-4567-9513-7435d1a0fb68",
-   "metadata": {},
-   "source": [
-    "## 近似点梯度下降法（approximate_point_gradient）"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "19979307",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {