AutoMLRun 類別
代表在 Azure Machine Learning 中執行的自動化 ML 實驗。
AutoMLRun 類別可用來管理執行、檢查執行狀態,並在提交 AutoML 執行後擷取執行詳細資料。 如需使用實驗執行的詳細資訊,請參閱 類別 Run 。
初始化 AutoML 執行。
- 繼承
-
AutoMLRun
建構函式
AutoMLRun(experiment, run_id, **kwargs)
參數
備註
當您使用 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 執行失敗。 選擇性地使用傳遞至 |
get_best_child |
傳回具有此 AutoML 執行最佳分數的子回合。 |
get_guardrails |
列印並傳回執行防護欄驗證的詳細結果。 |
get_output |
傳回已測試之對應最佳管線的執行。 如果未提供任何輸入參數, |
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
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)
參數
- cv_splits_indices
- ndarray
用來分割定型資料以進行交叉驗證的索引。 每個資料列都是個別的交叉折迭,而且在每個交叉折迭內,提供 2 個數組,第一個包含用於定型資料的索引,第二個則是用於驗證資料的索引。 亦即 [[t1, v1], [t2, v2], ...] 其中 t1 是第一個交叉折迭的定型索引,而 v1 是第一個交叉折迭的驗證索引。
- spark_context
- <xref:SparkContext>
Spark 內容,僅適用于 azure databricks/spark 環境內使用時。
傳回
AutoML 父代執行。
傳回類型
例外狀況
fail
AutoML 執行失敗。
選擇性地使用傳遞至 error_details
的訊息或例外狀況,設定執行的 Error 屬性。
fail(error_details=None, error_code=None, _set_status=True, **kwargs)
參數
get_best_child
傳回具有此 AutoML 執行最佳分數的子回合。
get_best_child(metric: str | None = None, onnx_compatible: bool = False, **kwargs: Any) -> Run
參數
- onnx_compatible
是否只傳回產生 onnx 模型的執行。
- kwargs
傳回
AutoML 子執行。
get_guardrails
列印並傳回執行防護欄驗證的詳細結果。
get_guardrails(to_console: bool = True) -> Dict[str, Any]
參數
傳回
驗證器結果的字典。
傳回類型
例外狀況
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]
參數
- return_onnx_model
- bool
如果 參數在 物件中設定為 True, enable_onnx_compatible_models
這個方法會傳回已轉換的 AutoMLConfig ONNX 模型。
傳回
回合,對應的配適模型。
傳回類型
例外狀況
備註
如果您想要檢查預處理器 () 和演算法, (估計器) 使用,您可以透過 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)
參數
傳回
從 RunHistory 擷取的相依性字典。
傳回類型
例外狀況
pause
register_model
向 AzureML ACI 服務註冊模型。
register_model(model_name=None, description=None, tags=None, iteration=None, metric=None)
參數
傳回
已註冊的模型物件。
傳回類型
resume
如果 AutoML 執行成功繼續,則傳回 True。
這個方法尚未實作。
resume()
例外狀況
retry
summary
wait_for_completion
等候此執行完成。
在等候之後傳回狀態物件。
wait_for_completion(show_output=False, wait_post_processing=False)
參數
傳回
status 物件。
傳回類型
例外狀況
屬性
run_id
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應