共用方式為

AutoMLRun 類別

  • 參考

代表在 Azure Machine Learning 中執行的自動化 ML 實驗。

AutoMLRun 類別可用來管理執行、檢查執行狀態，並在提交 AutoML 執行後擷取執行詳細資料。 如需使用實驗執行的詳細資訊，請參閱 類別 Run 。

初始化 AutoML 執行。

繼承
Run
AutoMLRun

建構函式

AutoMLRun(experiment, run_id, **kwargs)

參數

名稱 Description
experiment
必要
Experiment

與執行相關聯的實驗。
run_id
必要
str

執行的識別碼。
experiment
必要
Experiment

與執行相關聯的實驗。
run_id
必要
str

執行的識別碼。

備註

當您使用 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

列印並傳回執行防護欄驗證的詳細結果。
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()

傳回

類型 Description

無

cancel_iteration

取消特定的子執行。

cancel_iteration(iteration)

參數

名稱 Description
iteration
必要
int

要取消的反復專案。

傳回

類型 Description

無

complete

完成 AutoML 執行。

complete(**kwargs)

傳回

類型 Description

無

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)

參數

名稱 Description
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 個數組，第一個包含用於定型資料的索引，第二個則是用於驗證資料的索引。 亦即 [[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

傳回

類型 Description
AutoMLRun

AutoML 父代執行。

例外狀況

類型 Description
ConfigException
InvalidRunState

fail

AutoML 執行失敗。

選擇性地使用傳遞至 error_details 的訊息或例外狀況，設定執行的 Error 屬性。

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

參數

名稱 Description
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

參數

名稱 Description
metric
str

選取要傳回的最佳執行時所使用的計量。 預設為主要計量。

預設值: None
onnx_compatible

是否只傳回產生 onnx 模型的執行。

預設值: False
kwargs
必要

傳回

類型 Description

AutoML 子執行。

get_guardrails

列印並傳回執行防護欄驗證的詳細結果。

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

參數

名稱 Description
to_console
bool

指出是否要將驗證結果寫入主控台。

預設值: True

傳回

類型 Description
dict

驗證器結果的字典。

例外狀況

類型 Description
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]

參數

名稱 Description
iteration
int

要傳回之對應回合和適配模型的反復專案編號。

預設值: None
metric
str

選取要傳回的最佳執行和適合模型時所使用的計量。

預設值: None
return_onnx_model
bool

如果 參數在 物件中設定為 True， enable_onnx_compatible_models 這個方法會傳回已轉換的 AutoMLConfig ONNX 模型。

預設值: False
return_split_onnx_model
SplitOnnxModelName

要傳回之分割 onnx 模型的型別

預設值: None

傳回

類型 Description
Run, <xref:Model>

回合，對應的配適模型。

例外狀況

類型 Description
ConfigException
OnnxConvertException
NotFoundException

備註

如果您想要檢查預處理器 () 和演算法， (估計器) 使用，您可以透過 Model.stepssklearn.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)

參數

名稱 Description
iteration
int

要擷取之適配回合的反復專案編號。 如果為 None，請擷取父環境。

預設值: None
check_versions
bool

如果為 True，請檢查具有目前環境的版本。 如果為 False，則傳遞。

預設值: True

傳回

類型 Description
dict

從 RunHistory 擷取的相依性字典。

例外狀況

類型 Description
ConfigException

pause

如果 AutoML 執行成功暫停，則傳回 True。

這個方法尚未實作。

pause()

例外狀況

類型 Description
NotImplementedError

register_model

向 AzureML ACI 服務註冊模型。

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

參數

名稱 Description
model_name
str

正在部署的模型名稱。

預設值: None
description
str

正在部署之模型的描述。

預設值: None
tags
dict

正在部署之模型的標記。

預設值: None
iteration
int

覆寫要部署的模型。 為指定的反復專案部署模型。

預設值: None
metric
str

覆寫要部署的模型。 為不同的計量部署最佳模型。

預設值: None

傳回

類型 Description
<xref:Model>

已註冊的模型物件。

resume

如果 AutoML 執行成功繼續，則傳回 True。

這個方法尚未實作。

resume()

例外狀況

類型 Description
NotImplementedError:

retry

如果成功重試 AutoML 執行，則傳回 True。

這個方法尚未實作。

retry()

例外狀況

類型 Description
NotImplementedError

summary

取得包含所嘗試演算法摘要及其分數的資料表。

summary()

傳回

類型 Description
DataFrame

包含 AutoML 模型統計資料的 Pandas 資料框架。

wait_for_completion

等候此執行完成。

在等候之後傳回狀態物件。

wait_for_completion(show_output=False, wait_post_processing=False)

參數

名稱 Description
show_output
bool

指出是否要在 sys.stdout 上顯示執行輸出。

預設值: False
wait_post_processing
bool

指出是否要在執行完成之後等候後續處理完成。

預設值: False

傳回

類型 Description
dict

status 物件。

例外狀況

類型 Description
ExperimentExecutionException

屬性

run_id

傳回目前回合的執行識別碼。

傳回

類型 Description
str

目前回合的執行識別碼。