optiprofiler 1.0.dev2__tar.gz → 1.1.0__tar.gz

{optiprofiler-1.0.dev2/python/optiprofiler.egg-info → optiprofiler-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optiprofiler
-Version: 1.0.dev2
+Version: 1.1.0
 Summary: Benchmarking optimization solvers
 Author-email: Cunxin Huang <cun-xin.huang@connect.polyu.hk>, "Tom M. Ragonneau" <tom.ragonneau@polyu.edu.hk>, Zaikun Zhang <zaikun.zhang@polyu.edu.hk>
 Maintainer-email: Cunxin Huang <cun-xin.huang@connect.polyu.hk>, "Tom M. Ragonneau" <tom.ragonneau@polyu.edu.hk>, Zaikun Zhang <zaikun.zhang@polyu.edu.hk>
@@ -72,6 +72,7 @@ Requires-Dist: sphinx-book-theme==1.1.2; extra == "doc"
 Requires-Dist: sphinx-design==0.5.0; extra == "doc"
 Requires-Dist: sphinxcontrib-bibtex==2.6.2; extra == "doc"
 Requires-Dist: sphinxcontrib-matlabdomain; extra == "doc"
+Requires-Dist: sphinxext-opengraph; extra == "doc"
 Provides-Extra: extra
 Requires-Dist: pycutest>=1.6.1; extra == "extra"
 Provides-Extra: tests
@@ -84,24 +85,48 @@ OptiProfiler: a platform for benchmarking optimization solvers
 
 |docs_badge| |codecov_badge|
 
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml
+|py_unit| |py_multi_os| |py_random| |py_stress|
+
+|ml_unit| |ml_multi_os| |ml_random| |ml_stress|
 
 .. |docs_badge| image:: https://img.shields.io/readthedocs/optiprofiler/latest?logo=readthedocs&style=for-the-badge
     :target: http://www.optprof.com
 .. |codecov_badge| image:: https://img.shields.io/codecov/c/github/optiprofiler/optiprofiler?style=for-the-badge&logo=codecov
    :target: https://app.codecov.io/github/optiprofiler/optiprofiler/tree/main
+.. |py_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml
+.. |py_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml
+.. |py_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml
+.. |py_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml
+.. |ml_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml
+.. |ml_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml
+.. |ml_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml
+.. |ml_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml
 
-MATLAB version is available.
-----------------------------
+🌐 **Website:** `www.optprof.com <https://www.optprof.com>`_
 
-To install the MATLAB version, please do the following:
+Python
+------
+
+Install OptiProfiler via pip:
+
+.. code-block:: bash
+
+    pip install optiprofiler
+
+.. note::
+
+    OptiProfiler includes the `S2MPJ <https://github.com/GrattonToint/S2MPJ>`_ problem library by default. If you also want to use the `PyCUTEst <https://jfowkes.github.io/pycutest/>`_ problem library (available on Linux and macOS only), please follow the `PyCUTEst installation guide <https://jfowkes.github.io/pycutest/_build/html/install.html>`_.
+
+MATLAB
+------
 
 1. Clone the repository using the following command:
 
@@ -114,6 +139,3 @@ To install the MATLAB version, please do the following:
 .. code-block:: matlab
 
     setup
-
-Python version is under development.
-------------------------------------

optiprofiler-1.1.0/README.rst

@@ -0,0 +1,59 @@
+OptiProfiler: a platform for benchmarking optimization solvers
+==============================================================
+
+|docs_badge| |codecov_badge|
+
+|py_unit| |py_multi_os| |py_random| |py_stress|
+
+|ml_unit| |ml_multi_os| |ml_random| |ml_stress|
+
+.. |docs_badge| image:: https://img.shields.io/readthedocs/optiprofiler/latest?logo=readthedocs&style=for-the-badge
+    :target: http://www.optprof.com
+.. |codecov_badge| image:: https://img.shields.io/codecov/c/github/optiprofiler/optiprofiler?style=for-the-badge&logo=codecov
+   :target: https://app.codecov.io/github/optiprofiler/optiprofiler/tree/main
+.. |py_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml
+.. |py_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml
+.. |py_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml
+.. |py_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml
+.. |ml_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml
+.. |ml_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml
+.. |ml_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml
+.. |ml_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml
+
+🌐 **Website:** `www.optprof.com <https://www.optprof.com>`_
+
+Python
+------
+
+Install OptiProfiler via pip:
+
+.. code-block:: bash
+
+    pip install optiprofiler
+
+.. note::
+
+    OptiProfiler includes the `S2MPJ <https://github.com/GrattonToint/S2MPJ>`_ problem library by default. If you also want to use the `PyCUTEst <https://jfowkes.github.io/pycutest/>`_ problem library (available on Linux and macOS only), please follow the `PyCUTEst installation guide <https://jfowkes.github.io/pycutest/_build/html/install.html>`_.
+
+MATLAB
+------
+
+1. Clone the repository using the following command:
+
+.. code-block:: bash
+
+    git clone https://github.com/optiprofiler/optiprofiler.git
+
+2. In MATLAB, navigate to the folder where the source code is located, and you will see a file named ``setup.m``. Run the following command in the MATLAB command window:
+
+.. code-block:: matlab
+
+    setup

{optiprofiler-1.0.dev2 → optiprofiler-1.1.0}/pyproject.toml

@@ -57,6 +57,7 @@ doc = [
     "sphinx-design==0.5.0",
     "sphinxcontrib-bibtex==2.6.2",
     "sphinxcontrib-matlabdomain",
+    "sphinxext-opengraph",
 ]
 extra = ["pycutest>=1.6.1"]
 tests = [
@@ -114,3 +115,10 @@ markers = [
     "extra: mark test as requiring extra dependencies (pycutest)",
 ]
 norecursedirs = ["action_tests"]
+
+[tool.coverage.run]
+omit = [
+    "*/problem_libs/*",
+    "*/tests/*",
+    "*/action_tests/*",
+]

{optiprofiler-1.0.dev2 → optiprofiler-1.1.0}/python/optiprofiler/__init__.py

@@ -12,12 +12,13 @@
 #
 # Dev branch marker is: 'X.Y.dev' or 'X.Y.devN' where N is an integer.
 # 'X.Y.dev0' is the canonical version of 'X.Y.dev'.
-__version__ = '1.0.dev2'
+__version__ = '1.1.0'
 
 # Public API of the optiprofiler package
 from .opclasses import Feature, Problem, FeaturedProblem
 from .profiles import benchmark
 from .utils import show_versions
+from .plib_config import get_plib_config, set_plib_config
 
 __all__ = [
     'Problem',
@@ -25,4 +26,6 @@ __all__ = [
     'FeaturedProblem',
     'benchmark',
     'show_versions',
+    'get_plib_config',
+    'set_plib_config',
 ]

{optiprofiler-1.0.dev2 → optiprofiler-1.1.0}/python/optiprofiler/action_tests/random_test.py

@@ -7,6 +7,8 @@ This test is run by GitHub Actions workflows, not by pytest.
 import sys
 import os
 import platform
+import matplotlib
+matplotlib.use('Agg')
 import numpy as np
 from datetime import datetime
 

{optiprofiler-1.0.dev2 → optiprofiler-1.1.0}/python/optiprofiler/action_tests/stress_test.py

@@ -7,6 +7,8 @@ This test is run by GitHub Actions workflows, not by pytest.
 import sys
 import os
 import platform
+import matplotlib
+matplotlib.use('Agg')
 import numpy as np
 from datetime import datetime
 

{optiprofiler-1.0.dev2 → optiprofiler-1.1.0}/python/optiprofiler/action_tests/test_all_features.py

@@ -8,6 +8,8 @@ import sys
 import os
 import platform
 import time
+import matplotlib
+matplotlib.use('Agg')
 
 # Add parent directory to path for imports
 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))))

