HyperDriveRun クラス

  • リファレンス

HyperDriveRun には、送信された HyperDrive 実験の詳細が含まれています。

このクラスは、HyperDrive 実行と、生成された各子実行の管理、状態の検査、実行の詳細を取得に使用できます。

HyperDrive の実行を初期化します。

継承
Run
HyperDriveRun

コンストラクター

HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)

パラメーター

experiment
Experiment
必須

HyperDrive 実行の実験。

run_id
str
必須

HyperDrive 実行 ID。

hyperdrive_config
HyperDriveConfig
既定値: None

この HyperDrive 実行の構成。

experiment
Experiment
必須

HyperDrive 実行の実験。

run_id
str
必須

HyperDrive の実行 ID。

hyperdrive_config
HyperDriveConfig
必須

この HyperDrive 実行の構成。 None の場合、実行は既に存在し、クラウドからハイドレートしようとします。

メソッド

cancel

HyperDrive 実行が正常に取り消された場合は True を返します。
fail

使用しないでください。 fail メソッドは、HyperDriveRun サブクラスではサポートされていません。
get_best_run_by_primary_metric

すべての子実行のうち、最もパフォーマンスが高い実行に対応する実行インスタンスを見つけて返します。

最もパフォーマンスが高い実行は、HyperDriveConfig 内で指定された主要メトリック パラメーターに基づいてのみ特定されます。 PrimaryMetricGoal は、主要メトリックの最小値と最大値のどちらが使用されるかを制御します。 この HyperDriveRun によって起動されるすべての ExperimentRun メトリックの詳細な分析を実行するには、get_metrics を使用します。 この HyperDrive 実行によって起動された複数の実行が、同じ最適なメトリックに達した場合でも、返されるのは 1 つの実行だけです。
get_children_sorted_by_primary_metric

最適な主要メトリックで並べ替えられた子のリストを返します。

この並べ替えは、主要メトリックとそのゴールに従って行われ、最大化されている場合、子は最適な主要メトリックの降順で返されます。 reverse が True の場合、順序は逆になります。

結果内のそれぞれの子に、実行 ID、ハイパーパラメーター、最適な主要メトリック値、状態が含まれます。

discard_no_metric が True の場合、主要メトリックを含まない子は破棄されます。 それ以外の場合は、主要メトリックを含む他の子の背後にあるリストに追加されます。 reverse オプションは、何の影響もないことに注意してください。
get_diagnostics

使用しないでください。 get_diagnostics メソッドは、HyperDriveRun サブクラスではサポートされていません。
get_hyperparameters

この HyperDriveRun によって起動されたすべての子実行のハイパーパラメーターを返します。
get_metrics

この HyperDriveRun によって起動されたすべての実行からメトリックを返します。

cancel

HyperDrive 実行が正常に取り消された場合は True を返します。

cancel()

戻り値

実行が正常に取り消されたかどうか。

の戻り値の型 :

bool

fail

使用しないでください。 fail メソッドは、HyperDriveRun サブクラスではサポートされていません。

fail()

例外

HyperDriveNotImplementedException

get_best_run_by_primary_metric

すべての子実行のうち、最もパフォーマンスが高い実行に対応する実行インスタンスを見つけて返します。

最もパフォーマンスが高い実行は、HyperDriveConfig 内で指定された主要メトリック パラメーターに基づいてのみ特定されます。 PrimaryMetricGoal は、主要メトリックの最小値と最大値のどちらが使用されるかを制御します。 この HyperDriveRun によって起動されるすべての ExperimentRun メトリックの詳細な分析を実行するには、get_metrics を使用します。 この HyperDrive 実行によって起動された複数の実行が、同じ最適なメトリックに達した場合でも、返されるのは 1 つの実行だけです。

get_best_run_by_primary_metric(include_failed=True, include_canceled=True, include_resume_from_runs=True) -> Run | None

パラメーター

include_failed
bool
既定値: True

失敗した実行を含めるかどうか。

include_canceled
bool
既定値: True

取り消された実行を含めるかどうか。

include_resume_from_runs
bool
既定値: True

継承された resume_from 実行を含めるかどうか。

戻り値

最適な実行、または None (どの子にも主要メトリックが含まれない場合)。

の戻り値の型 :

Run

get_children_sorted_by_primary_metric

最適な主要メトリックで並べ替えられた子のリストを返します。

この並べ替えは、主要メトリックとそのゴールに従って行われ、最大化されている場合、子は最適な主要メトリックの降順で返されます。 reverse が True の場合、順序は逆になります。

結果内のそれぞれの子に、実行 ID、ハイパーパラメーター、最適な主要メトリック値、状態が含まれます。

discard_no_metric が True の場合、主要メトリックを含まない子は破棄されます。 それ以外の場合は、主要メトリックを含む他の子の背後にあるリストに追加されます。 reverse オプションは、何の影響もないことに注意してください。

get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)

パラメーター

top
int
既定値: 0

返される上位の子の数。 0 の場合は、すべての子が返されます。

reverse
bool
既定値: False

True の場合、順序は逆になります。 主要メトリックを含む子にのみ影響します。

discard_no_metric
bool
既定値: False

False の場合は、主要メトリックを含まない子がリストに追加されます。

戻り値

実行 ID、ハイパーパラメーター、最適な主要メトリック、状態を含む辞書のリスト

の戻り値の型 :

list

get_diagnostics

使用しないでください。 get_diagnostics メソッドは、HyperDriveRun サブクラスではサポートされていません。

get_diagnostics()

例外

HyperDriveNotImplementedException

get_hyperparameters

この HyperDriveRun によって起動されたすべての子実行のハイパーパラメーターを返します。

get_hyperparameters()

戻り値

すべての子実行のハイパーパラメーター。 これは run_id をキーとして含む辞書です。

の戻り値の型 :

dict

get_metrics

この HyperDriveRun によって起動されたすべての実行からメトリックを返します。

get_metrics()

戻り値

この実行のすべての子のメトリック。

の戻り値の型 :

dict

属性

hyperdrive_config

ハイパードライブ実行の構成を返します。

戻り値

ハイパードライブ実行の構成。

の戻り値の型 :

HyperDriveConfig

HYPER_DRIVE_RUN_USER_AGENT 

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE 

RUN_TYPE = 'hyperdrive'