PyFemtet 1.3.2__tar.gz → 1.5.0__tar.gz

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/PKG-INFO

@@ -1,18 +1,19 @@
 Metadata-Version: 2.4
 Name: pyfemtet
-Version: 1.3.2
+Version: 1.5.0
 Summary: Design parameter optimization using Femtet.
 License-Expression: MIT
 License-File: LICENSE
 License-File: LICENSE_THIRD_PARTY.txt
 Author: pyfemtet
 Author-email: 148934231+pyfemtet@users.noreply.github.com
-Requires-Python: >= 3.10, < 3.14
+Requires-Python: >= 3.10, < 3.15
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: babel (>=2.15.0,<3)
 Requires-Dist: botorch (>=0.12.0,<0.15.0)
 Requires-Dist: colorlog (>=6.8.0,<7)

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyfemtet/opt/exceptions.py

@@ -39,7 +39,17 @@ class InterruptOptimization(ExceptionDuringOptimization): ...
 class SkipSolve(ExceptionDuringOptimization): ...
 
 
-def show_experimental_warning(feature_name):
-    warnings.warn(f'{feature_name} は実験的機能です。将来 API 等が'
-                  f'大きく変更されるか、機能自体が削除される'
-                  f'可能性があります。')
+_shown = set()
+
+
+def show_experimental_warning(feature_name, logger=None):
+    global _shown
+    if feature_name not in _shown:
+        _shown.add(feature_name)
+        msg = (f'{feature_name} は実験的機能です。将来 API 等が'
+               '大きく変更されるか、機能自体が削除される'
+               '可能性があります。')
+        if logger is not None:
+            logger.warning(msg)
+        else:
+            warnings.warn(msg)

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyfemtet/opt/femopt.py

@@ -20,6 +20,7 @@ from pyfemtet.opt.problem.variable_manager import *
 from pyfemtet.opt.interface import *
 from pyfemtet.opt.optimizer import *
 from pyfemtet.opt.optimizer._base_optimizer import DIRECTION
+from pyfemtet.opt.history import History
 from pyfemtet.logger import get_module_logger
 from pyfemtet.opt.visualization.history_viewer._process_monitor._application import (
     process_monitor_main,
@@ -182,6 +183,12 @@ class FEMOpt:
     ):
         self.opt.add_sub_fidelity_model(name, sub_fidelity_model, fidelity)
 
+    def set_termination_condition(
+            self,
+            func: Callable[[History], bool] | None,
+    ):
+        self.opt.set_termination_condition(func)
+
     def set_monitor_host(self, host: str = None, port: int = None):
         """Sets the host IP address and the port of the process monitor.
 

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyfemtet/opt/interface/_femtet_interface/femtet_interface.py

@@ -425,12 +425,18 @@ class FemtetInterface(COMInterface):
         # 開く
         if self.model_name is None:
             result = self.Femtet.LoadProject(self.femprj_path, True)
+            if not result:
+                self.Femtet.ShowLastError()
         else:
+            result = self.Femtet.LoadProject(self.femprj_path, True)
+            if not result:
+                self.Femtet.ShowLastError()
+
             result = self.Femtet.LoadProjectAndAnalysisModel(
                 self.femprj_path, self.model_name, True
             )
-        if not result:
-            self.Femtet.ShowLastError()
+            if not result:
+                self.Femtet.ShowLastError()
 
     def _connect_and_open_femtet(self):
         """Connects to a Femtet process and open the femprj.

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyfemtet/opt/optimizer/_base_optimizer.py

@@ -17,6 +17,7 @@ from pyfemtet.opt.problem.problem import *
 from pyfemtet.opt.problem.variable_manager import *
 from pyfemtet.opt.optimizer._trial_queue import *
 from pyfemtet.logger import get_module_logger
