pyfemtet 0.1.12__py3-none-any.whl → 0.2.1__py3-none-any.whl

pyfemtet/opt/monitor.py

@@ -1,9 +1,20 @@
 import webbrowser
 import logging
-from dash import Dash, html, dcc
-from dash.dependencies import Output, Input
+from dash import Dash, html, dcc, ctx, Output, Input
 import dash_bootstrap_components as dbc
 import plotly.graph_objs as go
+import plotly.express as px
+
+
+def update_hypervolume_plot(femopt):
+    # data setting
+    df = femopt.history.data
+
+    # create figure
+    fig = px.line(df, x="trial", y="hypervolume", markers=True)
+
+    return fig
+
 
 
 def update_scatter_matrix(femopt):
@@ -13,12 +24,6 @@ def update_scatter_matrix(femopt):
 
     # create figure
     fig = go.Figure()
-    fig.update_layout(
-        dict(
-            width=800,
-            height=600,
-        )
-    )
 
     # graphs setting dependent on n_objectives
     if len(obj_names) == 0:
@@ -27,14 +32,14 @@ def update_scatter_matrix(femopt):
     elif len(obj_names) == 1:
         fig.add_trace(
             go.Scatter(
-                x=tuple(range(len(obj_names[0]))),
-                y=data[obj_names[0]],
+                x=data['trial'],
+                y=data[obj_names[0]].values,
                 mode='markers+lines',
             )
         )
         fig.update_layout(
             dict(
-                title_text="単目的ペアプロット",
+                title_text="単目的プロット",
                 xaxis_title="解析実行回数(回)",
                 yaxis_title=obj_names[0],
             )
@@ -73,20 +78,74 @@ def update_scatter_matrix(femopt):
     return fig
 
 
+def setup_home():
+    # components の設定
+    # https://dash-bootstrap-components.opensource.faculty.ai/docs/components/accordion/
+    dummy = html.Div('', id='dummy')
+    interval = dcc.Interval(
+        id='interval-component',
+        interval=1*1000,  # in milliseconds
+        n_intervals=0,
+    )
+    header = html.H1("最適化の進行状況"),
+    graphs = dbc.Card(
+        [
+            dbc.CardHeader(
+                dbc.Tabs(
+                    [
+                        dbc.Tab(label="目的プロット", tab_id="tab-1"),
+                        dbc.Tab(label="Hypervolume", tab_id="tab-2"),
+                    ],
+                    id="card-tabs",
+                    active_tab="tab-1",
+                )
+            ),
+            dbc.CardBody(html.P(id="card-content", className="card-text")),
+        ]
+    )
+    toggle_update_button = dbc.Button('グラフの自動更新の一時停止', id='toggle-update-button')
+    interrupt_button = dbc.Button('最適化を中断', id='interrupt-button', color='danger')
+    status_text = dcc.Markdown(f'''
+---
+- このページでは、最適化の進捗状況を見ることができます。
+- このページを閉じても最適化は進行します。
+- この機能はブラウザによる状況確認機能ですが、インターネット通信は行いません。
+- 再びこのページを開くには、ブラウザのアドレスバーに __localhost:8080__ と入力してください。
+- ※ 特定のホスト名及びポートを指定するには、OptimizerBase.main() の実行前に
+OptimizerBase.set_monitor_server() を実行してください。
+    ''')
+
+    # layout の設定
+    layout = dbc.Container([
+        dbc.Row([dbc.Col(dummy), dbc.Col(interval)]),
+        dbc.Row([dbc.Col(header)]),
+        dbc.Row([dbc.Col(graphs)]),
+        dbc.Row([dbc.Col(toggle_update_button), dbc.Col(interrupt_button)]),
+        dbc.Row([dbc.Col(status_text)]),
+    ], fluid=True)
+
+    return layout
+
+
 class Monitor(object):
 
     def __init__(self, femopt):
 
+        # 引数の処理
         self.femopt = femopt
 
+        # ログファイルの保存場所
         log_path = self.femopt.history.path.replace('.csv', '.uilog')
         l = logging.getLogger()
         l.addHandler(logging.FileHandler(log_path))
 
+        # app の立上げ
         self.app = Dash(__name__, external_stylesheets=[dbc.themes.BOOTSTRAP])
 
+        # ページの components と layout の設定
+        self.home = setup_home()
 
-        #### simple sidebar app
+        # setup sidebar
         # https://dash-bootstrap-components.opensource.faculty.ai/examples/simple-sidebar/
 
         # the style arguments for the sidebar. We use position:fixed and a fixed width
@@ -107,20 +166,17 @@ class Monitor(object):
             "margin-right": "2rem",
             "padding": "2rem 1rem",
         }
