次の方法で共有

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

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

規定値: None
spark_context
<xref:SparkContext>

Azure Databricks/Spark 環境内で使用される場合にのみ適用される 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 に渡されるメッセージまたは例外を実行のエラー プロパティに設定します。

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

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

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

パラメーター

名前 説明
to_console
bool

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

規定値: True

戻り値

型 説明
dict

検証結果の dictionary。

例外

型 説明
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

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

規定値: False
return_split_onnx_model
SplitOnnxModelName

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

規定値: None

戻り値

型 説明
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 の場合は、現在の環境でバージョンをチェックします。 False の場合は、合格です。

規定値: True

戻り値

型 説明
dict

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

例外

型 説明
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。