pyfemtet 0.4.24__py3-none-any.whl → 0.5.0__py3-none-any.whl

pyfemtet/message/locales/messages.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2024-08-20 10:15+0900\n"
+"POT-Creation-Date: 2024-08-31 04:27+0900\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -197,251 +197,303 @@ msgstr ""
 msgid "Optimization has been interrupted. Note that you cannot acquire the OptimizationResult in case of `trust-constr`, `TNC`, `SLSQP` or `COBYLA`."
 msgstr ""
 
-#: pyfemtet/message/messages.py:95
-msgid "Connect to Femtet"
+#: pyfemtet/message/messages.py:92
+msgid "You can use parameter constraint only with BoTorchSampler."
 msgstr ""
 
 #: pyfemtet/message/messages.py:96
-msgid "Analysis model name described in csv does not exist in project."
+msgid "Connect to Femtet"
 msgstr ""
 
 #: pyfemtet/message/messages.py:97
-msgid "History csv is not read yet. Open your project manually."
+msgid "Analysis model name described in csv does not exist in project."
 msgstr ""
 
 #: pyfemtet/message/messages.py:98
-msgid "Cannot read project data from csv. Open your project manually."
+msgid "History csv is not read yet. Open your project manually."
 msgstr ""
 
 #: pyfemtet/message/messages.py:99
-msgid ".femprj file described in csv is not found. Open your project manually."
+msgid "Cannot read project data from csv. Open your project manually."
 msgstr ""
 
 #: pyfemtet/message/messages.py:100
+msgid ".femprj file described in csv is not found. Open your project manually."
+msgstr ""
+
+#: pyfemtet/message/messages.py:101
 msgid "Analysis model name is not specified. Open your model in the project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:102
+#: pyfemtet/message/messages.py:103
 msgid "Constraint"
 msgstr ""
 
-#: pyfemtet/message/messages.py:103
+#: pyfemtet/message/messages.py:104
 msgid "feasible"
 msgstr ""
 
-#: pyfemtet/message/messages.py:104
+#: pyfemtet/message/messages.py:105
 msgid "infeasible"
 msgstr ""
 
-#: pyfemtet/message/messages.py:105
+#: pyfemtet/message/messages.py:106
 msgid "Optimality"
 msgstr ""
 
-#: pyfemtet/message/messages.py:106
+#: pyfemtet/message/messages.py:107
 msgid "non dominated"
 msgstr ""
 
-#: pyfemtet/message/messages.py:107
+#: pyfemtet/message/messages.py:108
 msgid "dominated"
 msgstr ""
 
-#: pyfemtet/message/messages.py:108
+#: pyfemtet/message/messages.py:109
 msgid "Hypervolume Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:109
+#: pyfemtet/message/messages.py:110
 msgid "Objective Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:110
+#: pyfemtet/message/messages.py:111
 msgid "Multi Objective Pair Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:111
+#: pyfemtet/message/messages.py:112
 msgid "trial number"
 msgstr ""
 
-#: pyfemtet/message/messages.py:113
+#: pyfemtet/message/messages.py:114
 msgid "Objectives"
 msgstr ""
 
 #: pyfemtet/message/messages.py:115
+msgid "Objectives (all)"
+msgstr ""
+
+#: pyfemtet/message/messages.py:117
 msgid "Prediction Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:116
+#: pyfemtet/message/messages.py:118
 msgid " Recalculate Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:117
+#: pyfemtet/message/messages.py:119
 msgid " Redraw graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:118
+#: pyfemtet/message/messages.py:120
 msgid "Parameter"
 msgstr ""
 
-#: pyfemtet/message/messages.py:119
+#: pyfemtet/message/messages.py:121
 msgid "Parameter2"
 msgstr ""
 
-#: pyfemtet/message/messages.py:120
+#: pyfemtet/message/messages.py:122
 msgid "Objective"
 msgstr ""
 
-#: pyfemtet/message/messages.py:121
+#: pyfemtet/message/messages.py:123
 msgid "No history selected."
 msgstr ""
 
-#: pyfemtet/message/messages.py:122
+#: pyfemtet/message/messages.py:124
 msgid "No FEM result (yet)."
 msgstr ""
 
