pyfemtet 0.6.1__py3-none-any.whl → 0.6.3__py3-none-any.whl

pyfemtet/_warning.py

@@ -3,15 +3,57 @@ from functools import wraps
 
 
 def experimental_feature(func):
+
     @wraps(func)
     def wrapper(*args, **kwargs):
-        warnings.warn(f"The function '{func.__name__}' is experimental and may change in the future.", 
-                      category=UserWarning, 
-                      stacklevel=2)
+        warnings.warn(
+            f"The function '{func.__name__}' is experimental and may change in the future.",
+            category=UserWarning,
+            stacklevel=2
+        )
         return func(*args, **kwargs)
+
     return wrapper
 
 
+def experimental_class(cls):
+
+    class Wrapper(cls):
+        def __new__(cls, *args, **kwargs):
+            warnings.warn(
+                f"The class '{cls.__name__}' is experimental and may change in the future.",
+                category=UserWarning,
+                stacklevel=2
+            )
+            return super().__new__(cls)
+
+    Wrapper.__name__ = cls.__name__
+    Wrapper.__doc__ = cls.__doc__
+    return Wrapper
+
+
+def changed_feature(version, additional_message=None):
+
+    def changed_feature_wrapper(func):
+
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+
+            version_string = f'in version {version}' if version is not None else 'in recent update'
+            additional_message_string = ' ' + additional_message if additional_message is not None else ''
+
+            warnings.warn(
+                f"The behavior of function '{func.__name__}' is changed {version_string}." + additional_message_string,
+                category=UserWarning,
+                stacklevel=2
+            )
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return changed_feature_wrapper
+
+
 if __name__ == '__main__':
 
     # 使用例
@@ -19,5 +61,19 @@ if __name__ == '__main__':
     def my_experimental_function():
         print("This is an experimental function.")
 
+    class Sample:
+        @experimental_feature
+        def add(self, a, b):
+            return a + b
+
     # 実行すると、警告が表示されます。
     my_experimental_function()
+    sample = Sample()
+    print(sample.add(1, 2))
+
+
+    @changed_feature('0.1.0', 'See documentation of `Optimizer` for more details.')
+    def product(a, b):
+        return a * b
+
+    print(product(1, 2))

pyfemtet/opt/_femopt.py

@@ -1,7 +1,7 @@
 # built-in
 import inspect
 import warnings
-from typing import Optional, Any, Callable, List
+from typing import Optional, Any, Callable, List, Sequence, SupportsFloat
 import os
 import datetime
 from time import time, sleep
@@ -365,10 +365,10 @@ class FEMOpt:
 
     def add_objectives(
             self,
-            fun: Callable[[Any], "Sequence"["SupportsFloat"]],
+            fun: Callable[[Any], Sequence[SupportsFloat]],
             n_return: int,
-            names: str or "Sequence"[str] or None = None,
-            directions: str or "Sequence"[str] or None = None,
+            names: str or Sequence[str] or None = None,
+            directions: str or Sequence[str] or None = None,
             args: tuple or None = None,
             kwargs: dict or None = None,
     ):
