pyfemtet 0.5.3__py3-none-any.whl → 0.6.0__py3-none-any.whl

pyfemtet/opt/_femopt_core.py

@@ -29,7 +29,7 @@ from win32com.client import constants, Constants
 
 # pyfemtet relative
 from pyfemtet.opt.interface import FEMInterface, FemtetInterface
-from pyfemtet.message import encoding, Msg
+from pyfemtet._message import encoding, Msg
 
 # logger
 import logging
@@ -453,18 +453,12 @@ class History:
         cns_names (List[str], optional): The names of constraints. Defaults to None.
         client (dask.distributed.Client): Dask client.
         additional_metadata (str, optional): metadata of optimization process.
-
-    Raises:
-        FileNotFoundError: If the csv file is not found.
-
-    Attributes:
-        HEADER_ROW (int): Header row number of csv file. Must be grater than 0. Default to 2.
-        ENCODING (str): Encoding of csv file. Default to 'cp932'.
-        prm_names (str): User defined names of parameters.
-        obj_names (str): User defined names of objectives.
-        cns_names (str): User defined names of constraints.
-        is_restart (bool): If the optimization process is a continuation of another process or not.
-        is_processing (bool): The optimization is running or not.
+        hv_reference (str or list[float or np.ndarray, optional):
+            The method to calculate hypervolume or
+            the reference point itself.
+            Valid values are 'dynamic-pareto' or
+            'dynamic-nadir' or 'nadir' or 'pareto'
+            or fixed point (in objective function space).
 
     """
 
@@ -487,7 +481,10 @@ class History:
             cns_names=None,
             client=None,
             additional_metadata=None,
+            hv_reference=None,
     ):
+        # hypervolume 計算メソッド
+        self._hv_reference = hv_reference or 'dynamic-pareto'
 
         # 引数の処理
         self.path = history_path  # .csv
@@ -715,76 +712,122 @@ class History:
 
     def _calc_non_domi(self, objectives, df):
 
+        # feasible のもののみ取り出してくる
+        idx = df['feasible'].values
+        pdf = df[idx]
+
         # 目的関数の履歴を取り出してくる
-        solution_set = df[self.obj_names]
+        solution_set = pdf[self.obj_names]
 
         # 最小化問題の座標空間に変換する
         for obj_column, (_, objective) in zip(self.obj_names, objectives.items()):
             solution_set.loc[:, obj_column] = solution_set[obj_column].map(objective.convert)
 
         # 非劣解の計算
-        non_domi = []
+        non_domi: list[bool] = []
         for i, row in solution_set.iterrows():
             non_domi.append((row > solution_set).product(axis=1).sum(axis=0) == 0)
 
-        # 非劣解の登録
-        df['non_domi'] = non_domi
+        # feasible も infeasible も一旦劣解にする
+        df['non_domi'] = False
+
+        # feasible のものに non_domi の評価結果を代入する
+        df.loc[idx, 'non_domi'] = non_domi
 
     def _calc_hypervolume(self, objectives, df):
 
-        # filter non-dominated and feasible solutions
-        idx = df['non_domi'].values
-        idx = idx * df['feasible'].values  # *= を使うと non_domi 列の値が変わる
-        pdf = df[idx]
-        pareto_set = pdf[self.obj_names].values
-        n = len(pareto_set)  # 集合の要素数
-        m = len(pareto_set.T)  # 目的変数数
-        # 多目的でないと計算できない
-        if m <= 1:
-            return None
-        # 長さが 2 以上でないと計算できない
-        if n <= 1:
-            return None
-        # 最小化問題に convert
-        for i, (_, objective) in enumerate(objectives.items()):
-            for j in range(n):
-                pareto_set[j, i] = objective.convert(pareto_set[j, i])
-                #### reference point の計算[1]
-        # 逆正規化のための範囲計算
-        maximum = pareto_set.max(axis=0)
-        minimum = pareto_set.min(axis=0)
-
-        r = 1.01
-
-        # r を逆正規化
-        reference_point = r * (maximum - minimum) + minimum
-
-        #### hv 履歴の計算
-        hvs = []
-        for i in range(n):
-            hv = compute_hypervolume(pareto_set[:i], reference_point)
-            if np.isnan(hv):
-                hv = 0
-            hvs.append(hv)
-
-        # 計算結果を履歴の一部に割り当て
-        # idx: [False, True, False, True, True, False, ...]
-        # hvs: [          1,           2,    3,        ...]
-        # want:[   0,     1,     1,    2,    3,     3, ...]
-        hvs_index = -1
-        for i in range(len(df)):
-
-            # process hvs index
-            if idx[i]:
-                hvs_index += 1
-
-            # get hv
-            if hvs_index < 0:
-                hypervolume = 0.
+        if len(objectives) < 2:
+            df.loc[len(df) - 1, 'hypervolume'] = 0.
+            return
+
+        # 最小化問題に変換された objective values を取得
+        raw_objective_values = df[self.obj_names].values
+        objective_values = np.empty_like(raw_objective_values)
+        for n_trial in range(len(raw_objective_values)):
+            for obj_idx, (_, objective) in enumerate(objectives.items()):
+                objective_values[n_trial, obj_idx] = objective.convert(raw_objective_values[n_trial, obj_idx])
+
+        # pareto front を取得
+        def get_pareto(objective_values_, with_partial=False):
+            ret = None
+            if with_partial:
+                ret = []
+
+            pareto_set_ = np.empty((0, len(self.obj_names)))
+            for i in range(len(objective_values_)):
+                target = objective_values_[i]
+                dominated = False
+                # TODO: Array の計算に直して高速化する
+                for j in range(len(objective_values_)):
+                    compare = objective_values_[j]
+                    if all(target > compare):
+                        dominated = True
+                        break
+                if not dominated:
+                    pareto_set_ = np.concatenate([pareto_set_, [target]], axis=0)
+
+                if ret is not None:
+                    ret.append(np.array(pareto_set_))
+
+            if ret is not None:
+                return pareto_set_, ret
             else:
-                hypervolume = hvs[hvs_index]
+                return pareto_set_
+
+        if 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):
+                ref_point = pareto_set.max(axis=0) + 1e-8
+                hv = compute_hypervolume(partial_pareto_set, ref_point)
+                df.loc[i, 'hypervolume'] = hv
+            return
+
+        elif self._hv_reference == 'dynamic-nadir':
+            _, pareto_set_list = get_pareto(objective_values, with_partial=True)
+            for i, partial_pareto_set in enumerate(pareto_set_list):
+                ref_point = objective_values.max(axis=0) + 1e-8
+                hv = compute_hypervolume(partial_pareto_set, ref_point)
+                df.loc[i, 'hypervolume'] = hv
+            return
+
+        elif self._hv_reference == 'nadir':
+            pareto_set = get_pareto(objective_values)
+            ref_point = objective_values.max(axis=0) + 1e-8
+            hv = compute_hypervolume(pareto_set, ref_point)
+            df.loc[len(df) - 1, 'hypervolume'] = hv
+            return
+
+        elif self._hv_reference == 'pareto':
+            pareto_set = get_pareto(objective_values)
+            ref_point = pareto_set.max(axis=0) + 1e-8
+            hv = compute_hypervolume(pareto_set, ref_point)
+            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)
 
-            df.loc[i, 'hypervolume'] = hypervolume
+            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}')
 
     def save(self, _f=None):
         """Save csv file."""

pyfemtet/opt/_test_utils/record_history.py

@@ -7,7 +7,7 @@ import numpy as np
 import pandas as pd
 
 from pyfemtet.opt import FEMOpt
-from pyfemtet.message import encoding as ENCODING
+from pyfemtet._message import encoding as ENCODING
 
 
 def find_latest_csv(dir_path=None):

pyfemtet/opt/interface/__init__.py

@@ -11,5 +11,4 @@ __all__ = [
     'FemtetInterface',
     'FemtetWithNXInterface',
     'FemtetWithSolidworksInterface',
-    'logger',
 ]

pyfemtet/opt/interface/_base.py

@@ -68,15 +68,15 @@ class FEMInterface(ABC):
         """Preprocessing after launching a dask worker and before run optimization (if implemented in concrete class)."""
         pass
 
-    def postprocess_func(self, trial: int, *args, dask_scheduler=None, **kwargs):
+    def _postprocess_func(self, trial: int, *args, dask_scheduler=None, **kwargs):
         pass
 
-    def create_postprocess_args(self):
+    def _create_postprocess_args(self):
         pass
 
 
 class NoFEM(FEMInterface):
-    """Interface with no FEM for debug."""
+    """Dummy interface without FEM. Intended for debugging purposes."""
 
     def update(self, parameters: pd.DataFrame) -> None:
         pass

pyfemtet/opt/interface/_femtet.py

@@ -34,47 +34,80 @@ from pyfemtet.dispatch_extensions import (
     DispatchExtensionException,
 )
 from pyfemtet.opt.interface import FEMInterface, logger
-from pyfemtet.message import Msg
+from pyfemtet._message import Msg
 
 
-def post_activate_message(hwnd):
+def _post_activate_message(hwnd):
     win32gui.PostMessage(hwnd, win32con.WM_ACTIVATE, win32con.WA_ACTIVE, 0)
 
 
 class FemtetInterface(FEMInterface):
-    """Concrete class for the interface with Femtet.
+    """Control Femtet from optimizer.
 
-        Args:
-            femprj_path (str or None, optional): The path to the .femprj file. Defaults to None.
-            model_name (str or None, optional): The name of the analysis model. Defaults to None.
-            connect_method (str, optional): The connection method to use. Can be 'new', 'existing', or 'auto'. Defaults to 'auto'.
-            strictly_pid_specify (bool, optional): If True and connect_method=='new', search launched Femtet process strictly based on its process id.
-            allow_without_project (bool, optional): Allow to launch Femtet with no project file. Default to False.
-            open_result_with_gui (bool, optional): Open analysis result with Femtet GUI. Default to True.
-            parametric_output_indexes_use_as_objective (dict, optional): Parametric output indexes and their directions which will be used as objective functions. Parametric output should be set on Femtet parametric analysis dialog. Note that output 'No.' in dialog is starts with 1, but this 'index' is starts with 0. The key is the 'index', the value is direction ('maximize', 'minimize' or float). Default to None.
-
-        Warning:
-            Even if you specify ``strictly_pid_specify=True`` on the constructor,
-            **the connection behavior is like** ``strictly_pid_specify=False`` **in parallel processing**
-            because of its large overhead.
-            So you should close all Femtet processes before running FEMOpt.optimize()
-            if ``n_parallel`` >= 2.
-
-        Tip:
-            If you search for information about the method to connect python and Femtet, see :func:`connect_femtet`.
+    Args:
+        femprj_path (str, optional):
+            The path to the project file.
+            If not specified, get it from connected Femtet.
+
+        model_name (str, optional):
+            The name of the model.
+            If not specified, get it from connected Femtet or the
+            first model when Femtet open the project file.
+
+        connect_method (str, optional):
+            The connection method.
+            Default is 'auto'. Other valid values are 'new' or 'existing'.
+
+        save_pdt (str, optional):
+            The type to save result file.
+            Can specify 'all' or None. Default is 'all'.
+
+        strictly_pid_specify (bool, optional):
+            Whether to strictly specify the PID in Femtet connection.
+            Default is True.
+
+        allow_without_project (bool, optional):
+            Whether to allow without a project. Default is False.
+
+        open_result_with_gui (bool, optional):
+            Whether to open the result with GUI. Default is True.
+
+        parametric_output_indexes_use_as_objective (dict[int, str or float], optional):
+            A list of parametric output indexes and its direction
+            to use as the objective function. If not specified,
+            it will be None and no parametric outputs are used
+            as objectives.
+
+        confirm_before_exit (bool):
+            Whether to confirm before (abnormal) termination.
+            Default is True.
+
+        **kwargs: Additional arguments from inherited classes.
+
+    Warning:
+        Even if you specify ``strictly_pid_specify=True`` on the constructor,
+        **the connection behavior is like** ``strictly_pid_specify=False`` **in parallel processing**
+        because of its large overhead.
+        So you should close all Femtet processes before running FEMOpt.optimize()
+        if ``n_parallel`` >= 2.
+
+    Tip:
+        If you search for information about the method to
+        connect python and Femtet, see :func:`connect_femtet`.
 
     """
 
     def __init__(
             self,
-            femprj_path=None,
-            model_name=None,
-            connect_method='auto',  # dask worker では __init__ の中で 'new' にするので super() の引数にしない。（しても意味がない）
-            save_pdt='all',  # 'all' or None
-            strictly_pid_specify=True,  # dask worker では True にしたいので super() の引数にしない。
-            allow_without_project=False,  # main でのみ True を許容したいので super() の引数にしない。
-            open_result_with_gui=True,
-            parametric_output_indexes_use_as_objective=None,
+            femprj_path: str = None,
+            model_name: str = None,
+            connect_method: str = 'auto',  # dask worker では __init__ の中で 'new' にするので super() の引数にしない。（しても意味がない）
+            save_pdt: str = 'all',  # 'all' or None
+            strictly_pid_specify: bool = True,  # dask worker では True にしたいので super() の引数にしない。
+            allow_without_project: bool = False,  # main でのみ True を許容したいので super() の引数にしない。
+            open_result_with_gui: bool = True,
+            parametric_output_indexes_use_as_objective: dict[int, str or float] = None,
+            confirm_before_exit: bool = True,
             **kwargs  # 継承されたクラスからの引数
     ):
 
@@ -102,8 +135,9 @@ class FemtetInterface(FEMInterface):
         self.max_api_retry = 3
         self.strictly_pid_specify = strictly_pid_specify
         self.parametric_output_indexes_use_as_objective = parametric_output_indexes_use_as_objective
-        self._original_autosave_enabled = get_autosave_enabled()
-        set_autosave_enabled(False)
+        self._original_autosave_enabled = _get_autosave_enabled()
+        _set_autosave_enabled(False)
+        self.confirm_before_exit = confirm_before_exit
 
         # dask サブプロセスのときは femprj を更新し connect_method を new にする
         try:
@@ -141,11 +175,12 @@ class FemtetInterface(FEMInterface):
             open_result_with_gui=self.open_result_with_gui,
             parametric_output_indexes_use_as_objective=self.parametric_output_indexes_use_as_objective,
             save_pdt=self.save_pdt,
+            confirm_before_exit=self.confirm_before_exit,
             **kwargs
         )
 
     def __del__(self):