-
-        # setup sidebar
         sidebar = html.Div(
             [
-                html.H2("Sidebar", className="display-4"),
+                html.H2("PyFemtet Monitor", className="display-4"),
                 html.Hr(),
                 html.P(
-                    "最適化の進捗の可視化手法を選択できます.", className="lead"
+                    "最適化の進捗を可視化します.", className="lead"
                 ),
                 dbc.Nav(
                     [
                         dbc.NavLink("Home", href="/", active="exact"),
-                        dbc.NavLink("ペアプロット", href="/page-1", active="exact"),
-                        # dbc.NavLink("Page 2", href="/page-2", active="exact"),
+                        # dbc.NavLink("ペアプロット", href="/page-1", active="exact"),
                     ],
                     vertical=True,
                     pills=True,
@@ -128,22 +184,16 @@ class Monitor(object):
             ],
             style=SIDEBAR_STYLE,
         )
-
         content = html.Div(id="page-content", style=CONTENT_STYLE)
         self.app.layout = html.Div([dcc.Location(id="url"), sidebar, content])
 
-        #### settings for multiobjective pairplot
-        self.home = self.setup_home()
-        self.multi_pairplot_layout = self.setup_page1()
-
-
         # sidebar によるページ遷移のための callback
         @self.app.callback(Output("page-content", "children"), [Input("url", "pathname")])
         def render_page_content(pathname):
-            if pathname == "/":
+            if pathname == "/":  # p0
                 return self.home
-            elif pathname == "/page-1":
-                return self.multi_pairplot_layout
+            # elif pathname == "/page-1":
+            #     return self.multi_pairplot_layout
             # elif pathname == "/page-2":
             #     return html.P("Oh cool, this is page 2!")
             # If the user tries to reach a different page, return a 404 message
@@ -156,109 +206,142 @@ class Monitor(object):
                 className="p-3 bg-light rounded-3",
             )
 
-
-        # 中断の設定
+        # 1. 一定時間ごとに ==> 自動更新が有効なら figure を更新する
+        # 2. 中断ボタンを押したら ==> 更新を無効にする and 中断を無効にする
+        # 3. メイン処理が中断 or 終了していたら ==> 更新を無効にする and 中断を無効にする
+        # 4. toggle_button が押されたら ==> 更新を有効にする or 更新を無効にする
+        # 5. タブを押したら ==> グラフの種類を切り替える
         @self.app.callback(
-            Output('dummy', 'value'),
-            Input('interrupt-button', 'n_clicks'))
-        def interrupt(_):
-            if _ is not None:
-                self.femopt.ipv.set_state('interrupted')
-            return ''
-
-        # scatter matrix
-        @self.app.callback(
-            Output('scatter-matrix-graph', 'figure'),
-            Input('interval-component', 'n_intervals'))
-        def update_sm(_):
-            return update_scatter_matrix(self.femopt)
+            [
+                Output('interval-component', 'max_intervals'),  # 2 3 4
+                Output('interrupt-button', 'disabled'),  # 2 3
+                Output('toggle-update-button', 'disabled'),  # 2 3 4
+                Output('toggle-update-button', 'children'),  # 2 3 4
+                Output('card-content', 'children'),  # 1 5
+            ],
+            [
+                Input('interval-component', 'n_intervals'),  # 1 3
+                Input('toggle-update-button', 'n_clicks'),  # 4
+                Input('interrupt-button', 'n_clicks'),  # 2
+                Input("card-tabs", "active_tab"),  # 5
+            ]
+        )
+        def control(
+                _,  # n_intervals
+                toggle_n_clicks,
+                interrupt_n_clicks,
+                active_tab_id,
+        ):
+            # 引数の処理
+            toggle_n_clicks = 0 if toggle_n_clicks is None else toggle_n_clicks
+            interrupt_n_clicks = 0 if interrupt_n_clicks is None else interrupt_n_clicks
+
+            # 下記を基本に戻り値を上書きしていく（優先のものほど下に来る）
+            max_intervals = -1  # enable
+            button_disable = False
+            toggle_text = 'グラフの自動更新を一時停止する'
+            graph = None
+
+            # toggle_button が奇数なら interval を disable にする
+            if toggle_n_clicks % 2 == 1:
+                max_intervals = 0  # disable
+                button_disable = False
+                toggle_text = 'グラフの自動更新を再開する'
 