+from pyfemtet.opt.exceptions import show_experimental_warning
 
 __all__ = [
     'AbstractOptimizer',
@@ -114,6 +115,7 @@ class AbstractOptimizer:
         self.fem: AbstractFEMInterface | None = None
         self.history: History = History()
         self.solve_condition: Callable[[History], bool] = lambda _: True
+        self.termination_condition: Callable[[History], bool] = lambda _: False
         self.entire_status: WorkerStatus = WorkerStatus(ENTIRE_PROCESS_STATUS_KEY)
         self.worker_status: WorkerStatus = WorkerStatus('worker-status')
         self.worker_status_list: list[WorkerStatus] = [self.worker_status]
@@ -397,6 +399,13 @@ class AbstractOptimizer:
     def set_solve_condition(self, fun: Callable[[History], bool]):
         self.solve_condition = fun
 
+    def set_termination_condition(self, fun: Callable[[History], bool] | None):
+        if fun is None:
+            self.termination_condition = lambda _: False
+        else:
+            self.termination_condition = fun
+        show_experimental_warning('set_termination_condition', logger)
+
     # ===== private =====
 
     def _setup_enqueued_trials(self):
@@ -505,7 +514,8 @@ class AbstractOptimizer:
             pass
 
         def _postprocess(self):
-            pass
+            if self.opt.termination_condition(self.opt.history):
+                self.opt.entire_status.value = WorkerStatus.interrupting
 
         def _solve_or_raise(
                 self,
@@ -879,7 +889,7 @@ class AbstractOptimizer:
 
             if os.environ.get('DEBUG_FEMOPT_PARALLEL'):
                 if isinstance(worker_idx, int):
-                    sleep(worker_idx)
+                    sleep((worker_idx + 1) * 2)
 
             self.run()
 

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyfemtet/opt/optimizer/optuna_optimizer/_optuna_optimizer.py

@@ -267,6 +267,7 @@ class OptunaOptimizer(AbstractOptimizer):
         def _postprocess(self):
             # update trial attribute
             self.optuna_attr.set_user_attr_to_trial(self.opt.current_trial)
+            super()._postprocess()
 
     def _create_infeasible_constraints(self, opt_: AbstractOptimizer = None) -> tuple:
         opt_ = opt_ if opt_ is not None else self

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyfemtet/opt/optimizer/scipy_optimizer/_scipy_optimizer.py

@@ -2,7 +2,8 @@ from __future__ import annotations
 
 from typing import Callable
 
-from contextlib import suppress
+from contextlib import suppress, contextmanager
+from time import time
 
 import numpy as np
 from scipy.optimize import minimize, OptimizeResult
@@ -10,9 +11,11 @@ from scipy.optimize import NonlinearConstraint
 
 from pyfemtet._i18n import Msg, _
 from pyfemtet._util.closing import closing
+from pyfemtet._util.dask_util import get_client, Lock
 from pyfemtet.opt.problem.variable_manager import *
 from pyfemtet.opt.problem.problem import *
 from pyfemtet.opt.exceptions import *
+from pyfemtet.opt.history import MAIN_FILTER
 from pyfemtet.logger import get_module_logger
 
 from pyfemtet.opt.optimizer._base_optimizer import *
@@ -26,6 +29,10 @@ __all__ = [
 logger = get_module_logger('opt.optimizer', False)
 
 
+class InterruptScipyMinimize(Exception):
+    pass
+
+
 class _ScipyCallback:
 
     def __init__(self, opt: ScipyOptimizer):
@@ -56,9 +63,6 @@ class ScipyOptimizer(AbstractOptimizer):
         
     """
 
-    _timeout: None = None
-    _n_trials: None = None
-
     def __init__(self, method: str = None, tol=None):
         super().__init__()
 
@@ -67,30 +71,42 @@ class ScipyOptimizer(AbstractOptimizer):
         self.options = {}
         self.constraint_enhancement = 0.001
         self.constraint_scaling = 1.
+        self._scheduler_address: str | None = None
+        self.timeout = None
+        self._time_start = None
+        self.__n_succeeded_trials = None
 
     @property
-    def timeout(self):
-        return self._timeout
-
-    @timeout.setter
-    def timeout(self, value):
-        if value is not None:
-            raise NotImplementedError(_(
-                en_message='`ScipyOptimizer` cannot use timeout.',
-                jp_message='`ScipyOptimizer` では timeout は指定できません。'
-            ))
-
-    @property
-    def n_trials(self):
-        return self._n_trials
-
-    @n_trials.setter
-    def n_trials(self, value):
-        if value is not None:
-            raise NotImplementedError(_(
-                en_message='`ScipyOptimizer` cannot use n_trials.',
-                jp_message='`ScipyOptimizer` では n_trials は指定できません。'
-            ))
+    def _n_succeeded_trials_in_current_optimization(self) -> int | None:  # オーバーライド不可
+        out = None
+        client = get_client(self._scheduler_address)
+        if client is not None:
+            raise NotImplementedError(
+                "ScipyOptimizer does not support parallel computing."
+            )
+        if self.__n_succeeded_trials is None:
+            self.__n_succeeded_trials = 0
+        return self.__n_succeeded_trials
+
+    @_n_succeeded_trials_in_current_optimization.setter
+    def _n_succeeded_trials_in_current_optimization(self, value: int | None):  # オーバーライド不可
+        client = get_client(self._scheduler_address)
+        with Lock('scipy_n_succeeded_trials'):
+            if client is not None:
+                raise NotImplementedError('ScipyOptimizer does not support parallel computing.')
+            self.__n_succeeded_trials = value
+
+    def _per_solve_callback(self):
+        df = self.history.get_df(equality_filters=MAIN_FILTER)
+        self._n_succeeded_trials_in_current_optimization = (
+            1 + self._n_succeeded_trials_in_current_optimization
+        )
+        if self.n_trials is not None:
+            if self._n_succeeded_trials_in_current_optimization >= self.n_trials:
+                raise InterruptScipyMinimize
+        if self.timeout is not None:
+            if time() - self._time_start >= self.timeout:
+                raise InterruptScipyMinimize
 
     def add_trial(self, parameters: dict[str, SupportedVariableTypes]):
         raise NotImplementedError(_(
@@ -98,8 +114,7 @@ class ScipyOptimizer(AbstractOptimizer):
             jp_message='`ScipyOptimizer` では `add_trial()` は使えません。',
         ))
 
-    def _get_x0(self) -> np.ndarray:
-
+    def _get_x0(self, after_finalizing_history=False) -> np.ndarray:
         # params を取得
         params: dict[str, Parameter] = self.variable_manager.get_variables(
             filter='parameter', format='raw'
@@ -112,7 +127,17 @@ class ScipyOptimizer(AbstractOptimizer):
                     jp_message='Scipy では数値パラメータのみ最適化できます。'
                 ))
 
-        # params のうち fix == True のものを除く
+        # リスタートならば最適値で初期値を上書きする
+        if after_finalizing_history:
+            df = self.history.get_df()
+            optimal_trials = df[df["optimality"]]
+            if len(optimal_trials) > 0:
+                optimal_trial = optimal_trials.iloc[-1]
+                for prm_name in params.keys():
+                    if prm_name in optimal_trial:
+                        params[prm_name].value = optimal_trial[prm_name]
+
+        # fix == True のものを除いて初期値を作成
         x0 = np.array([p.value for p in params.values() if not p.properties.get('fix', False)])
 
         return x0
@@ -133,8 +158,13 @@ class ScipyOptimizer(AbstractOptimizer):
             logger.warning(Msg.WARN_SCIPY_NELDER_MEAD_BOUND)
 
     def _setup_before_parallel(self):
-
         if not self._done_setup_before_parallel:
+            # 並列プロセスは起動のラグがあるので
+            # すべての並列プロセスで起算時刻を同じにしたい
+            self._time_start = time()
+            # 別のプロセスが計算を始めてから自分のプロセスが上書きし内容
+            # ここで初期化
+            self._n_succeeded_trials_in_current_optimization = 0
 
             super()._setup_before_parallel()  # flag inside
 
@@ -343,9 +373,7 @@ class ScipyOptimizer(AbstractOptimizer):
             ) from e
 
     def _objective(self, xk: np.ndarray) -> float:
-
         with self._logging():
-
             vm = self.variable_manager
 
             # parameter suggestion
@@ -357,6 +385,7 @@ class ScipyOptimizer(AbstractOptimizer):
             # process main fidelity model
             solve_set = self._get_solve_set()
             f_return = solve_set.solve(x)
+            self._per_solve_callback()
             assert f_return is not None
             dict_y_internal = f_return[1]
             y_internal: float = tuple(dict_y_internal.values())[0]  # type: ignore
@@ -364,26 +393,38 @@ class ScipyOptimizer(AbstractOptimizer):
             return y_internal
 
     def run(self):
-
         # ===== finalize =====
         self._finalize()
 
         # ===== construct x0 =====
-        x0 = self._get_x0()
+        x0 = self._get_x0(after_finalizing_history=True)
+
+        # ===== 終了条件 =====
+        # In case that setup_before_parallel is not called
+        if self._time_start is None:
+            self._time_start = time()
+        if self._n_succeeded_trials_in_current_optimization is None:
+            self._n_succeeded_trials_in_current_optimization = 0
 
         # ===== run =====
         with closing(self.fem):
 
-            with self._setting_status(), suppress(InterruptOptimization):
-
-                minimize(
-                    self._objective,
-                    x0,
-                    args=(),
-                    method=self.method,
-                    bounds=self._get_scipy_bounds(),
-                    constraints=self._get_scipy_constraints(),
-                    tol=self.tol,
-                    callback=self._get_scipy_callback(),
-                    options=self.options,
-                )
+            with self._setting_status(), \
+                    suppress(InterruptOptimization), \
+                    suppress(InterruptScipyMinimize):
+
+                try:
+                    minimize(
+                        self._objective,
+                        x0,
+                        args=(),
+                        method=self.method,
+                        bounds=self._get_scipy_bounds(),
+                        constraints=self._get_scipy_constraints(),
+                        tol=self.tol,
+                        callback=self._get_scipy_callback(),
+                        options=self.options,
+                    )
+                finally:
+                    self._time_start = None
+                    self._n_succeeded_trials_in_current_optimization = None

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyfemtet/opt/visualization/plotter/main_figure_creator.py

@@ -98,6 +98,12 @@ def get_hypervolume_plot(_: History, df: pd.DataFrame) -> go.Figure:
     # メインデータを抽出
     df = get_partial_df(df, equality_filters=MAIN_FILTER)
 
+    # 成功した試行のみを抽出
+    df = df[df['feasibility']]
+
+    # 番号を振り直し
+    df['trial'] = range(1, len(df) + 1)
+
     # create figure
     fig = px.line(
         df,

{pyfemtet-1.3.2 → pyfemtet-1.5.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "pyfemtet"
 dynamic = []
 description = "Design parameter optimization using Femtet."
 authors = [{ name = "pyfemtet", email = "148934231+pyfemtet@users.noreply.github.com" }]
-requires-python = ">= 3.10, < 3.14"
+requires-python = ">= 3.10, < 3.15"
 readme = "README.md"
 license = "MIT"
 dependencies = [
@@ -33,7 +33,7 @@ dependencies = [
 
 #[project.optional-dependencies]
 #brep = ["brepmatching>=0.1.8,<0.2"]
-version = "1.3.2"
+version = "1.5.0"
 
 [project.urls]
 Repository = "https://github.com/pyfemtet/pyfemtet"
@@ -56,6 +56,9 @@ dev = [
     "pytest-dashboard>=2.0.0",
     "pytest-cov>=6.1.1",
     "pytest-reporter-html-dots>=0.11.0",
+    "esbonio>=0.12.0",
+    "pandas-stubs>=2.3.2.250926",
+    "scipy-stubs>=1.15.3.0",
 ]
 
 [tool.uv-dynamic-versioning]