Remote Loader Update

Author: Julian Blank

MANIFEST.in

@@ -1,5 +1,4 @@
-recursive-include pymoo *.py *.cpp *.pf
-recursive-exclude pymoo *.so *.pyx *.pxd
-recursive-exclude pymoo/problems/pf/DASCMOP *.pf
-
+recursive-include pymoo *.py *.cpp
+recursive-exclude pymoo *.so *.pyx *.pxd *.pf
+recursive-exclude pymoo/cache *
 include LICENSE Makefile

README.rst

@@ -1,33 +1,30 @@
-.. |travis| image:: https://travis-ci.com/msu-coinlab/pymoo.svg?branch=master
-   :alt: build status
-   :target: https://travis-ci.com/msu-coinlab/pymoo
 
-.. |python| image:: https://img.shields.io/badge/python-3.6-blue.svg
-   :alt: python 3.6
+.. |python| image:: https://img.shields.io/badge/python-3.9-blue.svg
+   :alt: python 3.9
 
 .. |license| image:: https://img.shields.io/badge/license-apache-orange.svg
    :alt: license apache
    :target: https://www.apache.org/licenses/LICENSE-2.0
 
 
-.. |logo| image:: https://github.com/msu-coinlab/pymoo//raw/master/doc/source/_theme/custom_theme/static/img/pymoo_banner_github.png
+.. |logo| image:: https://github.com/anyoptimization/pymoo//raw/master/doc/source/_theme/custom_theme/static/img/pymoo_banner_github.png
   :target: https://pymoo.org
   :alt: pymoo
 
 
-.. |animation| image:: https://github.com/msu-coinlab/pymoo//raw/master/doc/source/_theme/custom_theme/static/img/animation.gif
+.. |animation| image:: https://github.com/anyoptimization/pymoo//raw/master/doc/source/_theme/custom_theme/static/img/animation.gif
   :target: https://pymoo.org
   :alt: pymoo
 
 
-.. _Github: https://github.com/msu-coinlab/pymoo
+.. _Github: https://github.com/anyoptimization/pymoo
 .. _Documentation: https://www.pymoo.org/
-.. _Paper: https://arxiv.org/abs/2002.04504
+.. _Paper: https://ieeexplore.ieee.org/document/9078759
 
 
 
 
-|travis| |python| |license|
+|python| |license|
 
 
 |logo|
@@ -63,7 +60,7 @@ For the current developer version:
 
 .. code:: bash
 
-    git clone https://github.com/msu-coinlab/pymoo
+    git clone https://github.com/anyoptimization/pymoo
     cd pymoo
     pip install .
 
@@ -88,7 +85,7 @@ However, for instance, executing NSGA2:
 .. code:: python
 
 
-    from pymoo.algorithms.nsga2 import NSGA2
+    from pymoo.algorithms.moo.nsga2 import NSGA2
     from pymoo.factory import get_problem
     from pymoo.optimize import minimize
     from pymoo.visualization.scatter import Scatter
@@ -101,7 +98,7 @@ However, for instance, executing NSGA2:
                    algorithm,
                    ('n_gen', 200),
                    seed=1,
-                   verbose=False)
+                   verbose=True)
 
     plot = Scatter()
     plot.add(problem.pareto_front(), plot_type="line", color="black", alpha=0.7)
@@ -116,29 +113,29 @@ A representative run of NSGA2 looks as follows:
 
 
 
-
 .. _Citation:
 
 Citation
 ********************************************************************************
 
-We are currently working on a journal publication for *pymoo*.
-Meanwhile, if you have used our framework for research purposes, please cite us with:
+If you have used our framework for research purposes, you can cite our publication by:
+
+| `J. Blank and K. Deb, pymoo: Multi-Objective Optimization in Python, in IEEE Access, vol. 8, pp. 89497-89509, 2020, doi: 10.1109/ACCESS.2020.2990567 <https://ieeexplore.ieee.org/document/9078759>`_
+|
+| BibTex:
 
 ::
 
     @ARTICLE{pymoo,
         author={J. {Blank} and K. {Deb}},
         journal={IEEE Access},
-        title={Pymoo: Multi-Objective Optimization in Python},
+        title={pymoo: Multi-Objective Optimization in Python},
         year={2020},
         volume={8},
         number={},
         pages={89497-89509},
     }
 
-
-
 .. _Contact:
 
 Contact

pymoo/config.py

@@ -0,0 +1,34 @@
+from os.path import dirname, realpath
+
+from pymoo.version import __version__
+
+
+class Config:
+    """
+    The configuration of this package in general providing the place
+    for declaring global variables.
+    """
+
+    # the root directory where the package is located at
+    root = dirname(realpath(__file__))
+
+    # whether a warning should be printed if compiled modules are not available
+    show_compile_hint = True
+
+    # whether when import a file the doc should be parsed - only activate when creating doc files
+    parse_custom_docs = False
+
+    @classmethod
+    def data(cls):
+        repo = "master"
+        if 'rc' in __version__:
+            repo = 'release'
+        elif 'dev' in __version__:
+            repo = 'develop'
+
+        return f"https://raw.githubusercontent.com/anyoptimization/pymoo/{repo}/pymoo/data/"
+
+
+# returns the directory to be used for imports
+def get_pymoo():
+    return dirname(Config.root)

