pyfemtet.opt.history package

モジュール内容

class pyfemtet.opt.history.ColumnOrderMode(value)

ベースクラス: StrEnum

履歴 csv 列の並び順。

important_first = 'important_first'

per_category = 'per_category'

各オブジェクトごとに並べ替えます。

class pyfemtet.opt.history.History

ベースクラス: object

Manage history of optimization trials.

additional_data: dict

property all_output_names: list[str]

cns_names: list[str]

get_df(equality_filters=None)

最適化の履歴を返します。

パラメータ:

equality_filters (dict, optional) – {column: value} というフォーマットのマッチングフィルター。

戻り値の型:

DataFrame

Returns: 最適化の履歴

static get_trial_name(trial=None, fidelity=None, sub_sampling=None, row=None)

パラメータ:

row (Series | None) –

is_restart: bool

obj_names: list[str]

other_output_names: list[str]

path: str

既存または出力先のCSVパス。

指定されていない場合、最適化プロセス開始時にCSVファイルは「pyfemtet.opt_%Y%m%d_%H%M%S.csv」形式で保存されます。

prm_names: list[str]

save()

最適化履歴をエクスポートします。

保存先パスは History.path です。

sub_fidelity_names: list[str]

class pyfemtet.opt.history.TrialState(value)

ベースクラス: StrEnum

An enumeration.

hard_constraint_violation = 'Hard constraint violation'

mesh_error = 'Mesh error'

model_error = 'Model error'

post_error = 'Post-processing error'

skipped = 'Skip'

soft_constraint_violation = 'Soft constraint violation'

solve_error = 'Solve error'

succeeded = 'Success'

undefined = 'undefined'

unknown_error = 'Unknown error'

pyfemtet.opt.history.get_trial_name(trial=None, fidelity=None, sub_sampling=None, row=None)

パラメータ:

row (Series | None) –