PyFemtet 1.4.0__tar.gz → 1.5.1__tar.gz

{pyfemtet-1.4.0 → pyfemtet-1.5.1}/PKG-INFO

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

{pyfemtet-1.4.0 → pyfemtet-1.5.1}/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.4.0 → pyfemtet-1.5.1}/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.4.0 → pyfemtet-1.5.1}/pyfemtet/opt/history/__init__.py

@@ -8,4 +8,5 @@ __all__ = [
     'create_err_msg_from_exception',
     'CorrespondingColumnNameRuler',
     'MAIN_FILTER',
+    'get_trial_name',
 ]

{pyfemtet-1.4.0 → pyfemtet-1.5.1}/pyfemtet/opt/history/_history.py

@@ -41,6 +41,7 @@ __all__ = [
     'create_err_msg_from_exception',
     'CorrespondingColumnNameRuler',
     'MAIN_FILTER',
+    'get_trial_name'
 ]
 
 MAIN_FILTER: dict = {
@@ -50,7 +51,32 @@ MAIN_FILTER: dict = {
 
 
 logger = get_module_logger('opt.history', False)
-logger_dask = get_module_logger('opt.dask', False)
+logger_dask = get_module_logger("opt.dask", False)
+
+
+def get_trial_name(trial=None, fidelity=None, sub_sampling=None, row: pd.Series = None):
+    if row is not None:
+        assert not math.isnan(row["trial"])
+        trial = row["trial"]
+        fidelity = row["fidelity"] if not math.isnan(row["fidelity"]) else None
+        sub_sampling = (
+            row["sub_sampling"] if not math.isnan(row["sub_sampling"]) else None
+        )
+
+    name_parts = ["trial"]
+    if fidelity is not None:
+        fid = str(fidelity)
+        if fid != MAIN_FIDELITY_NAME:
+            name_parts.append(fid)
+
+    name_parts.append(str(trial))
+
+    if sub_sampling is not None:
+        name_parts.append(str(sub_sampling))
+
+    trial_name = '_'.join(name_parts)
+
+    return trial_name
 
 
 def _assert_locked_with_timeout(lock, assertion_message=None, timeout=10.):
@@ -1315,26 +1341,7 @@ class History:
 
     @staticmethod
     def get_trial_name(trial=None, fidelity=None, sub_sampling=None, row: pd.Series = None):
-        if row is not None:
-            assert not math.isnan(row['trial'])
-            trial = row['trial']
-            fidelity = row['fidelity'] if not math.isnan(row['fidelity']) else None
-            sub_sampling = row['sub_sampling'] if not math.isnan(row['sub_sampling']) else None
-
-        name_parts = ['trial']
-        if fidelity is not None:
-            fid = str(fidelity)
-            if fid != MAIN_FIDELITY_NAME:
-                name_parts.append(fid)
-
-        name_parts.append(str(trial))
-
-        if sub_sampling is not None:
-            name_parts.append(str(sub_sampling))
-
-        trial_name = '_'.join(name_parts)
-
-        return trial_name
+        return get_trial_name(trial, fidelity, sub_sampling, row)
 
     def recording(self, fem: AbstractFEMInterface):
         """:meta private:"""

{pyfemtet-1.4.0 → pyfemtet-1.5.1}/pyfemtet/opt/interface/_femtet_interface/femtet_interface.py

@@ -34,6 +34,7 @@ from pyfemtet.dispatch_extensions import *
 from pyfemtet.opt.interface._base_interface import COMInterface
 from pyfemtet.opt.exceptions import *
 from pyfemtet.opt.problem.problem import *
+from pyfemtet.opt.history import get_trial_name
 
 from ._femtet_parametric import *
 
@@ -1111,9 +1112,9 @@ class FemtetInterface(COMInterface):
         if save_results.lower() == 'optimal':
             for i, row in df.iterrows():
                 if not bool(row['optimality']):
-                    trial_to_remove = int(row['trial'])
+                    trial_name_to_remove = get_trial_name(row=row)
                     pdt_path_to_remove = FemtetInterface._create_path(
-                        original_femprj_path, model_name, trial_to_remove, ext='pdt')
+                        original_femprj_path, model_name, trial_name_to_remove, ext='pdt')
                     if os.path.isfile(pdt_path_to_remove):
                         os.remove(pdt_path_to_remove)
 

{pyfemtet-1.4.0 → pyfemtet-1.5.1}/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,

{pyfemtet-1.4.0 → pyfemtet-1.5.1}/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.4.0 → pyfemtet-1.5.1}/pyproject.toml

@@ -33,7 +33,7 @@ dependencies = [
 
 #[project.optional-dependencies]
 #brep = ["brepmatching>=0.1.8,<0.2"]
-version = "1.4.0"
+version = "1.5.1"
 
 [project.urls]
 Repository = "https://github.com/pyfemtet/pyfemtet"
@@ -57,6 +57,8 @@ dev = [
     "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]