@@ -601,6 +601,25 @@ class FEMOpt:
 
         """
 
+        # ===== opt の設定 =====
+
+        # Interface から設定を読む場合の処理
+        # 設定ファイルから設定を読む場合は最適化問題が
+        # この時点で不定なので actor 等の設定をする前に
+        # ここで確定する必要がある。
+        if hasattr(self.fem, '_load_problem_from_me'):
+            if self.fem._load_problem_from_me:
+                self.fem.load_parameter(self.opt)
+                self.fem.load_objective(self.opt)
+
+        # resolve expression dependencies
+        self.opt.variables.resolve()
+        self.opt.variables.evaluate()
+
+        # opt の共通引数
+        self.opt.n_trials = n_trials
+        self.opt.timeout = timeout
+
         # method checker
         if n_parallel > 1:
             self.opt.method_checker.check_parallel()
@@ -630,13 +649,37 @@ class FEMOpt:
         if is_incomplete_bounds:
             self.opt.method_checker.check_incomplete_bounds()
 
-        # 共通引数
-        self.opt.n_trials = n_trials
-        self.opt.timeout = timeout
 
-        # resolve expression dependencies
-        self.opt.variables.resolve()
-        self.opt.variables.evaluate()
+        # ===== fem の設定 ==--=
+
+        # Femtet 特有の処理
+        metadata = None
+        if isinstance(self.fem, FemtetInterface):
+
+            # 結果 csv に記載する femprj に関する情報の作成
+            metadata = json.dumps(
+                dict(
+                    femprj_path=self.fem.original_femprj_path,
+                    model_name=self.fem.model_name
+                )
+            )
+
+            # Femtet の parametric 設定を目的関数に用いるかどうか
+            if self.fem.parametric_output_indexes_use_as_objective is not None:
+                from pyfemtet.opt.interface._femtet_parametric import add_parametric_results_as_objectives
+                indexes = list(self.fem.parametric_output_indexes_use_as_objective.keys())
+                directions = list(self.fem.parametric_output_indexes_use_as_objective.values())
+                add_parametric_results_as_objectives(
+                    self,
+                    indexes,
+                    directions,
+                )
+
+            # Femtet の confirm_before_exit のセット
+            self.fem.confirm_before_exit = confirm_before_exit
+            self.fem.kwargs['confirm_before_exit'] = confirm_before_exit
+
+            logger.info('Femtet loaded successfully.')
 
         # クラスターの設定
         self.opt.is_cluster = self.scheduler_address is not None
@@ -696,35 +739,6 @@ class FEMOpt:
 
         with self.client.cluster as _cluster, self.client as _client:
 
-            # Femtet 特有の処理
-            metadata = None
-            if isinstance(self.fem, FemtetInterface):
-                # 結果 csv に記載する femprj に関する情報
-                metadata = json.dumps(
-                    dict(
-                        femprj_path=self.fem.original_femprj_path,
-                        model_name=self.fem.model_name
-                    )
-                )
-
-                # Femtet の parametric 設定を目的関数に用いるかどうか
-                if self.fem.parametric_output_indexes_use_as_objective is not None:
-                    from pyfemtet.opt.interface._femtet_parametric import add_parametric_results_as_objectives
-                    indexes = list(self.fem.parametric_output_indexes_use_as_objective.keys())
-                    directions = list(self.fem.parametric_output_indexes_use_as_objective.values())
-                    add_parametric_results_as_objectives(
-                        self,
-                        indexes,
-                        directions,
-                    )
-
-                # Femtet の confirm_before_exit のセット
-                self.fem.confirm_before_exit = confirm_before_exit
-                self.fem.kwargs['confirm_before_exit'] = confirm_before_exit
-
-                logger.info('Femtet loaded successfully.')
-
-
             # actor の設定
             self.status = OptimizationStatus(_client)
             self.worker_status_list = [OptimizationStatus(_client, name) for name in worker_addresses]  # tqdm 検討
@@ -759,6 +773,7 @@ class FEMOpt:
             logger.info('Process monitor initialized successfully.')
 
             # fem
+            # TODO: n_parallel=1 のときもアップロードしている。これを使うべきか、アップロードしないべき。
             self.fem._setup_before_parallel(_client)
 
             # opt
@@ -768,6 +783,9 @@ class FEMOpt:
             self.opt.history = self.history
             self.opt._setup_before_parallel()
 
+            buff = self.opt.fem
+            del self.opt.fem
+
             # クラスターでの計算開始
             self.status.set(OptimizationStatus.LAUNCHING_FEM)
             start = time()
@@ -780,15 +798,17 @@ class FEMOpt:
                 allow_other_workers=False,
             )
 
+            self.opt.fem = buff
+
             t_main = None
             if not self.opt.is_cluster:
-                # ローカルプロセスでの計算(opt._main 相当の処理)
+                # ローカルプロセスでの計算(opt._run 相当の処理)
                 subprocess_idx = 0
 
                 # set_fem
                 self.opt.fem = self.fem
-                self.opt._reconstruct_fem(skip_reconstruct=True)
 
+                # fem の _setup_after_parallel はこの場合も呼ばれる
                 t_main = Thread(
                     target=self.opt._run,
                     args=(
@@ -797,7 +817,7 @@ class FEMOpt:
                         wait_setup,
                     ),
                     kwargs=dict(
-                        skip_set_fem=True,
+                        skip_reconstruct=True,
                     )
                 )
                 t_main.start()

pyfemtet/opt/_test_utils/record_history.py

@@ -10,6 +10,21 @@ from pyfemtet.opt import FEMOpt
 from pyfemtet._message import encoding as ENCODING
 
 
+def remove_femprj_metadata_from_csv(csv_path, encoding=ENCODING):
+
+    with open(csv_path, mode="r", encoding=encoding, newline="\n") as f:
+        reader = csv.reader(f, delimiter=",")
+        data = [line for line in reader]
+
+    new_meta_data = data[0]
+    new_meta_data[0] = ""
+    data[0] = new_meta_data
+
+    with open(csv_path, mode="w", encoding=encoding, newline="\n") as f:
+        writer = csv.writer(f, delimiter=',')
+        writer.writerows(data)
+
+
 def find_latest_csv(dir_path=None):
     if dir_path is None:
         dir_path = ""
@@ -70,3 +85,38 @@ def is_equal_result(ref_path, dif_path, log_path):
     assert len(ref_columns) == len(dif_columns), "結果 csv の column 数が異なります。"
     assert len(ref_df) == len(dif_df), "結果 csv の row 数が異なります。"
     assert difference <= 0.05, "前回の結果との平均差異が 5% を超えています。"
+
+
+def _get_simplified_df_values(csv_path, exclude_columns=None):
+    exclude_columns = exclude_columns if exclude_columns is not None else []
+
+    with open(csv_path, 'r', encoding='cp932') as f:
+        meta_header = f.readline()
+    meta_header = 'removed' + meta_header.split('}"')[-1]
+    meta_header = meta_header.split(',')
+
+    df = pd.read_csv(csv_path, encoding='cp932', header=2)
+
+    prm_names = []
+    for meta_data, col in zip(meta_header, df.columns):
+        if meta_data == 'prm':
+            if col not in exclude_columns:
+                prm_names.append(col)
+
+    obj_names = []
+    for meta_data, col in zip(meta_header, df.columns):
+        if meta_data == 'obj':
+            if col not in exclude_columns:
+                obj_names.append(col)
+
+    pdf = pd.DataFrame()
+
+    for col in prm_names:
+        pdf[col] = df[col]
+
+    for col in obj_names:
+        pdf[col] = df[col]
+
+    return pdf.values.astype(float)
+
+

pyfemtet/opt/interface/_base.py

@@ -51,6 +51,12 @@ class FEMInterface(ABC):
         """
         pass
 
+    def load_parameter(self, opt) -> None:  # opt: AbstractOptimizer
+        raise NotImplementedError()
+
+    def load_objective(self, opt) -> None:  # opt: AbstractOptimizer
+        raise NotImplementedError()
+
     def _setup_before_parallel(self, client) -> None:
         """Preprocessing before launching a dask worker (if implemented in concrete class).
 
@@ -64,7 +70,7 @@ class FEMInterface(ABC):
         """
         pass
 
-    def _setup_after_parallel(self):
+    def _setup_after_parallel(self, *args, **kwargs):
         """Preprocessing after launching a dask worker and before run optimization (if implemented in concrete class)."""
         pass
 
@@ -74,6 +80,9 @@ class FEMInterface(ABC):
     def _create_postprocess_args(self):
         pass
 
+    def quit(self):
+        pass
+
 
 class NoFEM(FEMInterface):
     """Dummy interface without FEM. Intended for debugging purposes."""