pyfemtet 0.8.8__tar.gz → 0.8.9__tar.gz

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyfemtet
-Version: 0.8.8
+Version: 0.8.9
 Summary: Design parameter optimization using Femtet.
 License: BSD-3-Clause
 Author: kazuma.naito

pyfemtet-0.8.9/pyfemtet/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.8.9"

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/pyfemtet/opt/_femopt.py

@@ -131,7 +131,7 @@ class FEMOpt:
         # メンバーの宣言
         self.client = None
         self.status = None  # actor
-        self.history = None  # actor
+        self.history: History = None
         self.worker_status_list = None  # [actor]
         self.monitor_process_future = None
         self.monitor_server_kwargs = dict()

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/pyfemtet/opt/_femopt_core.py

@@ -553,7 +553,7 @@ class History:
             hv_reference=None,
     ):
         # hypervolume 計算メソッド
-        self._hv_reference = hv_reference or 'dynamic-pareto'
+        self._hv_reference = 'dynamic-pareto' if hv_reference is None else hv_reference
 
         # 引数の処理
         self.path = history_path  # .csv
@@ -728,6 +728,14 @@ class History:
 
         return columns, meta_columns
 
+    def generate_hidden_infeasible_result(self):
+        y = np.full_like(np.zeros(len(self.obj_names)), np.nan)
+        c = np.full_like(np.zeros(len(self.cns_names)), np.nan)
+        return y, c
+
+    def is_hidden_infeasible_result(self, y):
+        return np.all(np.isnan(y))
+
     def record(
             self,
             parameters,
@@ -780,7 +788,7 @@ class History:
             feasible_list.append(is_feasible(cns_value, cns.lb, cns.ub))
 
         # feasibility
-        row.append(all(feasible_list))
+        row.append(all(feasible_list) and not self.is_hidden_infeasible_result(obj_values))
 
         # the others
         row.append(-1.)  # dummy hypervolume
@@ -892,7 +900,29 @@ class History:
                     ret.append(row)
             return np.array(ret).max(axis=0)
 
-        if self._hv_reference == 'dynamic-pareto':
+        if (
+                isinstance(self._hv_reference, np.ndarray)
+                or isinstance(self._hv_reference, list)
+        ):
+            _buff = np.array(self._hv_reference)
+            assert _buff.shape == (len(self.obj_names),)
+
+            ref_point = np.array(
+                [obj.convert(raw_value) for obj, raw_value in zip(objectives.values(), _buff)]
+            )
+
+            _buff = get_pareto(objective_values)
+
+            pareto_set = np.empty((0, len(objectives)))
+            for pareto_sol in _buff:
+                if all(pareto_sol < ref_point):
+                    pareto_set = np.concatenate([pareto_set, [pareto_sol]], axis=0)
+
+            hv = compute_hypervolume(pareto_set, ref_point)
+            df.loc[len(df) - 1, 'hypervolume'] = hv
+            return
+
+        elif self._hv_reference == 'dynamic-pareto':
             pareto_set, pareto_set_list = get_pareto(objective_values, with_partial=True)
             for i, partial_pareto_set in enumerate(pareto_set_list):
                 # 並列計算時など Valid な解がまだ一つもない場合は pareto_set が長さ 0 になる
@@ -943,28 +973,6 @@ class History:
                 df.loc[len(df) - 1, 'hypervolume'] = hv
             return
 
-        elif (
-                isinstance(self._hv_reference, np.ndarray)
-                or isinstance(self._hv_reference, list)
-        ):
-            _buff = np.array(self._hv_reference)
-            assert _buff.shape == (len(self.obj_names),)
-
-            ref_point = np.array(
-                [obj.convert(raw_value) for obj, raw_value in zip(objectives.values(), _buff)]
-            )
-
-            _buff = get_pareto(objective_values)
-
-            pareto_set = np.empty((0, len(objectives)))
-            for pareto_sol in _buff:
-                if all(pareto_sol < ref_point):
-                    pareto_set = np.concatenate([pareto_set, [pareto_sol]], axis=0)
-
-            hv = compute_hypervolume(pareto_set, ref_point)
-            df.loc[len(df) - 1, 'hypervolume'] = hv
-            return
-
         else:
             raise NotImplementedError(f'Invalid Hypervolume reference point calculation method: {self._hv_reference}')
 

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/pyfemtet/opt/_test_utils/record_history.py

@@ -92,6 +92,7 @@ def is_equal_result(ref_path, dif_path, log_path=None, threashold=0.05):
     assert len(ref_columns) == len(dif_columns), "結果 csv の column 数が異なります。"
     assert len(ref_df) == len(dif_df), "結果 csv の row 数が異なります。"
     assert difference <= threashold*100, f"前回の結果との平均差異が {int(difference)}% で {int(threashold*100)}% を超えています。"
+    print(f"OK! 前回の結果との平均差異が {int(difference)}% で {int(threashold*100)}% 以下です。")
 
 
 def _get_simplified_df_values(csv_path, exclude_columns=None):

pyfemtet-0.8.9/pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric_restart.py

@@ -0,0 +1,99 @@
+import os
+from time import sleep
+
+from optuna.samplers import RandomSampler, NSGAIISampler, GPSampler, BaseSampler
+
+from pyfemtet.opt import FEMOpt, FemtetInterface, OptunaOptimizer
+
+os.chdir(os.path.dirname(__file__))
+
+
+def get_res_freq(Femtet):
+    Galileo = Femtet.Gogh.Galileo
+    Galileo.Mode = 0
+    sleep(0.01)
+    return Galileo.GetFreq().Real
+
+
+def main(n_trials, sampler_class: type[BaseSampler], sampler_kwargs: dict):
+    """Main function
+
+    length
+    using different algorithms for each restarting.
+
+    So this main function requires n_trials and sampler_class.
+
+    Args:
+
+        n_trials (int):
+            How many additional succeeded trials
+            to terminate optimization.
+
+        sampler_class (type[optuna.samplers.BaseSampler]):
+            The algorithm we use.
+
+        sampler_kwargs (dict):
+            The arguments of sampler.
+
+    """
+
+
+    # Connect to Femtet.
+    fem = FemtetInterface(
+        femprj_path='gal_ex13_parametric.femprj',
+    )
+
+    # Initialize the optimization object.
+    opt = OptunaOptimizer(
+        sampler_class=sampler_class,
+        sampler_kwargs=sampler_kwargs,
+    )
+
+    # To restart, it is necessary to inform the new optimization program
+    # about the history of the previous optimization.
+    # By specifying a csv for the `history_path` argument of FEMOpt,
+    # if it does not exist, a new csv file will be created,
+    # and if it exists, optimization will continue from that csv file.
+    #
+    # Note:
+    #   When restarting, the number and names of variables,
+    #   as well as the number and names of objective functions
+    #   and constraints must be consistent.
+    #   However, you can change the bounds of variables,
+    #   direction of objective functions, and content of constraints.
+    #
+    # Note:
+    #   When using OptunaOptimizer, the .db file with the same name
+    #   (in this case restarting-sample.db) that is saved along with
+    #   csv is required to be  in the same folder as the csv file.
+    femopt = FEMOpt(
+        fem=fem,
+        opt=opt,
+        history_path='restarting-sample.csv'
+    )
+
+    # Set the design variables.
+    femopt.add_parameter('length', 0.1, 0.02, 0.2)
+    femopt.add_parameter('width', 0.01, 0.001, 0.02)
+    femopt.add_parameter('base_radius', 0.008, 0.006, 0.01)
+
+    # Set the objective function.
+    femopt.add_objective(fun=get_res_freq, name='First Resonant Frequency (Hz)', direction=800)
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=n_trials, confirm_before_exit=False)
+
+
+if __name__ == '__main__':
+    # First, we will perform 3 optimizations using the RandomSampler.
+    main(3, RandomSampler, {})
+
+    # Next, we will perform 3 optimizations using the NSGAIISampler.
+    main(3, NSGAIISampler, {})
+
+    # Finally, we will perform 3 optimizations using the GPSampler.
+    main(3, GPSampler, {'n_startup_trials': 0, 'deterministic_objective': True})
+
+    # After this program ends, you can continue further with
+    # restarting-sample.csv and the .db file.