{optiprofiler-1.0.dev2 → optiprofiler-1.1.0}/python/optiprofiler/loader.py

@@ -57,6 +57,12 @@ def truncate_solvers(results_plib: Dict[str, Any], solvers_to_load: List[int]) -
     results_plib['solvers_successes'] = results_plib['solvers_successes'][:, solvers_to_load, :]
     results_plib['merit_histories'] = results_plib['merit_histories'][:, solvers_to_load, :, :]
     results_plib['merit_outs'] = results_plib['merit_outs'][:, solvers_to_load, :]
+    # Optional per-(problem, solver, run) diagnostic flags introduced
+    # together with the §6 report sections; absent in legacy .h5 files.
+    if 'solver_abnormal_terminations' in results_plib:
+        results_plib['solver_abnormal_terminations'] = results_plib['solver_abnormal_terminations'][:, solvers_to_load, :]
+    if 'solver_output_fallbacks' in results_plib:
+        results_plib['solver_output_fallbacks'] = results_plib['solver_output_fallbacks'][:, solvers_to_load, :]
     
     return results_plib
 
@@ -172,7 +178,11 @@ def truncate_problems(results_plib: Dict[str, Any], problem_options: Dict[str, A
     # Apply the mask to truncate the data
     p_to_load = np.where(p_to_load)[0]  # Convert boolean mask to indices
     
-    # Truncate problem-related fields
+    # Truncate problem-related fields. ``fun_inits`` / ``maxcv_inits`` /
+    # ``merit_inits`` are now always per-(problem, run), but we keep the
+    # 1-D branch for backward compatibility with .h5 files saved by
+    # earlier versions where these fields were stored as 1-D arrays of
+    # shape ``(n_problems,)``.
     results_plib['fun_histories'] = results_plib['fun_histories'][p_to_load, :, :, :]
     results_plib['maxcv_histories'] = results_plib['maxcv_histories'][p_to_load, :, :, :]
     results_plib['fun_outs'] = results_plib['fun_outs'][p_to_load, :, :]
@@ -201,13 +211,28 @@ def truncate_problems(results_plib: Dict[str, Any], problem_options: Dict[str, A
         results_plib['merit_inits'] = results_plib['merit_inits'][p_to_load]
     else:
         results_plib['merit_inits'] = results_plib['merit_inits'][p_to_load, :]
+    if 'solver_abnormal_terminations' in results_plib:
+        results_plib['solver_abnormal_terminations'] = results_plib['solver_abnormal_terminations'][p_to_load, :, :]
+    if 'solver_output_fallbacks' in results_plib:
+        results_plib['solver_output_fallbacks'] = results_plib['solver_output_fallbacks'][p_to_load, :, :]
     
     return results_plib
 
 
 def merit_fun_compute(merit_fun: Callable, fun_values: np.ndarray, maxcv_values: np.ndarray, maxcv_inits: np.ndarray) -> np.ndarray:
-    """Compute merit values from function values and constraint violations."""
-    return merit_fun(fun_values, maxcv_values, maxcv_inits)
+    """Compute merit values from function values and constraint violations.
+
+    Delegates to ``profile_utils.compute_merit_values`` so that the
+    shape-broadcasting logic stays in a single place. The previous
+    implementation called ``merit_fun`` directly with whole arrays,
+    which silently produced wrong results when ``maxcv_inits`` did not
+    already match the shape of ``fun_values`` (e.g. when ``maxcv_inits``
+    is per-(problem, run) but ``fun_values`` is per-(problem, solver,
+    run, eval)).
+    """
+    # Local import to avoid a circular import at module load time.
+    from .profile_utils import compute_merit_values
+    return compute_merit_values(merit_fun, fun_values, maxcv_values, maxcv_inits)
 
 
 def recompute_merits(results_plib: Dict[str, Any], merit_fun: Callable) -> Dict[str, Any]: