PyFemtet 1.8.3__tar.gz → 1.9.1__tar.gz

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyfemtet
-Version: 1.8.3
+Version: 1.9.1
 Summary: Design parameter optimization using Femtet.
 License-Expression: MIT
 License-File: LICENSE

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/pyfemtet/opt/femopt.py

@@ -49,8 +49,8 @@ class FEMOpt:
 
     def __init__(
             self,
-            fem: AbstractFEMInterface = None,
-            opt: AbstractOptimizer = None,
+            fem: AbstractFEMInterface | None = None,
+            opt: AbstractOptimizer | None = None,
     ):
         self.opt: AbstractOptimizer = opt or OptunaOptimizer()
         
@@ -160,7 +160,7 @@ class FEMOpt:
             names: str | list[str],
             fun: Callable[..., Sequence[float]],
             n_return: int,
-            directions: DIRECTION | Sequence[DIRECTION] = None,
+            directions: DIRECTION | Sequence[DIRECTION] | None = None,
             args: tuple | None = None,
             kwargs: dict | None = None,
     ):
@@ -208,7 +208,7 @@ class FEMOpt:
     ):
         self.opt.set_termination_condition(func)
 
-    def set_monitor_host(self, host: str = None, port: int = None):
+    def set_monitor_host(self, host: str | None = None, port: int | None = None):
         """Sets the host IP address and the port of the process monitor.
 
         Args:
@@ -240,14 +240,14 @@ class FEMOpt:
 
     def optimize(
             self,
-            n_trials: int = None,
+            n_trials: int | None = None,
             n_parallel: int = 1,
-            timeout: float = None,
+            timeout: float | None = None,
             wait_setup: bool = True,
             confirm_before_exit: bool = True,
-            history_path: str = None,
+            history_path: str | None = None,
             with_monitor: bool = True,
-            scheduler_address: str = None,
+            scheduler_address: str | None = None,
             seed: int | None = None,
     ):
 
@@ -258,7 +258,7 @@ class FEMOpt:
                 ver=pyfemtet.__version__,
             )
         )
-        client: Client
+        client: Client | DummyClient
 
         # set arguments
         self.opt.n_trials = n_trials or self.opt.n_trials
@@ -274,7 +274,6 @@ class FEMOpt:
             worker_name_base = 'Sub'
             if n_parallel == 1:
                 cluster = nullcontext()
-                # noinspection PyTypeChecker
                 client = DummyClient()
 
             else:
@@ -534,137 +533,3 @@ class FEMOpt:
         logger.info(_('All processes are terminated.'))
 
         return df
-
-
-def debug_1():
-    # noinspection PyUnresolvedReferences
-    from time import sleep
-    # from pyfemtet.opt.optimizer import InterruptOptimization
-    import optuna
-    from pyfemtet.opt.interface import AbstractFEMInterface, NoFEM
-
-    def _parabola(_fem: AbstractFEMInterface, _opt: AbstractOptimizer):
-        x = _opt.get_variables('values')
-        # print(os.getpid())
-        # raise RuntimeError
-        # raise Interrupt
-        # if get_worker() is None:
-        #     raise RuntimeError
-        return (x ** 2).sum()
-
-    def _cns(_fem: AbstractFEMInterface, _opt: AbstractOptimizer):
-        x = _opt.get_variables('values')
-        return x[0]
-
-    _opt = OptunaOptimizer()
-    _opt.sampler = optuna.samplers.TPESampler(seed=42)
-    _opt.n_trials = 10
-
-    _fem = NoFEM()
-    _opt.fem = _fem
-
-    _args = (_opt,)
-
-    _opt.add_parameter('x1', 1, -1, 1, step=0.2)
-    _opt.add_parameter('x2', 1, -1, 1, step=0.2)
-
-    _opt.add_constraint('cns', _cns, lower_bound=-0.5, args=_args)
-
-    _opt.add_objective('obj', _parabola, args=_args)
-
-    _femopt = FEMOpt(fem=_fem, opt=_opt)
-    _femopt.opt = _opt
-    # _femopt.opt.history.path = 'v1test/femopt-restart-test.csv'
-    _femopt.optimize(n_parallel=2)
-
-    print(os.path.abspath(_femopt.opt.history.path))
-
-
-def substrate_size(Femtet):
-    """基板のXY平面上での専有面積を計算します。"""
-    substrate_w = Femtet.GetVariableValue('substrate_w')
-    substrate_d = Femtet.GetVariableValue('substrate_d')
-
-    # assert get_worker() is not None
-
-    return substrate_w * substrate_d  # 単位: mm2
-
-
-def debug_2():
-    from pyfemtet.opt.interface import FemtetInterface
-    from pyfemtet.opt.optimizer import OptunaOptimizer
-
-    fem = FemtetInterface(
-        femprj_path=os.path.join(os.path.dirname(__file__), 'wat_ex14_parametric_jp.femprj'),
-    )
-
-    opt = OptunaOptimizer()
-
-    opt.fem = fem
-
-    opt.add_parameter(name="substrate_w", initial_value=40, lower_bound=22, upper_bound=60)
-    opt.add_parameter(name="substrate_d", initial_value=60, lower_bound=34, upper_bound=60)
-    opt.add_objective(name='基板サイズ(mm2)', fun=substrate_size)
-    opt.add_objective(name='obj2', fun=substrate_size)
-    opt.add_objective(name='obj3', fun=substrate_size)
-
-    opt.n_trials = 10
-    # opt.history.path = os.path.join(os.path.dirname(__file__), 'femtet-test.csv')
-
-    femopt = FEMOpt()
-
-    femopt.opt = opt
-
-    femopt.optimize(n_parallel=1)
-
-
-def debug_3():
-    # noinspection PyUnresolvedReferences
-    from time import sleep
-    # from pyfemtet.opt.optimizer import InterruptOptimization
-    import optuna
-    from pyfemtet.opt.interface import AbstractFEMInterface, NoFEM
-
-    def _parabola(_fem: AbstractFEMInterface, _opt: AbstractOptimizer):
-        x = _opt.get_variables('values')
-        # print(os.getpid())
-        # raise RuntimeError
-        # raise Interrupt
-        # if get_worker() is None:
-        #     raise RuntimeError
-        return (x ** 2).sum()
-
-    def _cns(_fem: AbstractFEMInterface, _opt: AbstractOptimizer):
-        x = _opt.get_variables('values')
-        return x[0]
-
-    _opt = OptunaOptimizer()
-    _opt.sampler = optuna.samplers.TPESampler(seed=42)
-
-    _fem = NoFEM()
-    _opt.fem = _fem
-
-    _args = (_opt,)
-
-    _opt.add_parameter('x1', 1, -1, 1, step=0.2)
-    _opt.add_parameter('x2', 1, -1, 1, step=0.2)
-
-    _opt.add_constraint('cns', _cns, lower_bound=-0.5, args=_args)
-
-    _opt.add_objective('obj', _parabola, args=_args)
-
-    _femopt = FEMOpt(fem=_fem, opt=_opt)
-    _femopt.optimize(
-        scheduler_address='<dask scheduler で起動したスケジューラの tcp をここに入力>',
-        n_trials=80,
-        n_parallel=6,
-        with_monitor=True,
-        confirm_before_exit=False,
-    )
-
-
-if __name__ == '__main__':
-    # for i in range(1):
-        debug_1()
-    # debug_2()
-    # debug_3()

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/pyfemtet/opt/history/_history.py

@@ -372,11 +372,21 @@ class ColumnManager:
     column_dtypes: dict[str, type]
     meta_columns: list[str]
 
-    @staticmethod
-    def columns_to_keep_even_if_nan():
-        return [
-            "messages",
-        ]
+    def columns_to_keep_even_if_nan(self) -> set[str]:
+        out = {"messages"}
+        # objective
+        for name in self.get_obj_names():
+            out.add(name)
+            out.add(CorrespondingColumnNameRuler.direction_name(name))
+        # constraint
+        for name in self.get_cns_names():
+            out.add(name)
+            out.add(CorrespondingColumnNameRuler.cns_lower_bound_name(name))
+            out.add(CorrespondingColumnNameRuler.cns_upper_bound_name(name))
+        # other_output
+        for name in self.get_other_output_names():
+            out.add(name)
+        return out
 
     def initialize(
         self,
@@ -955,6 +965,72 @@ class Records:
         self.loaded_meta_columns = loaded_meta_columns
         self.loaded_df = loaded_df
 
+    @staticmethod
+    def _incompatible_setting_detail(
+        category_en: str,
+        category_jp: str,
+        added: set[str],
+        removed: set[str],
+    ) -> str | None:
+        if not added and not removed:
+            return None
+        category = _(en_message=category_en, jp_message=category_jp)
+        lines = []
+        if added:
+            lines.append(
+                _(
+                    en_message="  Extra {category}: {names}",
+                    jp_message="  余分な{category}: {names}",
+                    category=category,
+                    names=", ".join(sorted(added)),
+                )
+            )
+        if removed:
+            lines.append(
+                _(
+                    en_message="  Missing {category}: {names}",
+                    jp_message="  足りない{category}: {names}",
+                    category=category,
+                    names=", ".join(sorted(removed)),
+                )
+            )
+        return "\n".join(lines)
+
+    @staticmethod
+    def _incompatible_setting_message(details: list[str]) -> str:
+        detail = "\n".join(details)
+        return _(
+            en_message="The current script settings do not match "
+            "the history CSV file loaded via history_path.\n"
+            "\n"
+            "[The current setting incompatibilities]\n"
+            "{detail}\n"
+            "\n"
+            "[Countermeasure]\n"
+            "When resuming optimization with history_path, "
+            "the settings must be compatible with the previous run. "
+            "To fix this, choose one of the following options:\n"
+            "  1. Restore the settings to match the previous run.\n"
+            "  2. Remove the history_path argument to start a new optimization.\n"
+            "  3. Delete the history CSV file (and the .db file with the same name, if it exists) "
+            "to discard the previous history and start fresh.",
+            jp_message="現在のスクリプトの設定が、"
+            "history_path で読み込んだ履歴 CSV ファイルの内容と一致しません。\n"
+            "\n"
+            "[現在の設定の不整合点]\n"
+            "{detail}\n"
+            "\n"
+            "[対策]\n"
+            "history_path を指定して最適化を再開する場合、"
+            "設定は前回の実行と整合している必要があります。"
+            "以下のいずれかの方法で対処してください:\n"
+            "  1. 前回の実行と同じ設定に戻す。\n"
+            "  2. history_path の指定を削除して新しい最適化を開始する。\n"
+            "  3. 履歴 CSV ファイル（および同名の .db ファイルがあればそれも）を削除し、"
+            "前回の履歴を破棄して最初からやり直す。",
+            detail=detail,
+        )
+
     def check_problem_compatibility(self):
         # 読み込んだデータがないのであれば何もしない
         if self.loaded_df is None:
@@ -968,6 +1044,8 @@ class Records:
             self.loaded_meta_columns,
         )
 
+        incompatible_details: list[str] = []
+
         # prm_names が過不足ないか
         loaded_prm_names = set(
             self.column_manager._filter_prm_names(loaded_columns, loaded_meta_columns)
@@ -976,7 +1054,13 @@ class Records:
         if not (
             len(loaded_prm_names - prm_names) == len(prm_names - loaded_prm_names) == 0
         ):
-            raise RuntimeError("Incompatible parameter setting.")
+            detail = self._incompatible_setting_detail(
+                "parameter", "パラメータ",
+                added=prm_names - loaded_prm_names,
+                removed=loaded_prm_names - prm_names,
+            )
+            if detail:
+                incompatible_details.append(detail)
 
         # obj_names が増えていないか
         loaded_obj_names = set(
@@ -986,7 +1070,13 @@ class Records:
         )
         obj_names = set(self.column_manager.get_obj_names())
         if len(obj_names - loaded_obj_names) > 0:
-            raise RuntimeError("Incompatible objective setting.")
+            detail = self._incompatible_setting_detail(
+                "objective", "目的関数",
+                added=obj_names - loaded_obj_names,
+                removed=set(),
+            )
+            if detail:
+                incompatible_details.append(detail)
 
         # cns_names が過不足ないか
         # TODO: cns の上下限は変更されてはならない。
@@ -999,7 +1089,18 @@ class Records:
         if not (
             len(loaded_cns_names - cns_names) == len(cns_names - loaded_cns_names) == 0
         ):
-            raise RuntimeError("Incompatible constraint setting.")
+            detail = self._incompatible_setting_detail(
+                "constraint", "拘束条件",
+                added=cns_names - loaded_cns_names,
+                removed=loaded_cns_names - cns_names,
+            )
+            if detail:
+                incompatible_details.append(detail)
+
+        if incompatible_details:
+            raise RuntimeError(
+                self._incompatible_setting_message(incompatible_details)
+            )
 
     def reinitialize_record_with_loaded_data(
         self, column_order_mode: str = ColumnOrderMode.per_category
@@ -1126,7 +1227,7 @@ class Records:
         self.df_wrapper.set_df(df)
 
     def remove_nan_columns(
-        self, df, meta_columns, columns_to_keep: str | list[str] = None
+        self, df, meta_columns, columns_to_keep: set[str] | None = None
     ) -> tuple[pd.DataFrame, tuple[str]]:
         """
 
@@ -1134,6 +1235,7 @@ class Records:
             df:
             meta_columns:
             columns_to_keep: Allowing these columns to all NaN values.
+                If None, use self.column_manager.columns_to_keep_even_if_nan().
 
         Returns:
             Removed DataFrame and corresponding meta_columns.

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/pyfemtet/opt/interface/_base_interface.py

@@ -244,6 +244,16 @@ class AbstractFEMInterface:
     def _get_additional_data(self) -> dict:
         return dict()
 
+    # name
+    @property
+    def name(self) -> str:
+        if hasattr(self, '_name'):
+            return self._name
+        return self.__class__.__name__
+
+    @name.setter
+    def name(self, value: str):
+        self._name = value
 
 class COMInterface(AbstractFEMInterface):
 

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/pyfemtet/opt/interface/_excel_interface/excel_interface.py

@@ -662,7 +662,6 @@ class ExcelInterface(COMInterface):
                     upper_bound=ub,
                     step=step,
                     fix=not use,
-                    supress_duplicated_name_check=True,
                 )
 
             elif kind == 'Categorical':
@@ -675,7 +674,6 @@ class ExcelInterface(COMInterface):
                     initial_value=value,
                     choices=choices,
                     fix=not use,
-                    supress_duplicated_name_check=True,
                 )
 
             else:
@@ -722,7 +720,6 @@ class ExcelInterface(COMInterface):
                     direction=direction,
                     fun=_ScapeGoatObjective(),
                     kwargs=dict(name=name),
-                    supress_duplicated_name_check=True,
                 )
 
     def load_constraints(self, opt: OptimizationDataPerFEM, raise_if_no_keyword=False):
@@ -784,7 +781,6 @@ class ExcelInterface(COMInterface):
                     fun=_ScapeGoatObjective(),
                     kwargs=dict(name=name),
                     using_fem=not calc_before_solve,
-                    supress_duplicated_name_check=True,
                 )
 
     def objective_from_excel(self, _, name: str):

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/pyfemtet/opt/interface/_femtet_interface/_femtet_parametric.py

@@ -223,7 +223,6 @@ def add_parametric_results_as_objectives(opt, Femtet, indexes, directions) -> bo
         # objective value function
         opt.add_objective(
             name=name, fun=_parametric_objective, direction=direction, args=(i,),
-            supress_duplicated_name_check=True,            
         )
     return True  # ここまで来たら成功
 
@@ -244,7 +243,7 @@ def _parametric_objective(Femtet, parametric_result_index):
     return dll.GetPrmResult(parametric_result_index)
 
 
-def solve_via_parametric_dll(Femtet) -> bool:
+def solve_via_parametric_dll(Femtet, clear_sweep_table: bool = True) -> bool:
     csv_processor = get_csv_processor(Femtet)
 
     # remove previous csv if exists