pyfemtet-0.8.9/pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric_restart_jp.py

@@ -0,0 +1,102 @@
+import os
+from time import sleep
+
+from optuna.samplers import RandomSampler, NSGAIISampler, GPSampler, BaseSampler
+
+from pyfemtet.opt import FEMOpt, FemtetInterface, OptunaOptimizer
+
+os.chdir(os.path.dirname(__file__))
+
+
+def get_res_freq(Femtet):
+    Galileo = Femtet.Gogh.Galileo
+    Galileo.Mode = 0
+    sleep(0.01)
+    return Galileo.GetFreq().Real
+
+
+def main(n_trials, sampler_class: type[BaseSampler], sampler_kwargs: dict):
+    """メイン関数
+
+    このサンプルは最適化を途中で中断して続きから行う場合で、
+    各リスタートで異なるアルゴリズムを使用して
+    最適化を再開する方法を示しています。
+
+    このメイン関数は n_trials と sampler_class を与えると
+    その回数、アルゴリズムに応じて最適化を行います。
+
+    Args:
+
+        n_trials (int):
+            最適化を終了するために必要な追加の成功した試行回数。
+
+        sampler_class (type[optuna.samplers.BaseSampler]):
+            使用するアルゴリズム。
+        
+        sampler_kwargs (dict):
+            アルゴリズムの引数。
+
+    """
+
+
+    # Femtet に接続します。
+    fem = FemtetInterface(
+        femprj_path='gal_ex13_parametric.femprj',
+    )
+
+    # 最適化オブジェクトを初期化します。
+    opt = OptunaOptimizer(
+        sampler_class=sampler_class,
+        sampler_kwargs=sampler_kwargs,
+    )
+
+    # リスタートするためには以前の最適化の履歴を
+    # 新しい最適化プログラムに知らせる必要があります。
+    # FEMOpt の `history_path` 引数に csv を指定すると、
+    # それが存在しない場合、新しい csv ファイルを作り、
+    # それが存在する場合、その csv ファイルの続きから
+    # 最適化を実行します。
+    #
+    # 注意:
+    #   リスタートする場合、変数の数と名前、目的関数の数と
+    #   名前、および拘束関数の数と名前が一貫している必要が
+    #   あります。
+    #   ただし、変数の上下限や目的関数の方向、拘束関数の内容
+    #   などは変更できます。
+    #
+    # 注意:
+    #   OptunaOptimizer を使用する場合、csv と同名の
+    #   .db ファイル (ここでは restarting-sample.db) が
+    #   csv ファイルと同じフォルダにある必要があります。
+    femopt = FEMOpt(
+        fem=fem,
+        opt=opt,
+        history_path='restarting-sample.csv'
+    )
+
+    # 設計パラメータを指定します。
+    femopt.add_parameter('length', 0.1, 0.02, 0.2)
+    femopt.add_parameter('width', 0.01, 0.001, 0.02)
+    femopt.add_parameter('base_radius', 0.008, 0.006, 0.01)
+
+    # 目的関数を指定します。
+    femopt.add_objective(fun=get_res_freq, name='First Resonant Frequency (Hz)', direction=800)
+
+    # 最適化を実行します。
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=n_trials, confirm_before_exit=False)
+
+
+if __name__ == '__main__':
+    # 最初に、RandomSampler を使用して 3 回計算を行います。
+    main(3, RandomSampler, {})
+
+    # 次に、NSGAIISampler を使用して 3 回計算を行います。
+    main(3, NSGAIISampler, {})
+
+    #  最後に、GPSampler を使用して 3 回計算を行います。
+    main(3, GPSampler, {'n_startup_trials': 0, 'deterministic_objective': True})
+
+    # このプログラム終了後、
+    # restarting-sample.csv と同名の .db ファイルを用いて
+    # さらに続きの最適化を行うことができます。

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/pyfemtet/opt/interface/_femtet.py