pymoo/configuration.py

@@ -2,7 +2,7 @@
 
 import inspect
 import re
-from pymoo.configuration import Configuration
+from pymoo.config import Config
 
 # =========================================================================================================
 # Docstrings Dictionary
@@ -146,7 +146,7 @@
 # =========================================================================================================
 
 def parse_doc_string(source, dest=None, other={}):
-    if not Configuration.parse_custom_docs:
+    if not Config.parse_custom_docs:
         return
 
     if dest is None:

pymoo/docs.py

@@ -1,6 +1,6 @@
 import re
 
-from pymoo.configuration import Configuration
+from pymoo.config import Config
 from pymoo.problems.many import *
 from pymoo.problems.multi import *
 from pymoo.problems.single import *
@@ -516,7 +516,7 @@ def options_to_string(l):
     return ", ".join(["'%s'" % k[0] for k in l])
 
 
-if Configuration.parse_custom_docs:
+if Config.parse_custom_docs:
     from pymoo.docs import parse_doc_string
 
     from pymoo.factory import get_algorithm_options, get_selection_options, get_crossover_options, \

pymoo/factory.py

@@ -1,10 +1,6 @@
-import os
-
 import numpy as np
 
 from pymoo.core.problem import Problem
-from pymoo.problems.util import load_pareto_front_from_file
-from pymoo.util.remote import Remote
 
 
 class MODAct(Problem):
@@ -27,7 +23,7 @@ class MODAct(Problem):
     C. Picard and J. Schiffmann, “Realistic Constrained Multi-Objective Optimization Benchmark Problems from Design,”
     IEEE Transactions on Evolutionary Computation, pp. 1–1, 2020.
     """
-    def __init__(self, function, **kwargs):
+    def __init__(self, function, pf=None, **kwargs):
         try:
             import modact.problems as pb
         except:
@@ -46,6 +42,7 @@ def __init__(self, function, **kwargs):
 
         self.weights = np.array(self.fct.weights)
         self.c_weights = np.array(self.fct.c_weights)
+        self.pf = pf
 
         super().__init__(n_var=n_var, n_obj=n_obj, n_constr=n_constr, xl=xl,
                          xu=xu, elementwise_evaluation=True, type_var=np.double,
@@ -57,6 +54,8 @@ def _evaluate(self, x, out, *args, **kwargs):
         out["G"] = np.array(g)*self.c_weights
 
     def _calc_pareto_front(self, *args, **kwargs):
-        F = Remote.get_instance().load("modact", f"{self.fct.name}.pf")
-        if F is not None:
-            return F*self.weights*-1
+        # download the pf files from https://zenodo.org/record/3824302#.YUCfJS2z2JA
+        # then pass the path to it to the constructor of the problem
+        # they are not included because of their size >700 MB
+        return np.loadtxt(self.pf)
+

pymoo/problems/multi/modact.py

@@ -1,6 +1,6 @@
 import importlib
 
-from pymoo.configuration import Configuration
+from pymoo.config import Config
 
 
 def get_functions():
@@ -54,13 +54,13 @@ def __init__(self) -> None:
         super().__init__()
         self.is_compiled = is_compiled()
 
-        if Configuration.show_compile_hint and not self.is_compiled:
+        if Config.show_compile_hint and not self.is_compiled:
             print("\nCompiled modules for significant speedup can not be used!")
             print("https://pymoo.org/installation.html#installation")
             print()
             print("To disable this warning:")
-            print("from pymoo.configuration import Configuration")
-            print("Configuration.show_compile_hint = False\n")
+            print("from pymoo.config import Config")
+            print("Config.show_compile_hint = False\n")
 
     def load(self, func_name=None, _type="auto"):
 

pymoo/util/function_loader.py

@@ -1,14 +1,14 @@
 import os
 import urllib.request
 from os.path import join, dirname, abspath
-from urllib.parse import urljoin
 
 import numpy as np
 
-from pymoo.configuration import Configuration
+from pymoo.config import Config
 
 
 class Remote:
+
     # -------------------------------------------------
     # Singleton Pattern
     # -------------------------------------------------
@@ -17,7 +17,7 @@ class Remote:
     @staticmethod
     def get_instance():
         if Remote.__instance is None:
-            server = Configuration.server
+            server = Config.data()
             folder = join(dirname(dirname(abspath(__file__))), 'cache')
             Remote.__instance = Remote(server, folder)
         return Remote.__instance

pymoo/util/remote.py

@@ -4,7 +4,7 @@
 import pytest
 
 from pymoo.algorithms.moo.nsga2 import calc_crowding_distance
-from pymoo.configuration import get_pymoo
+from pymoo.config import get_pymoo
 
 
 @pytest.mark.skip(reason="check if this is supposed to work or not at all")