@@ -256,11 +255,12 @@ def solve_via_parametric_dll(Femtet) -> bool:
     dll = _get_dll_with_set_femtet(Femtet)
 
     # reset existing sweep table
-    dll.ClearPrmSweepTable.restype = ctypes.c_bool
-    succeed = dll.ClearPrmSweepTable()
-    if not succeed:
-        logger.error('Failed to remove existing sweep table!')  # 通常ありえないので error
-        return False
+    if clear_sweep_table:
+        dll.ClearPrmSweepTable.restype = ctypes.c_bool
+        succeed = dll.ClearPrmSweepTable()
+        if not succeed:
+            logger.error('Failed to remove existing sweep table!')  # 通常ありえないので error
+            return False
 
     # solve
     dll.PrmCalcExecute.restype = ctypes.c_bool

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/pyfemtet/opt/interface/_femtet_interface/femtet_interface.py

@@ -174,6 +174,7 @@ class FemtetInterface(COMInterface):
         self._warn_if_undefined_variable = True
         self.api_response_warning_time = 10  # mesh, solve, re-execute を除くマクロ実行警告時間
         self.save_screenshot: Literal["result", "model", "none"] = "model"
+        self._clear_parametric_sweep_table: bool = True
 
         # connect to Femtet
         self._connect_and_open_femtet()
@@ -185,6 +186,17 @@ class FemtetInterface(COMInterface):
 
     # ===== system =====
 
+    @property
+    def name(self) -> str:
+        name = ""
+        if self.femprj_path is not None:
+            name += os.path.basename(self.femprj_path)
+        if self.model_name is not None:
+            name += f' - {self.model_name}'
+        if name == "":
+            name = super().name
+        return name
+
     @property
     def object_pass_to_fun(self):
         """The object pass to the first argument of user-defined objective functions.
@@ -1000,7 +1012,7 @@ class FemtetInterface(COMInterface):
                 if_error=SolveError,
                 error_message=Msg.ERR_PARAMETRIC_SOLVE_FAILED,
                 is_Gaudi_method=True,
-                args=(self.Femtet,),
+                args=(self.Femtet, self._clear_parametric_sweep_table),
             )
 
             # parametric analysis の場合

{pyfemtet-1.8.3 → pyfemtet-1.9.1}/pyfemtet/opt/interface/_surrogate_model_interface/base_surrogate_interface.py

@@ -122,7 +122,7 @@ class AbstractSurrogateModelInterfaceBase(AbstractFEMInterface):
             def dummy(*args, **kwargs):
                 assert False
 
-            ctx.add_objective(obj_name, dummy, direction, supress_duplicated_name_check=True)
+            ctx.add_objective(obj_name, dummy, direction)
         
         # ctx の目的関数のうち train に含まれるものを差し替え
         # directions の目的変数名を validation しているので漏れはないはず