@@ -201,6 +201,40 @@ class FemtetInterface(FEMInterface):
             **kwargs
         )
 
+    def use_parametric_output_as_objective(self, number: int, direction: str | float = 'minimize') -> None:
+        """Use output setting of Femtet parametric analysis as an objective function.
+
+        Args:
+            number (int): The index of output settings tab in parametric analysis dialog of Femtet. Starts at 1.
+            direction (str | float): Objective direction. Valid input is one of 'minimize', 'maximize' or a specific value. Defaults to 'minimize'.
+
+        Returns:
+            None
+
+        """
+        # check
+        if isinstance(direction, str):
+            if direction not in ('minimize', 'maximize'):
+                raise ValueError(f'direction must be one of "minimize", "maximize" or a specific value. Passed value is {direction}')
+        else:
+            try:
+                direction = float(direction)
+            except (TypeError, ValueError):
+                raise ValueError(f'direction must be one of "minimize", "maximize" or a specific value. Passed value is {direction}')
+
+        index = {number - 1: direction}
+
+        if self.parametric_output_indexes_use_as_objective is None:
+            self.parametric_output_indexes_use_as_objective = index
+
+        else:
+            self.parametric_output_indexes_use_as_objective.update(index)
+
+        # TODO: FEMInterface.__init__ の仕様を変えたらここも変える
+        self.kwargs['parametric_output_indexes_use_as_objective'] = self.parametric_output_indexes_use_as_objective
+
+
+
     def __del__(self):
         self.quit()
         # CoUninitialize()  # Win32 exception occurred releasing IUnknown at 0x0000022427692748
