AutoMLRun クラス

Azure Machine Learning での自動 ML 実験の実行を表します。

AutoMLRun クラスを使用すると、AutoML 実行の送信後に、実行の管理、実行状態の確認、実行の詳細の取得を行うことができます。実験の実行の操作の詳細については、 Run クラスを参照してください。

AutoML 実行を初期化します。

コンストラクター

AutoMLRun(experiment, run_id, **kwargs)

パラメーター

名前	説明
experiment 必須	Experiment 実行に関連付けられている実験。
run_id 必須	str 実行の ID。
experiment 必須	Experiment 実行に関連付けられている実験。
run_id 必須	str 実行の ID。

注釈

実験の submit メソッドを使用すると、AutoMLRun オブジェクトが返されます。

既に開始されている実行を取得するには、次のコードを使用します。


   from azureml.train.automl.run import AutoMLRun
   ws = Workspace.from_config()
   experiment = ws.experiments['my-experiment-name']
   automl_run = AutoMLRun(experiment, run_id = 'AutoML_9fe201fe-89fd-41cc-905f-2f41a5a98883')

メソッド

cancel	AutoML の実行を取り消します。 AutoML の実行が正常に取り消された場合は True を返します。
cancel_iteration	特定の子実行を取り消します。
complete	AutoML 実行を完了します。
continue_experiment	既存の AutoML 実験を続行します。
fail	AutoML の実行に失敗します。必要に応じて、メッセージまたは例外を `error_details`に渡して、実行の Error プロパティを設定します。
get_best_child	この AutoML 実行に最適なスコアで子実行を返します。
get_guardrails	Guardrail 検証の実行に関する詳細な結果を印刷して返します。
get_output	既にテストされている、対応する最適なパイプラインで実行を返します。入力パラメーターが指定されていない場合、 `get_output` はプライマリメトリックに従って最適なパイプラインを返します。または、 `iteration` パラメーターまたは `metric` パラメーターを使用して、指定されたメトリックごとに特定のイテレーションまたは最適な実行を取得することもできます。
get_run_sdk_dependencies	特定の実行の SDK 実行の依存関係を取得します。
pause	AutoML の実行が正常に一時停止された場合は True を返します。このメソッドは実装されていません。
register_model	モデルを AzureML ACI サービスに登録します。
resume	AutoML の実行が正常に再開された場合は True を返します。このメソッドは実装されていません。
retry	AutoML の実行が正常に再試行された場合は True を返します。このメソッドは実装されていません。
summary	試行されたアルゴリズムとそのスコアの概要を含むテーブルを取得します。
wait_for_completion	この実行が完了するまで待ちます。待機後の状態オブジェクトを返します。

cancel

AutoML の実行を取り消します。

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

cancel()

戻り値

型	説明
	なし

cancel_iteration

特定の子実行を取り消します。

cancel_iteration(iteration)

パラメーター

名前	説明
iteration 必須	int 取り消すイテレーション。

戻り値

型	説明
	なし

complete

AutoML 実行を完了します。

complete(**kwargs)

戻り値

型	説明
	なし

continue_experiment

既存の AutoML 実験を続行します。

continue_experiment(X=None, y=None, sample_weight=None, X_valid=None, y_valid=None, sample_weight_valid=None, data=None, label=None, columns=None, cv_splits_indices=None, spark_context=None, experiment_timeout_hours=None, experiment_exit_score=None, iterations=None, show_output=False, training_data=None, validation_data=None, **kwargs)

パラメーター