-        # 終了していたら更新をやめる、中断ボタンを disable にする
-        @self.app.callback(
-            [Output('interval-component', 'max_intervals'),
-             Output('interrupt-button', 'disabled'),],
-            [Input('interval-component', 'n_intervals'),])
-        def stop_interval(_):
+            # 中断又は終了なら interval とボタンを disable にする
+            should_stop = False
             try:
                 state = self.femopt.ipv.get_state()
                 should_stop = (state == 'interrupted') or (state == 'terminated')
             except AttributeError:
                 should_stop = True
-            if should_stop:
-                max_intervals = 0
+            finally:
+                if should_stop:
+                    max_intervals = 0  # disable
+                    button_disable = True
+                    toggle_text = 'グラフの更新は行われません'
+
+            # 中断ボタンが押されたなら interval とボタンを disable にして femopt の状態を set する
+            button_id = ctx.triggered_id if not None else 'No clicks yet'
+            if button_id == 'interrupt-button':
+                max_intervals = 0  # disable
                 button_disable = True
-            else:
-                max_intervals = -1
-                button_disable = False
-            return max_intervals, button_disable
-
-    def setup_home(self):
-        # components の設定
-        text = dcc.Markdown('''
-# 最適化の進行状況モニター
----
-#### 左のサイドバーから、可視化方法を選択してください
-- このページでは、最適化の進捗状況を見ることができます。
-- ブラウザによる進捗状況確認機能ですが、インターネット通信は行いません。
-- このページを閉じても最適化は進行します。再びこのページを開くには、ブラウザのアドレスバーに __localhost:8080__ と入力してください。
-        ''')
-
-        return text
+                toggle_text = 'グラフの更新は行われません'
+                self.femopt.ipv.set_state('interrupted')
 
+            # グラフを更新する
+            if active_tab_id is not None:
+                if active_tab_id == "tab-1":
+                    graph = dcc.Graph(figure=update_scatter_matrix(self.femopt))
+                elif active_tab_id == "tab-2":
+                    graph = dcc.Graph(figure=update_hypervolume_plot(self.femopt))
 
-    def setup_page1(self):
-        # components の設定
-        # https://dash-bootstrap-components.opensource.faculty.ai/docs/components/accordion/
-        dummy = html.Div('', id='dummy')
-        interval = dcc.Interval(
-            id='interval-component',
-            interval=1*1000,  # in milliseconds
-            n_intervals=0,
-        )
-        header = html.H1("最適化の進行状況"),
-        graph = dcc.Graph(id='scatter-matrix-graph')
-        interrupt_button = dbc.Button('最適化を中断', id='interrupt-button', color='danger')
+            return max_intervals, button_disable, button_disable, toggle_text, graph
 
-        # layout の設定
-        layout = dbc.Container([
-            dbc.Row([dbc.Col(dummy), dbc.Col(interval)]),
-            dbc.Row([dbc.Col(header)]),
-            dbc.Row([dbc.Col(graph)]),
-            dbc.Row([dbc.Col(interrupt_button)], justify="center",),
-        ])
-        return layout
+    def start_server(self, host='localhost', port=8080):
 
+        if host is None:
+            host = 'localhost'
+        if port is None:
+            port = 8080
 