-#: pyfemtet/message/messages.py:123
+#: pyfemtet/message/messages.py:125
 msgid "Prediction model is not calculated yet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:124
+#: pyfemtet/message/messages.py:126
 msgid "Cannot select same parameter"
 msgstr ""
 
-#: pyfemtet/message/messages.py:126
+#: pyfemtet/message/messages.py:127
+msgid "3D graph (two or more parameters required)"
+msgstr ""
+
+#: pyfemtet/message/messages.py:129
 msgid "Prediction Model of Objective"
 msgstr ""
 
-#: pyfemtet/message/messages.py:127
+#: pyfemtet/message/messages.py:130
 msgid "prediction model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:128
+#: pyfemtet/message/messages.py:131
 msgid "std. dev. of model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:130
+#: pyfemtet/message/messages.py:133
 msgid "Progress"
 msgstr ""
 
-#: pyfemtet/message/messages.py:131
+#: pyfemtet/message/messages.py:134
 msgid "Prediction"
 msgstr ""
 
-#: pyfemtet/message/messages.py:132
+#: pyfemtet/message/messages.py:135
 msgid "Workers"
 msgstr ""
 
-#: pyfemtet/message/messages.py:134
+#: pyfemtet/message/messages.py:136
+msgid "Details"
+msgstr ""
+
+#: pyfemtet/message/messages.py:138
 msgid "Optimization status will be shown here."
 msgstr ""
 
-#: pyfemtet/message/messages.py:135
+#: pyfemtet/message/messages.py:139
 msgid "Auto-update graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:136
+#: pyfemtet/message/messages.py:140
 msgid "Interrupt Optimization"
 msgstr ""
 
-#: pyfemtet/message/messages.py:138
+#: pyfemtet/message/messages.py:142
 msgid "Result"
 msgstr ""
 
-#: pyfemtet/message/messages.py:140
+#: pyfemtet/message/messages.py:144
 msgid "Open Result in Femtet"
 msgstr ""
 
-#: pyfemtet/message/messages.py:141
+#: pyfemtet/message/messages.py:145
 msgid "Reconstruct Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:142
+#: pyfemtet/message/messages.py:146
 msgid "Drag and drop or select csv file"
 msgstr ""
 
-#: pyfemtet/message/messages.py:143
+#: pyfemtet/message/messages.py:147
 msgid "Connection to Femtet is not established. Launch Femtet and Open a project."
 msgstr ""
 
-#: pyfemtet/message/messages.py:144
+#: pyfemtet/message/messages.py:148
 msgid "No result plot is selected."
 msgstr ""
 
-#: pyfemtet/message/messages.py:145
+#: pyfemtet/message/messages.py:149
 msgid "The femprj file path in the history csv is not found or valid."
 msgstr ""
 
-#: pyfemtet/message/messages.py:146
+#: pyfemtet/message/messages.py:150
 msgid "The model name in the history csv is not found."
 msgstr ""
 
-#: pyfemtet/message/messages.py:147
+#: pyfemtet/message/messages.py:151
 msgid ".pdt file is not found. Please check the .Results folder. Note that .pdt file save mode depends on the `save_pdt` argument of FemtetInterface in optimization script(default to `all`)."
 msgstr ""
 
-#: pyfemtet/message/messages.py:152
+#: pyfemtet/message/messages.py:156
 msgid "Failed to open "
 msgstr ""
 
-#: pyfemtet/message/messages.py:153
+#: pyfemtet/message/messages.py:157
 msgid "Specified model is not in current project. Please check opened project. For example, not \"analysis model only\" but your .femprj file."
 msgstr ""
 
-#: pyfemtet/message/messages.py:156
+#: pyfemtet/message/messages.py:160
 msgid ".femprj file path of the history csv is invalid. Please certify matching between csv and opening .femprj file."
 msgstr ""
 
-#: pyfemtet/message/messages.py:157
+#: pyfemtet/message/messages.py:161
 msgid "Analysis model name of the history csv is invalid. Please certify matching between csv and opening analysis model."
 msgstr ""
 