名前	説明
X	DataFrame または ndarray または <xref:azureml.dataprep.Dataflow> トレーニング機能。規定値: None
y	DataFrame または ndarray または <xref:azureml.dataprep.Dataflow> トレーニングラベル。規定値: None
sample_weight	DataFrame または ndarray または <xref:azureml.dataprep.Dataflow> トレーニングデータの重みのサンプル。規定値: None
X_valid	DataFrame または ndarray または <xref:azureml.dataprep.Dataflow> 検証機能。規定値: None
y_valid	DataFrame または ndarray または <xref:azureml.dataprep.Dataflow> 検証ラベル。規定値: None
sample_weight_valid	DataFrame または ndarray または <xref:azureml.dataprep.Dataflow> 検証セットのサンプルの重み。規定値: None
data	DataFrame トレーニング機能とラベル。規定値: None
label	str データ内の列にラベルを付けます。規定値: None
columns	list(str) データ内で特徴として使用できる列の一覧。規定値: None
cv_splits_indices	ndarray クロス検証のためにトレーニングデータを分割する場所のインデックス。各行は個別のクロスフォールドであり、各クロスフォールド内には 2 つの配列が用意されています。1 つ目はトレーニングデータに使用するサンプルのインデックス、2 つ目は検証データに使用するインデックスを持つインデックスです。つまり、[t1, v1], [t2, v2], ...] です。ここで、t1 は最初のクロスフォールドのトレーニングインデックスであり、v1 は最初のクロスフォールドの検証インデックスです。規定値: None
spark_context	<xref:SparkContext> Spark コンテキスト。Azure databricks/spark 環境内で使用する場合にのみ適用されます。規定値: None
experiment_timeout_hours	float この実験を実行する時間の追加時間。規定値: None
experiment_exit_score	int 指定した場合は、この値に達したときに実験が終了することを示します。規定値: None
iterations	int この実験に対して実行する追加のイテレーションの数。規定値: None
show_output	bool 出力をコンソールに出力するかどうかを示すフラグ。規定値: False
training_data	<xref:azureml.dataprep.Dataflow> または DataFrame トレーニングデータを入力します。規定値: None
validation_data	<xref:azureml.dataprep.Dataflow> または DataFrame 検証データ。規定値: None

戻り値

型	説明
AutoMLRun	AutoML 親実行。

例外

型	説明
ConfigException
InvalidRunState

fail

AutoML の実行に失敗します。

必要に応じて、メッセージまたは例外を error_detailsに渡して、実行の Error プロパティを設定します。

fail(error_details=None, error_code=None, _set_status=True, **kwargs)

パラメーター

名前	説明
error_details	str または BaseException エラーのオプションの詳細。規定値: None
error_code	str エラー分類のエラーの省略可能なエラーコード。規定値: None
_set_status	bool 追跡のために状態イベントを送信するかどうかを示します。規定値: True

get_best_child

この AutoML 実行に最適なスコアで子実行を返します。

get_best_child(metric: str | None = None, onnx_compatible: bool = False, **kwargs: Any) -> Run

パラメーター

名前	説明
metric	str 返される最適な実行を選択するときに使用するメトリック。既定値はプライマリメトリックです。規定値: None
onnx_compatible	onnx モデルを生成した実行のみを返すかどうか。規定値: False
kwargs 必須

戻り値

型	説明
	AutoML 子実行。

get_guardrails

Guardrail 検証の実行に関する詳細な結果を印刷して返します。

get_guardrails(to_console: bool = True) -> Dict[str, Any]

パラメーター

名前	説明
to_console	bool 検証結果をコンソールに書き込むかどうかを示します。規定値: True

戻り値

型	説明
dict	検証ツールの結果のディクショナリ。

例外

型	説明
UserErrorException

get_output

既にテストされている、対応する最適なパイプラインで実行を返します。

入力パラメーターが指定されていない場合、 get_output はプライマリメトリックに従って最適なパイプラインを返します。または、 iteration パラメーターまたは metric パラメーターを使用して、指定されたメトリックごとに特定のイテレーションまたは最適な実行を取得することもできます。

get_output(iteration: int | None = None, metric: str | None = None, return_onnx_model: bool = False, return_split_onnx_model: SplitOnnxModelName | None = None, **kwargs: Any) -> Tuple[Run, Any]

パラメーター