-    def start_server(self):
-        webbrowser.open('http://localhost:8080')
-        self.app.run(debug=False, host='localhost', port=8080)
+        if host == '0.0.0.0':
+            webbrowser.open(f'http://localhost:{str(port)}')
+        else:
+            webbrowser.open(f'http://{host}:{str(port)}')
+        self.app.run(debug=False, host=host, port=port)
 
 
 if __name__ == '__main__':
+    import datetime
+    from time import sleep
+    from threading import Thread
     import numpy as np
     import pandas as pd
+
+
     class IPV:
         def __init__(self):
             self.state = 'running'
+
         def get_state(self):
             return self.state
+
         def set_state(self, state):
             self.state = state
+
+
     class History:
         def __init__(self):
             self.obj_names = 'A B C D E'.split()
-            self.data = pd.DataFrame(
-                np.random.rand(5, len(self.obj_names)),
-                columns=self.obj_names,
-            )
             self.path = 'tmp.csv'
+            self.data = None
+            t = Thread(target=self.update)
+            t.start()
+
+        def update(self):
+
+            d = dict(
+                trial=range(5),
+                hypervolume=np.random.rand(5),
+                time=[datetime.datetime(year=2000, month=1, day=1, second=s) for s in range(5)]
+            )
+            for obj_name in self.obj_names:
+                d[obj_name] = np.random.rand(5)
+
+            while True:
+                self.data = pd.DataFrame(d)
+                sleep(1)
+
+
     class FEMOPT:
         def __init__(self, history, ipv):
             self.history = history
             self.ipv = ipv
 
-    history = History()
-    ipv = IPV()
-    femopt = FEMOPT(history, ipv)
-    monitor = Monitor(femopt)
+
+    _ipv = IPV()
+    _history = History()
+    _femopt = FEMOPT(_history, _ipv)
+    monitor = Monitor(_femopt)
     monitor.start_server()

pyfemtet/opt/{_optuna.py → optimizer.py}

@@ -17,11 +17,22 @@ from .base import OptimizerBase
 warnings.filterwarnings('ignore', category=ExperimentalWarning)
 
 