-#: pyfemtet/message/messages.py:158
+#: pyfemtet/message/messages.py:162
 msgid "Analysis model name of the history csv and opened in Femtet is inconsistent. Please certify matching between csv and opening analysis model."
 msgstr ""
 
-#: pyfemtet/message/messages.py:159
+#: pyfemtet/message/messages.py:163
 msgid "tutorial mode"
 msgstr ""
 
-#: pyfemtet/message/messages.py:160
+#: pyfemtet/message/messages.py:164
 msgid "Load Sample CSV"
 msgstr ""
 
-#: pyfemtet/message/messages.py:161
+#: pyfemtet/message/messages.py:165
 msgid "Load CSV"
 msgstr ""
 
-#: pyfemtet/message/messages.py:162
+#: pyfemtet/message/messages.py:166
 msgid "Open your optimization result. Then connecting to femtet will start automatically. Note that in tutorial mode, this button loads the ready-made sample csv and open sample femprj."
 msgstr ""
 
-#: pyfemtet/message/messages.py:164
+#: pyfemtet/message/messages.py:168
 msgid "Main Graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:165
+#: pyfemtet/message/messages.py:169
 msgid "Here the optimization history is shown. Each plot represents single FEM result. You can pick a result to open the corresponding result in Femtet. "
 msgstr ""
 
-#: pyfemtet/message/messages.py:168
+#: pyfemtet/message/messages.py:172
 msgid "Open Result"
 msgstr ""
 
-#: pyfemtet/message/messages.py:169
+#: pyfemtet/message/messages.py:173
 msgid "After pick a point in the main graph, This button shows the corresponding FEM result in Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:171
+#: pyfemtet/message/messages.py:175
 msgid "Re-connect to Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:172
+#: pyfemtet/message/messages.py:176
 msgid "Sample csv is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
-#: pyfemtet/message/messages.py:173
+#: pyfemtet/message/messages.py:177
 msgid "Sample femprj file is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
-#: pyfemtet/message/messages.py:174
+#: pyfemtet/message/messages.py:178
 msgid "Sample femprj result folder is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
+#: pyfemtet/message/messages.py:180
+msgid "Loading data..."
+msgstr ""
+
+#: pyfemtet/message/messages.py:181
+msgid "Plots of objectives versus trials"
+msgstr ""
+
+#: pyfemtet/message/messages.py:182
+msgid "The vertical axis is the objective, and the horizontal axis is the number of trials."
+msgstr ""
+
+#: pyfemtet/message/messages.py:183
+msgid "Parallel coordinate plots"
+msgstr ""
+
+#: pyfemtet/message/messages.py:184
+msgid "The vertical axis is an objective or parameters, and one polyline indicates one result."
+msgstr ""
+
+#: pyfemtet/message/messages.py:185
+msgid "The heatmap of objectives"
+msgstr ""
+
+#: pyfemtet/message/messages.py:186
+msgid "The axes are parameters, and the color shows objective value."
+msgstr ""
+
+#: pyfemtet/message/messages.py:187
+msgid "The response of an objective versus one parameter"
+msgstr ""
+
+#: pyfemtet/message/messages.py:188
+msgid "The vertical axis is objective, and the horizontal axis is parameter."
+msgstr ""
+

pyfemtet/message/messages.py

@@ -82,7 +82,7 @@ class Message:
     ERR_JPG_NOT_FOUND = _('Screenshot (.jpg) is not found.')
     ERR_UPDATE_SOLIDWORKS_MODEL_FAILED = _('Failed to update model in solidworks.')
 
-    # ===== pyfemtet.opt.opt =====
+    # ===== pyfemtet.opt.optimizer =====
     ERR_NOT_IMPLEMENTED = _('The following features are not supported by the specified optimization method. ')
     ERR_INCONSISTENT_PARAMETER = _('The parameter set does not match the one added with add_init_parameter.')
     INFO_EXCEPTION_DURING_FEM_ANALYSIS = _('An exception has occurred during FEM update. Current parameters are: ')
@@ -90,6 +90,9 @@ class Message:
     ERR_FEM_FAILED_AND_CANNOT_CONTINUE = _('Current parameter set cannot update FEM and this optimization method cannot skip current parameter set. The optimization process will be terminated.')
     WARN_INTERRUPTED_IN_SCIPY = _('Optimization has been interrupted. Note that you cannot acquire the OptimizationResult in case of `trust-constr`, `TNC`, `SLSQP` or `COBYLA`.')
     ERR_PARAMETER_CONSTRAINT_ONLY_BOTORCH = _('You can use parameter constraint only with BoTorchSampler.')
+    WARN_SCIPY_DOESNT_NEED_SEED = _('Scipy is deterministic, so whether you set a seed or not will not change the results.')
+    START_CANDIDATE_WITH_PARAMETER_CONSTRAINT = _('Start to candidate new parameter set with constraints. This process may take a long time.')
+    WARN_UPDATE_FEM_PARAMETER_TOOK_A_LONG_TIME = _('Updating FEM parameter during evaluating constraints take a long time. Please consider not to use FEM variables in constraint functions and set `update_fem` to False.')
 
     # ===== pyfemtet.opt.visualization =====
     # control_femtet.py
@@ -111,7 +114,8 @@ class Message:
     GRAPH_TITLE_MULTI_OBJECTIVE = _('Multi Objective Pair Plot')
     GRAPH_AXIS_LABEL_TRIAL = _('trial number')
     # main_graph.py
-    TAB_LABEL_OBJECTIVES = _('Objectives')
+    TAB_LABEL_OBJECTIVE_PLOT = _('Objectives')
+    TAB_LABEL_OBJECTIVE_SCATTERPLOT = _('Objectives (all)')
     # pm_graph.py
     TAB_LABEL_PREDICTION_MODEL = _('Prediction Model')
     LABEL_OF_CREATE_PREDICTION_MODEL_BUTTON = _(' Recalculate Model')

pyfemtet/opt/__init__.py

@@ -4,8 +4,8 @@ from pyfemtet.opt.interface import FemtetInterface
 from pyfemtet.opt.interface import FemtetWithNXInterface
 from pyfemtet.opt.interface import FemtetWithSolidworksInterface
 
-from pyfemtet.opt.opt import OptunaOptimizer, ScipyOptimizer
-from pyfemtet.opt.opt import AbstractOptimizer
+from pyfemtet.opt.optimizer import OptunaOptimizer, ScipyOptimizer, ScipyScalarOptimizer
+from pyfemtet.opt.optimizer import AbstractOptimizer
 
 from pyfemtet.opt._femopt import FEMOpt
 
@@ -19,4 +19,6 @@ __all__ = [
     'FemtetWithSolidworksInterface',
     'AbstractOptimizer',
     'OptunaOptimizer',
+    'ScipyScalarOptimizer',
+    'ScipyOptimizer',
 ]

pyfemtet/opt/_femopt.py

@@ -16,11 +16,12 @@ from dask.distributed import LocalCluster, Client
 
 # pyfemtet relative
 from pyfemtet.opt.interface import FEMInterface, FemtetInterface
-from pyfemtet.opt.opt import AbstractOptimizer, OptunaOptimizer
+from pyfemtet.opt.optimizer import AbstractOptimizer, OptunaOptimizer
 from pyfemtet.opt.visualization.process_monitor.application import main as process_monitor_main
 from pyfemtet.opt._femopt_core import (
     _check_bound,
     _is_access_gogh,
+    _is_access_femtet,
     Objective,
     Constraint,
     History,
@@ -98,9 +99,9 @@ class FEMOpt:
             self.fem = fem
 
         if opt is None:
-            self.opt = OptunaOptimizer()
+            self.opt: AbstractOptimizer = OptunaOptimizer()
         else:
-            self.opt = opt
+            self.opt: AbstractOptimizer = opt
 
         # メンバーの宣言
         self.client = None
@@ -260,6 +261,7 @@ class FEMOpt:
             strict: bool = True,
             args: tuple or None = None,
             kwargs: dict or None = None,
+            using_fem: bool = None,
     ):
         """Adds a constraint to the optimization problem.
 
@@ -271,6 +273,7 @@ class FEMOpt:
             strict (bool, optional): Flag indicating if it is a strict constraint. Defaults to True.
             args (tuple or None, optional): Additional arguments for the constraint function. Defaults to None.
             kwargs (dict): Additional arguments for the constraint function. Defaults to None.
+            using_fem (bool, optional): Using FEM or not in the constraint function. It may make the processing time in strict constraints in BoTorchSampler. Defaults to None. If None, PyFemtet checks the access to Femtet and estimate using Femtet or not automatically.
 
         Note:
             If the FEMInterface is FemtetInterface, the 1st argument of fun should be Femtet (IPyDispatch) object.
@@ -298,55 +301,33 @@ class FEMOpt:
                 else:
                     i += 1
             name = candidate
+        if using_fem is None:
+            # 自動推定機能は Femtet 特有の処理とする
+            if isinstance(self.fem, FemtetInterface):
+                using_fem = _is_access_femtet(fun)
+            else:
+                using_fem = False
 
         # strict constraint の場合、solve 前に評価したいので Gogh へのアクセスを禁ずる
-        if strict:
+        if strict and isinstance(self.fem, FemtetInterface):
             if _is_access_gogh(fun):
                 message = Msg.ERR_CONTAIN_GOGH_ACCESS_IN_STRICT_CONSTRAINT
                 raise Exception(message)
 
-        self.opt.constraints[name] = Constraint(fun, name, lower_bound, upper_bound, strict, args, kwargs)
-
-    def add_parameter_constraint(
-            self,
-            fun: Callable[[List[float], Any], float],
-            name: Optional[str] = None,
-            lower_bound: Optional[float] = None,
-            upper_bound: Optional[float] = None,
-    ):
-        """Add constraint in case of parameter-only.
-
-        Args:
-            fun (Callable[[List[float], Any], float]): Function to constraint. The name of arguments must be one of ones of parameter or variables.
-            name (Optional[str], optional): Name of constraint. Defaults to None and then name is set to 'cns_{i}'.
-            lower_bound (Optional[float], optional): Lower bound of return value. Defaults to None.
-            upper_bound (Optional[float], optional): Upper bound of return value. Defaults to None.
-        """
-
-        # candidate default name
-        if name is None:
-            prefix = Constraint.default_name
-            i = 0
-            while True:
-                candidate = f'{prefix}_{str(int(i))}'
-                is_existing = candidate in list(self.opt.constraints.keys())
-                if not is_existing:
-                    break
-                else:
-                    i += 1
-            name = candidate
-
-        # assert at least 1 bound exist
-        assert lower_bound is not None or upper_bound is not None, Msg.ERR_NO_BOUNDS
-
-        from pyfemtet.opt._femopt_core import ParameterConstraint
-        self.opt.constraints[name] = ParameterConstraint(fun, name, lower_bound, upper_bound, self.opt)
-        if hasattr(self.opt, 'add_parameter_constraints'):
-            prm_args = [p.name for p in inspect.signature(fun).parameters.values()]
-            if lower_bound is not None:
-                self.opt.add_parameter_constraints(lambda *args, **kwargs: fun(*args, **kwargs) - lower_bound, prm_args=prm_args)
-            if upper_bound is not None:
-                self.opt.add_parameter_constraints(lambda *args, **kwargs: upper_bound - fun(*args, **kwargs), prm_args=prm_args)
+        # strict constraint かつ BoTorchSampler の場合、
+        # 最適化実行時に monkey patch を実行するフラグを立てる。
+        # ただし using_fem が True ならば非常に低速なので警告を出す。
+        if strict and isinstance(self.opt, OptunaOptimizer):
+            self.opt: OptunaOptimizer
+            from optuna_integration import BoTorchSampler
+            if issubclass(self.opt.sampler_class, BoTorchSampler):
+                # パッチ実行フラグ
+                self.opt._do_monkey_patch = True
+                # 警告
+                if using_fem:
+                    logger.warning(Msg.WARN_UPDATE_FEM_PARAMETER_TOOK_A_LONG_TIME)
+
+        self.opt.constraints[name] = Constraint(fun, name, lower_bound, upper_bound, strict, args, kwargs, using_fem)
 
     def get_parameter(self, format='dict'):
         raise DeprecationWarning('FEMOpt.get_parameter() was deprecated. Use Femopt.opt.get_parameter() instead.')