@@ -682,6 +716,14 @@ class FemtetInterface(FEMInterface):
 
         if self.parametric_output_indexes_use_as_objective is not None:
             from pyfemtet.opt.interface._femtet_parametric import solve_via_parametric_dll
+
+            pdt_path = self.Femtet.ResultFilePath + '.pdt'
+
+            # 前のものが残っているとややこしいので消しておく
+            if os.path.exists(pdt_path):
+                os.remove(pdt_path)
+
+            # parametric analysis 経由で解析
             self._call_femtet_api(
                 fun=solve_via_parametric_dll,
                 return_value_if_failed=False,
@@ -690,8 +732,23 @@ class FemtetInterface(FEMInterface):
                 is_Gaudi_method=True,
                 args=(self.Femtet,),
             )
+
+            # parametric analysis の場合
+            # ダイアログで「解析結果を保存する」に
+            # チェックがついていないと次にすべき
+            # OpenCurrentResult に失敗するので
+            # parametric の場合も pdt を保存する
+            self._call_femtet_api(
+                fun=self.Femtet.SavePDT,
+                args=(pdt_path, True),
+                return_value_if_failed=False,
+                if_error=SolveError,
+                error_message=Msg.ERR_FAILED_TO_SAVE_PDT,
+                is_Gaudi_method=False,
+            )
+
         else:
-            # # ソルブする
+            # ソルブする
             self._call_femtet_api(
                 self.Femtet.Solve,
                 False,

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/pyfemtet/opt/optimizer/_base.py

@@ -155,11 +155,6 @@ class AbstractOptimizer(ABC):
         """Setup before parallel processes are launched."""
         pass
 
-    def generate_infeasible_result(self):
-        y = np.full_like(np.zeros(len(self.objectives)), np.nan)
-        c = np.full_like(np.zeros(len(self.constraints)), np.nan)
-        return y, y, c
-
     # ===== calc =====
     def f(self, x: np.ndarray, _record_infeasible=False) -> list[np.ndarray]:
         """Calculate objectives and constraints.
@@ -208,7 +203,8 @@ class AbstractOptimizer(ABC):
             c = [cns.calc(self.fem) for cns in self.constraints.values()]
 
         else:
-            y, _y, c = self.generate_infeasible_result()
+            y, c = self.history.generate_hidden_infeasible_result()
+            _y = y
 
         # register to history
         df_to_opt = self.variables.get_variables(

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/pyfemtet/opt/optimizer/_optuna/_optuna.py

@@ -207,9 +207,9 @@ class OptunaOptimizer(AbstractOptimizer):
 
         # create storage
         self.study_name = 'pyfemtet-study'
-        storage_path = self.history.path.replace('.csv', '.db')  # history と同じところに保存
+        storage_path = os.path.splitext(self.history.path)[0] + '.db'  # history と同じところに保存
         if self.is_cluster:  # remote cluster なら scheduler の working dir に保存
-            storage_path = os.path.basename(self.history.path).replace('.csv', '.db')
+            storage_path = os.path.splitext(os.path.basename(self.history.path))[0] + '.db'
 
         # callback to terminate
         if self.n_trials is not None:

pyfemtet-0.8.9/pyfemtet/opt/samples/femprj_sample/gau_ex12_parametric.py

@@ -0,0 +1,52 @@
+"""Optimization using parametric analysis output settings as the objective function
+
+This demo shows how to use the values outputted by Femtet's parametric
+analysis output setting feature as the objective function for optimization.
+This feature allows you to perform optimization without coding the objective function.
+
+
+Note:
+
+    Please be aware of the following when using this feature.
+
+    - The sweep table from the parametric analysis will be deleted.
+    - Output settings that produce complex numbers or vectors will only use
+      the first value as the objective function. (For complex numbers, it will be
+      the real part, and for vector values, it will be components such as X.)
+
+
+Corresponding project: gau_ex12_parametric.femprj
+
+"""
+
+from pyfemtet.opt import FEMOpt, FemtetInterface
+
+
+if __name__ == '__main__':
+
+    # Initialize an object to connect to
+    # Femtet for referencing Femtet settings.
+    fem = FemtetInterface()
+
+    # Set the output settings of the parametric analysis as the objective function.
+    # `number` is the index from the `results output settings` tab of the
+    # Femtet parametric analysis dialog, and `direction` is
+    # the goal of that objective function (similar to FEMOpt.add_objective).
+
+    # Mutual inductance
+    fem.use_parametric_output_as_objective(number=1, direction=1.5e-7)
+
+    # Strength of magnetic field at the center of the coil
+    fem.use_parametric_output_as_objective(number=2, direction='minimize')
+
+    # Initialize optimization object.
+    # Pass in the previously initialized fem object.
+    femopt = FEMOpt(fem=fem)
+
+    #  Set parameters.
+    femopt.add_parameter('in_radius', 10, 5, 10)
+    femopt.add_parameter('out_radius', 20, 20, 25)
+
+    # Execute optimization.
+    femopt.set_random_seed(42)  # Fix random seed
+    femopt.optimize(n_trials=20)

pyfemtet-0.8.9/pyfemtet/opt/samples/femprj_sample_jp/gau_ex12_parametric_jp.py

@@ -0,0 +1,52 @@
+"""パラメトリック解析出力設定を目的関数とする最適化
+
+Femtet のパラメトリック解析の結果出力設定機能で出力される値を
+最適化の目的関数として使用する方法をデモします。
+この機能により、目的関数をコーディングすることなく
+最適化を実施できます。
+
+
+注意:
+
+    この機能を使う際は、以下のことに注意してください。
+
+    - パラメトリック解析のスイープテーブルが削除されます。
+    - 複素数やベクトルを出力する出力設定は、第一の値のみが
+      目的関数として使用されます。（複素数の場合は実数、
+      ベクトル値の場合は X 成分など）
+
+
+対応するプロジェクト: gau_ex12_parametric.femprj
+"""
+
+from pyfemtet.opt import FEMOpt, FemtetInterface
+
+
+if __name__ == '__main__':
+
+    # Femtet の設定を参照するため、Femtet と接続を
+    # 行うためのオブジェクトを初期化します。
+    fem = FemtetInterface()
+
+    # パラメトリック解析の結果出力設定を目的関数にします。
+    # number は Femtet パラメトリック解析ダイアログの
+    # 結果出力設定タブのテーブルの番号で、direction は
+    # その目的関数の目標です(FEMOpt.add_objective と同様)。
+
+    # 相互インダクタンス
+    fem.use_parametric_output_as_objective(number=1, direction=1.5e-7)
+
+    # コイル中央の磁界の強さ
+    fem.use_parametric_output_as_objective(number=2, direction='minimize')
+
+    # 最適化用オブジェクトを初期化します。
+    # さきほど初期化した fem を渡します。
+    femopt = FEMOpt(fem=fem)
+
+    # パラメータを設定します。
+    femopt.add_parameter('in_radius', 10, 5, 10)
+    femopt.add_parameter('out_radius', 20, 20, 25)
+
+    # 最適化を実行します。
+    femopt.set_random_seed(42)  # 乱数シードの固定
+    femopt.optimize(n_trials=20)

{pyfemtet-0.8.8 → pyfemtet-0.8.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyfemtet"
-version = "0.8.8"  # ignored by versioning plugin
+version = "0.8.9"  # ignored by versioning plugin
 description = "Design parameter optimization using Femtet."
 authors = ["kazuma.naito <kazuma.naito@murata.com>"]
 readme = "README.md"
@@ -15,7 +15,7 @@ tqdm = "^4.66.1"
 colorlog = "^6.8.0"
 psutil = "^5.9.6"
 # win32 / Femtet
-# markers equires ```poetry config installer.re-resolve false```
+# markers requires ```poetry config installer.re-resolve false```
 pywin32 = { version = "^306", markers = "sys_platform=='win32'" }
 femtetutils = { version = "^1.0.0", markers = "sys_platform=='win32'" }
 # distributed

pyfemtet-0.8.8/pyfemtet/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.8.8"