-def generate_lhs(bounds, seed=None) -> np.ndarray:
-    """
-    d 個の変数の bounds を貰い、N 個のサンプル点を得る。
-    N は d を超える最小の素数 p に対し N = p**2
+def generate_lhs(bounds: list[list[float]], seed: int | None = None) -> np.ndarray:
+    """Latin Hypercube Sampling from given design parameter bounds.
+
+    If the number of parameters is d, 
+    sampler returns (N, d) shape ndarray.
+    N equals p**2, p is the minimum prime number over d.
+    For example, when d=3, then p=5 and N=25.
+
+    Args:
+        bounds (list[list[float]]): List of [lower_bound, upper_bound] of parameters.
+        seed (int | None, optional): Random seed. Defaults to None.
+
+    Returns:
+        np.ndarray: (N, d) shape ndarray.
     """
+
     d = len(bounds)
 
     sampler = LatinHypercube(
@@ -59,6 +70,9 @@ def generate_lhs(bounds, seed=None) -> np.ndarray:
 
 
 class OptimizerOptuna(OptimizerBase):
+    """Optimizer class using Optuna.
+    
+    """
 
     def _objective(self, trial):
 
@@ -77,13 +91,16 @@ class OptimizerOptuna(OptimizerBase):
         for i, row in self.parameters.iterrows():
             x.append(trial.suggest_float(row['name'], row['lb'], row['ub']))
         x = np.array(x)
+        self.parameters['value'] = x
 
         # strict 拘束の計算で Prune することになったとき
         # constraint attr がないとエラーになるのでダミーを置いておく
         trial.set_user_attr("constraint", (1.,))  # 非正が feasible 扱い
 
+        # GetVariableValue 経由で変数にアクセスするなどの場合
+        self.fem.update_parameter(self.parameters)
+
         # strict 拘束の計算
-        self.parameters['value'] = x
         tmp = [[cns.calc(self.fem), cns.lb, cns.ub, name] for name, cns in self.constraints.items() if cns.strict]
         for val, lb, ub, name in tmp:
             if lb is not None:
@@ -103,6 +120,9 @@ class OptimizerOptuna(OptimizerBase):
         try:
             obj_values = self.f(x, message)  # obj_val と cns_val の更新
         except (ModelError, MeshError, SolveError):
+            print('FEM 解析に失敗しました。')
+            print('変数の組み合わせは以下の通りです。')
+            print(self.parameters)
             raise optuna.TrialPruned()
 
         # 拘束 attr の更新
@@ -123,7 +143,15 @@ class OptimizerOptuna(OptimizerBase):
     def _constraint_function(self, trial):
         return trial.user_attrs["constraint"]
 
-    def _setup_main(self, use_lhs_init=True):
+    def setup_concrete_main(self, use_lhs_init=True):
+        """Performs the setup for the optimization using Optuna.
+
+        Do sampler settings, study creation or loading and initial trials settings.
+
+        Args:
+            use_lhs_init (bool, optional): Flag indicating whether to use Latin Hypercube Sampling for initializing trials. Defaults to True.
+
+        """
 
         # sampler の設定
         self.sampler_kwargs = dict(
@@ -133,6 +161,11 @@ class OptimizerOptuna(OptimizerBase):
         self.sampler_class = optuna.samplers.TPESampler
         if self.method == 'botorch':
             self.sampler_class = optuna.integration.BoTorchSampler
+            # self.sampler_kwargs.update(
+            #     dict(
+            #         consider_running_trials=True
+            #     )
+            # )
 
         # study name の設定
         self.study_name = os.path.splitext(os.path.basename(self.history.path))[0]
@@ -148,32 +181,35 @@ class OptimizerOptuna(OptimizerBase):
             )
 
         # 初期値の設定
-        params = self.get_parameter('dict')
-        study.enqueue_trial(params, user_attrs={"message": "initial"})
-
-        # LHS を初期値にする
-        if use_lhs_init:
-            names = []
-            bounds = []
-            for i, row in self.parameters.iterrows():
-                names.append(row['name'])
-                lb = row['lb']
-                ub = row['ub']
-                bounds.append([lb, ub])
-            data = generate_lhs(bounds, seed=self.seed)
-            for datum in data:
-                d = {}
-                for name, v in zip(names, datum):
-                    d[name] = v
-                study.enqueue_trial(d, user_attrs={"message": "initial Latin Hypercube Sampling"})
-
-
-    def _main(self, subprocess_idx=0):
+        if len(study.trials) == 0:  # リスタートでなければ
+            # ユーザーの指定した初期値
+            params = self.get_parameter('dict')
+            study.enqueue_trial(params, user_attrs={"message": "initial"})
+
+            # LHS を初期値にする
+            if use_lhs_init:
+                names = []
+                bounds = []
+                for i, row in self.parameters.iterrows():
+                    names.append(row['name'])
+                    lb = row['lb']
+                    ub = row['ub']
+                    bounds.append([lb, ub])
+                data = generate_lhs(bounds, seed=self.seed)
+                for datum in data:
+                    d = {}
+                    for name, v in zip(names, datum):
+                        d[name] = v
+                    study.enqueue_trial(d, user_attrs={"message": "initial Latin Hypercube Sampling"})
+
+    def concrete_main(self, subprocess_idx=None):
+        """Optimization using Optuna."""
 
         # 乱数シードをプロセス固有にする
         seed = self.seed
         if seed is not None:
-            seed = seed + (1 + subprocess_idx)  # main process と subprocess0 が重複する
+            if subprocess_idx is not None:
+                seed = seed + (1 + subprocess_idx)  # main process と subprocess0 が重複する
 
         # sampler の restore
         sampler = self.sampler_class(
@@ -188,10 +224,14 @@ class OptimizerOptuna(OptimizerBase):
             sampler=sampler,
         )
 
-        # run
+        # 最大実行回数の指定
         callbacks = []
+        n_existing_trials = len(self.history.data)
         if self.n_trials is not None:
-            callbacks.append(MaxTrialsCallback(self.n_trials, states=(TrialState.COMPLETE,)))
+            n_trials = n_existing_trials + self.n_trials
+            callbacks.append(MaxTrialsCallback(n_trials, states=(TrialState.COMPLETE,)))
+
+        # run
         study.optimize(
             self._objective,
             timeout=self.timeout,