名前	説明
iteration	int 返される対応する実行モデルと適合モデルのイテレーション番号。規定値: None
metric	str 返される最適な実行モデルと適合モデルを選択するときに使用するメトリック。規定値: None
return_onnx_model	bool `enable_onnx_compatible_models` オブジェクトで AutoMLConfig パラメーターが True に設定されている場合、このメソッドは変換された ONNX モデルを返します。規定値: False
return_split_onnx_model	SplitOnnxModelName 返される分割 onnx モデルの型規定値: None

戻り値

型	説明
Run, <xref:Model>	実行、対応する適合モデル。

例外

型	説明
ConfigException
OnnxConvertException
NotFoundException

注釈

使用されているプリプロセッサとアルゴリズム (エスティメーター) を調べる場合は、Model.stepsと同様に、sklearn.pipeline.Pipeline.stepsを使用して行うことができます。たとえば、次のコードは、推定器を取得する方法を示しています。


   best_run, model = parent_run.get_output()
   estimator = model.steps[-1]

get_run_sdk_dependencies

特定の実行の SDK 実行の依存関係を取得します。

get_run_sdk_dependencies(iteration=None, check_versions=True, **kwargs)

パラメーター

名前	説明
iteration	int 取得する適合実行の反復回数。 None の場合は、親環境を取得します。規定値: None
check_versions	bool True の場合は、現在の環境のバージョンを確認します。 False の場合は、渡します。規定値: True

戻り値

型	説明
dict	RunHistory から取得された依存関係のディクショナリ。

例外

型	説明
ConfigException

pause

AutoML の実行が正常に一時停止された場合は True を返します。

このメソッドは実装されていません。

pause()

例外

型	説明
NotImplementedError

register_model

モデルを AzureML ACI サービスに登録します。

register_model(model_name=None, description=None, tags=None, iteration=None, metric=None)

パラメーター

名前	説明
model_name	str デプロイするモデルの名前。規定値: None
description	str デプロイするモデルの説明。規定値: None
tags	dict デプロイされるモデルのタグ。規定値: None
iteration	int デプロイするモデルをオーバーライドします。特定のイテレーションのモデルをデプロイします。規定値: None
metric	str デプロイするモデルをオーバーライドします。別のメトリックに最適なモデルをデプロイします。規定値: None

戻り値

型	説明
<xref:Model>	登録済みのモデルオブジェクト。

resume

AutoML の実行が正常に再開された場合は True を返します。

このメソッドは実装されていません。

resume()

例外

型	説明
NotImplementedError:

retry

AutoML の実行が正常に再試行された場合は True を返します。

このメソッドは実装されていません。

retry()

例外

型	説明
NotImplementedError

summary

試行されたアルゴリズムとそのスコアの概要を含むテーブルを取得します。

summary()

戻り値

型	説明
DataFrame	AutoML モデル統計を含む Pandas DataFrame。

wait_for_completion

この実行が完了するまで待ちます。

待機後の状態オブジェクトを返します。

wait_for_completion(show_output=False, wait_post_processing=False)

パラメーター

名前	説明
show_output	bool sys.stdout に実行出力を表示するかどうかを示します。規定値: False
wait_post_processing	bool 実行の完了後に後処理が完了するまで待機するかどうかを示します。規定値: False

戻り値

型	説明
dict	状態オブジェクト。

例外

型	説明
ExperimentExecutionException

属性

run_id

現在の実行の実行 ID を返します。

戻り値

型	説明
str	現在の実行の実行 ID。

次の方法で共有

AutoMLRun クラス

コンストラクター

パラメーター

注釈

メソッド

cancel

戻り値

cancel_iteration

パラメーター

戻り値

complete

戻り値

continue_experiment

パラメーター

戻り値

例外

fail

パラメーター

get_best_child

パラメーター

戻り値

get_guardrails

パラメーター

戻り値

例外

get_output

パラメーター

戻り値

例外

注釈

get_run_sdk_dependencies

パラメーター

戻り値

例外

pause

例外

register_model

パラメーター

戻り値

resume

例外

retry

例外

summary

戻り値

wait_for_completion

パラメーター

戻り値

例外

属性

run_id

戻り値

フィードバック