AutoMLRun クラス

リファレンス

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

AutoMLRun クラスは、AutoML 実行が送信された後の実行の管理、実行状態の検査、実行の詳細の取得に使用できます。実験の実行の操作の詳細については、Run クラスをご覧ください。

AutoML 実行を初期化します。

継承: Run

AutoMLRun

コンストラクター

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` に渡されるメッセージまたは例外を実行のエラープロパティに設定します。
get_best_child	この AutoML 実行に最適なスコアを持つ子実行を返します。
get_guardrails	実行中のガードレールの検証から詳細な結果を出力して返します。
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()

戻り値

None

cancel_iteration

特定の子実行をキャンセルします。

cancel_iteration(iteration)

パラメーター

iteration: int

必須

キャンセルするイテレーション。

戻り値

None

complete

AutoML の実行を完了します。

complete(**kwargs)

戻り値

None

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

既定値: None

クロス検証用にトレーニングデータを分割する位置のインデックス。各行は独立したクロスフォールドで、各クロスフォールドに 2 つの配列があり、1 番目にはトレーニングデータに使用するサンプルのインデックスを、2 番目には検証データに使用するインデックスを指定します。つまり、[[t1, v1], [t2, v2], ...] というようにします。t1 は 1 番目のクロスフォールドのトレーニングインデックス、v1 は 1 番目のクロスフォールドの検証インデックスです。

spark_context: <xref:SparkContext>

既定値: None

Azure Databricks/Spark 環境内で使用される場合にのみ適用される Spark コンテキスト。

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

検証データ。

戻り値

AutoML の親実行。

の戻り値の型 :

AutoMLRun

例外

ConfigException

InvalidRunState

fail

AutoML の実行が失敗します。

オプションで、error_details に渡されるメッセージまたは例外を実行のエラープロパティに設定します。

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

既定値: False

ONNX モデルを生成した実行のみを返すかどうかを指定します。

kwargs

必須

戻り値

AutoML の子実行。

get_guardrails

実行中のガードレールの検証から詳細な結果を出力して返します。

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

パラメーター

to_console: bool

既定値: True

検証結果をコンソールに出力するかどうかを示します。

戻り値

検証結果の dictionary。

の戻り値の型 :

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

既定値: False

このメソッドは、AutoMLConfig オブジェクトで enable_onnx_compatible_models パラメーターが True に設定されている場合、変換された ONNX モデルを返します。

return_split_onnx_model: SplitOnnxModelName

既定値: None

返される分割 ONNX モデルの型

戻り値

実行、対応する適合モデル。

の戻り値の型 :

Run, <xref:Model>

例外

ConfigException

OnnxConvertException

NotFoundException

注釈

使用するプリプロセッサとアルゴリズム (推定器) を調べる場合は、sklearn.pipeline.Pipeline.steps と同じように Model.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

True の場合は、現在の環境でバージョンをチェックします。 False の場合は、合格です。

戻り値

RunHistory から取得された依存関係の dictionary。

の戻り値の型 :

dict

例外

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()

戻り値

AutoML モデル統計を含む pandas DataFrame。

の戻り値の型 :

DataFrame

wait_for_completion

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

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

wait_for_completion(show_output=False, wait_post_processing=False)

パラメーター

show_output: bool

既定値: False

sys.stdout に実行の出力を表示するかどうかを示します。

wait_post_processing: bool

既定値: False

実行の完了後、後処理が完了するまで待機するかどうかを示します。

戻り値

状態オブジェクト。

の戻り値の型 :

dict

例外

ExperimentExecutionException

属性

run_id

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

戻り値

現在の実行の実行 ID。

の戻り値の型 :

str

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

戻り値

の戻り値の型 :

フィードバック

フィードバック

その他のリソース