-        set_autosave_enabled(self._original_autosave_enabled)
+        _set_autosave_enabled(self._original_autosave_enabled)
         if self.quit_when_destruct:
             self.quit()
         # CoUninitialize()  # Win32 exception occurred releasing IUnknown at 0x0000022427692748
@@ -170,12 +205,12 @@ class FemtetInterface(FEMInterface):
         """Connects to a Femtet process.
 
         Args:
-            connect_method (str, optional): The connection method. Can be 'new', 'existing', or 'auto'. Defaults to 'new'.
+            connect_method (str, optional): The connection method. Can be 'new', 'existing', or 'auto'. Defaults to 'auto'.
             pid (int or None, optional): The process ID of an existing Femtet process and wanted to connect.
 
         Note:
             When connect_method is 'new', starts a new Femtet process and connects to it.
-            **`pid` will be ignored.**
+            `pid` will be ignored.
 
         Note:
             When 'existing', connect to an existing Femtet process.
@@ -213,7 +248,8 @@ class FemtetInterface(FEMInterface):
             print('================')
             print(message)
             print('================')
-            input('Press enter to finish...')
+            if self.confirm_before_exit:
+                input('Press enter to finish...')
             raise RuntimeError(message)
 
         if self.Femtet is None:
@@ -338,11 +374,11 @@ class FemtetInterface(FEMInterface):
             # さらに、プロジェクトツリーが開いていないとアクティブ化イベントも意味がないらしい。
             if fun.__name__ == 'ReExecute':
                 if self.open_result_with_gui or self.parametric_output_indexes_use_as_objective:
-                    post_activate_message(self.Femtet.hWnd)
+                    _post_activate_message(self.Femtet.hWnd)
                 # API を実行
                 returns = fun(*args, **kwargs)  # can raise pywintypes.error
                 if self.open_result_with_gui or self.parametric_output_indexes_use_as_objective:
-                    post_activate_message(self.Femtet.hWnd)
+                    _post_activate_message(self.Femtet.hWnd)
             else:
                 returns = fun(*args, **kwargs)
 
@@ -504,7 +540,8 @@ class FemtetInterface(FEMInterface):
                 logger.error(Msg.ERR_CANNOT_ACCESS_API + 'GetVariableNames_py')
                 logger.error(Msg.CERTIFY_MACRO_VERSION)
                 print('================')
-                input(Msg.ENTER_TO_QUIT)
+                if self.confirm_before_exit:
+                    input(Msg.ENTER_TO_QUIT)
                 raise e
                 
             if variable_names is not None:
@@ -515,7 +552,8 @@ class FemtetInterface(FEMInterface):
             logger.error(message)
             logger.error(f'`{param_name}` not in {variable_names}')
             print('================')
-            input(Msg.ENTER_TO_QUIT)
+            if self.confirm_before_exit:
+                input(Msg.ENTER_TO_QUIT)
             raise RuntimeError(message)
         else:
             return None
@@ -670,9 +708,25 @@ class FemtetInterface(FEMInterface):
         self.postprocess(self.Femtet)
 
     def preprocess(self, Femtet):
+        """A method called just before :func:`solve`.
+
+        This method is called just before solve.
+        By inheriting from the Interface class
+        and overriding this method, it is possible
+        to perform any desired preprocessing after
+        the model update and before solving.
+        """
         pass
 
     def postprocess(self, Femtet):
+        """A method called just after :func:`solve`.
+
+        This method is called just after solve.
+        By inheriting from the Interface class
+        and overriding this method, it is possible
+        to perform any desired postprocessing after
+        the solve and before evaluating objectives.
+        """
         pass
 
     def quit(self, timeout=1, force=True):
@@ -692,7 +746,8 @@ class FemtetInterface(FEMInterface):
                 logger.error(Msg.ERR_CANNOT_ACCESS_API + 'Femtet.Exit()')
                 logger.error(Msg.CERTIFY_MACRO_VERSION)
                 print('================')
-                input(Msg.ENTER_TO_QUIT)
+                if self.confirm_before_exit:
+                    input(Msg.ENTER_TO_QUIT)
                 raise e
 
         else:
@@ -723,9 +778,9 @@ class FemtetInterface(FEMInterface):
     def _version(self):
         return _version(Femtet=self.Femtet)
 
-    def create_postprocess_args(self):
-        file_content = self.create_result_file_content()
-        jpg_content = self.create_jpg_content()
+    def _create_postprocess_args(self):
+        file_content = self._create_result_file_content()
+        jpg_content = self._create_jpg_content()
 
         out = dict(
             original_femprj_path=self.original_femprj_path,
@@ -736,14 +791,14 @@ class FemtetInterface(FEMInterface):
         return out
 
     @staticmethod
-    def create_pdt_path(femprj_path, model_name, trial):
+    def _create_pdt_path(femprj_path, model_name, trial):
         result_dir = femprj_path.replace('.femprj', '.Results')
         pdt_path = os.path.join(result_dir, model_name + f'_trial{trial}.pdt')
         return pdt_path
 
     # noinspection PyMethodOverriding
     @staticmethod
-    def postprocess_func(
+    def _postprocess_func(
             trial: int,
             original_femprj_path: str,
             model_name: str,
@@ -753,7 +808,7 @@ class FemtetInterface(FEMInterface):
     ):
         result_dir = original_femprj_path.replace('.femprj', '.Results')
         if pdt_file_content is not None:
-            pdt_path = FemtetInterface.create_pdt_path(original_femprj_path, model_name, trial)
+            pdt_path = FemtetInterface._create_pdt_path(original_femprj_path, model_name, trial)
             with open(pdt_path, 'wb') as f:
                 f.write(pdt_file_content)
 
@@ -762,7 +817,7 @@ class FemtetInterface(FEMInterface):
             with open(jpg_path, 'wb') as f:
                 f.write(jpg_file_content)
 
-    def create_result_file_content(self):
+    def _create_result_file_content(self):
         """Called after solve"""
         if self.save_pdt == 'all':
             # save to worker space
@@ -786,7 +841,7 @@ class FemtetInterface(FEMInterface):
         else:
             return None
 
-    def create_jpg_content(self):
+    def _create_jpg_content(self):
         result_dir = self.femprj_path.replace('.femprj', '.Results')
         jpg_path = os.path.join(result_dir, self.model_name + '.jpg')
 
@@ -860,35 +915,37 @@ class _UnPicklableNoFEM(FemtetInterface):
 
 
 # レジストリのパスと値の名前
-REGISTRY_PATH: Final[str] = r"SOFTWARE\Murata Software\Femtet2014\Femtet"
-VALUE_NAME: Final[str] = "AutoSave"
+_REGISTRY_PATH: Final[str] = r"SOFTWARE\Murata Software\Femtet2014\Femtet"
+_VALUE_NAME: Final[str] = "AutoSave"
 
-def get_autosave_enabled() -> bool:
-    with winreg.OpenKey(winreg.HKEY_CURRENT_USER, REGISTRY_PATH) as key:
-        value, regtype = winreg.QueryValueEx(key, VALUE_NAME)
+
+def _get_autosave_enabled() -> bool:
+    with winreg.OpenKey(winreg.HKEY_CURRENT_USER, _REGISTRY_PATH) as key:
+        value, regtype = winreg.QueryValueEx(key, _VALUE_NAME)
         if regtype == winreg.REG_DWORD:
             return bool(value)
         else:
             raise ValueError("Unexpected registry value type.")
 
-def set_autosave_enabled(enable: bool) -> None:
-    with winreg.OpenKey(winreg.HKEY_CURRENT_USER, REGISTRY_PATH, 0, winreg.KEY_SET_VALUE) as key:
-        winreg.SetValueEx(key, VALUE_NAME, 0, winreg.REG_DWORD, int(enable))
+
+def _set_autosave_enabled(enable: bool) -> None:
+    with winreg.OpenKey(winreg.HKEY_CURRENT_USER, _REGISTRY_PATH, 0, winreg.KEY_SET_VALUE) as key:
+        winreg.SetValueEx(key, _VALUE_NAME, 0, winreg.REG_DWORD, int(enable))
 
 
 def _test_autosave_setting():
 
     # 使用例
-    current_setting = get_autosave_enabled()
+    current_setting = _get_autosave_enabled()
     print(f"Current AutoSave setting is {'enabled' if current_setting else 'disabled'}.")
 
     # 設定を変更する例
     new_setting = not current_setting
-    set_autosave_enabled(new_setting)
+    _set_autosave_enabled(new_setting)
     print(f"AutoSave setting has been {'enabled' if new_setting else 'disabled'}.")
 
     # 再度設定を確認する
-    after_setting = get_autosave_enabled()
+    after_setting = _get_autosave_enabled()
     print(f"Current AutoSave setting is {'enabled' if after_setting else 'disabled'}.")
 
     assert new_setting == after_setting, "レジストリ編集に失敗しました。" 

pyfemtet/opt/interface/_femtet_with_nx/_interface.py

@@ -7,23 +7,47 @@ from dask.distributed import get_worker
 
 from pyfemtet.core import ModelError
 from pyfemtet.opt.interface import FemtetInterface, logger
-from pyfemtet.message import Msg
+from pyfemtet._message import Msg
 
 
 here, me = os.path.split(__file__)
 
 
 class FemtetWithNXInterface(FemtetInterface):
-    """Femtet with NX interface class.
+    """Control Femtet and NX.
 
-    Args:
-        prt_path: The path to the prt file.
-        export_curves(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
-        export_surfaces(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
-        export_solids(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
-        export_flattened_assembly(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
+    Using this class, you can import CAD files created
+    in NX through the Parasolid format into a
+    Femtet project. It allows you to pass design
+    variables to NX, update the model, and
+    perform analysis using the updated model in Femtet.
 
-    For details of The other arguments, see ``FemtetInterface``.
+    Args:
+        prt_path (str):
+            The path to .prt file containing the
+            CAD data from which the import is made.
+
+        export_curves(bool or None, optional):
+            Defaults to None.
+        export_surfaces(bool or None, optional):
+            Defaults to None.
+        export_solids(bool or None, optional):
+            Defaults to None.
+        export_flattened_assembly(bool or None, optional):
+            Defaults to None.
+        **kwargs:
+            For other arguments, please refer to the
+            :class:`FemtetInterface` class.
+
+    Notes:
+        ```export_*``` arguments sets
+        parasolid export setting of NX.
+        If None, PyFemtet does not change
+        the current setting of NX.
+
+        It is recommended not to change these values
+        from the settings used when exporting the
+        Parasolid that was imported into Femtet.
 
     """
 
@@ -84,7 +108,7 @@ class FemtetWithNXInterface(FemtetInterface):
         )
         super()._setup_before_parallel(client)
 
-    def update_model(self, parameters: 'pd.DataFrame') -> None:
+    def update_model(self, parameters: 'pd.DataFrame', with_warning=False) -> None:
         """Update .x_t"""
 
         self.parameters = parameters.copy()
@@ -151,5 +175,4 @@ class FemtetWithNXInterface(FemtetInterface):
         )
 
         # femprj モデルの変数も更新
-        super().update_model(parameters)
-
+        super().update_model(parameters, with_warning=False)