共用方式為


Estimator 類別

表示使用任何提供的架構來定型數據的泛型估算器。

荒廢的。 使用 ScriptRunConfig 物件搭配您自己的已定義環境或 Azure ML 策展環境。 如需使用 ScriptRunConfig 設定實驗回合的簡介,請參閱 設定和提交定型執行

此類別的設計目的是要與尚未設定 Azure Machine Learning 預先設定的估算器機器學習架構搭配使用。 、、 和 有預先設定的估算器存在ChainerPyTorchTensorFlowSKLearn 若要建立未預先設定的估算器,請參閱 使用估算器使用 Azure Machine Learning 將模型定型。

Estimator 類別會包裝執行組態資訊,以協助簡化指定腳本執行方式的工作。 它支援單一節點以及多節點執行。 執行估算器會在定型腳本中指定的輸出目錄中產生模型。

初始化估算器。

使用azureml.core.environment._DEFAULT_SHM_SIZE。 如需詳細資訊,請參閱 Docker 執行參考。 :type shm_size:str :p aram resume_from:包含要繼續實驗的檢查點或模型檔案的數據路徑。 :type resume_from:azureml.data.datapath.DataPath :p aram max_run_duration_seconds:執行允許的時間上限。 Azure ML 將嘗試自動

如果執行時間超過此值,請取消執行。

建構函式

Estimator(source_directory, *, compute_target=None, vm_size=None, vm_priority=None, entry_script=None, script_params=None, node_count=1, process_count_per_node=1, distributed_backend=None, distributed_training=None, use_gpu=False, use_docker=True, custom_docker_base_image=None, custom_docker_image=None, image_registry_details=None, user_managed=False, conda_packages=None, pip_packages=None, conda_dependencies_file_path=None, pip_requirements_file_path=None, conda_dependencies_file=None, pip_requirements_file=None, environment_variables=None, environment_definition=None, inputs=None, source_directory_data_store=None, shm_size=None, resume_from=None, max_run_duration_seconds=None, _disable_validation=True, _show_lint_warnings=False, _show_package_warnings=False)

參數

名稱 Description
source_directory
必要
str

本機目錄,包含定型作業所需的實驗組態和程式代碼檔案。

compute_target
必要

定型的計算目標。 這可以是物件或字串 「local」。

vm_size
必要
str

將針對定型建立之計算目標的 VM 大小。 支援的值:任何 Azure VM 大小

vm_priority
必要
str

將針對定型建立之計算目標的 VM 優先順序。 如果未指定,則會使用 'dedicated'。

支援的值:'dedicated' 和 'lowpriority'。

只有在輸入中指定 參數時 vm_size ,才會生效。

entry_script
必要
str

用來開始定型之檔案的相對路徑。

script_params
必要

要傳遞至 中所 entry_script指定定型腳本之命令行自變數的字典。

node_count
必要
int

用於定型的計算目標中的節點數目。 如果大於 1,則會執行 MPI 分散式作業。

process_count_per_node
必要
int

在每個節點上執行的進程數目(或「背景工作角色」。 如果大於 1,則會執行 MPI 分散式作業。 AmlCompute只有分散式作業支持目標。

distributed_backend
必要
str

分散式定型的通訊後端。

荒廢的。 請使用 distributed_training 參數。

支援的值:『mpi』。 'mpi' 代表 MPI/Horovod。

node_countprocess_count_per_node 1 時>需要此參數。

當 == 1 和 node_count == 1 時process_count_per_node,除非明確設定後端,否則不會使用後端。 AmlCompute只有分散式定型支持目標。

distributed_training
必要
Mpi

執行分散式定型作業的參數。

若要使用 MPI 後端執行分散式作業,請使用 Mpi 物件來指定 process_count_per_node

use_gpu
必要

指出執行實驗的環境是否應該支援 GPU。 如果為 true,則會在環境中使用 GPU 型預設 Docker 映射。 如果為 false,則會使用以 CPU 為基礎的映像。 只有在未設定 參數時 custom_docker_image ,才會使用預設 Docker 映射 (CPU 或 GPU)。 此設定僅適用於已啟用 Docker 的計算目標。

use_docker
必要

指定執行實驗的環境是否應以 Docker 為基礎。

custom_docker_base_image
必要
str

將建置要用於定型之映像的 Docker 映像名稱。

荒廢的。 請使用 custom_docker_image 參數。

如果未設定,則會使用預設CPU型映像作為基底映像。

custom_docker_image
必要
str

將建置要用於定型之映像的 Docker 映像名稱。 如果未設定,則會使用預設CPU型映像作為基底映像。 只指定公用 Docker 存放庫 (Docker Hub) 中可用的映像。 若要從私人 Docker 存放庫使用映像,請改用建構函式的參數 environment_definition

image_registry_details
必要

Docker 映像登錄的詳細數據。

user_managed
必要

指定 Azure ML 是否重複使用現有的 Python 環境。 如果為 false,則會根據 conda 相依性規格建立 Python 環境。

conda_packages
必要

字串清單,代表要新增至實驗 Python 環境的 conda 套件。

pip_packages
必要

字串清單,代表要新增至實驗 Python 環境的 pip 套件。

conda_dependencies_file_path
必要
str

conda 相依性 yaml 檔案的相對路徑。 如果指定,Azure ML 將不會安裝任何架構相關套件。

荒廢的。 conda_dependencies_file使用參數。

請指定 conda_dependencies_file_pathconda_dependencies_file。 如果同時指定兩者, conda_dependencies_file 則會使用 。

pip_requirements_file_path
必要
str

pip 需求文字文件的相對路徑。

荒廢的。 請使用 pip_requirements_file 參數。

這個參數可以與 pip_packages 參數結合來指定。 請指定 pip_requirements_file_pathpip_requirements_file。 如果同時指定兩者, pip_requirements_file 則會使用 。

conda_dependencies_file
必要
str

conda 相依性 yaml 檔案的相對路徑。 如果指定,Azure ML 將不會安裝任何架構相關套件。

pip_requirements_file
必要
str

pip 需求文字文件的相對路徑。 這個參數可以與 pip_packages 參數結合來指定。

environment_variables
必要

環境變數名稱和值的字典。 這些環境變數會在執行使用者文本的程序上設定。

environment_definition
必要

實驗的環境定義。 它包含 PythonSection、DockerSection 和環境變數。 任何未透過其他參數直接公開至估算器建構的環境選項,都可以使用此參數來設定。 如果指定此參數,則會優先於其他環境相關參數,例如 use_gpucustom_docker_imageconda_packagespip_packages。 錯誤會報告無效的組合。

inputs
必要

要做為輸入的 DataReferenceDatasetConsumptionConfig 物件清單。

source_directory_data_store
必要

專案共用的備份數據存放區。

shm_size
必要
str

Docker 容器共用記憶體區塊的大小。 如果未設定,則會使用預設azureml.core.environment._DEFAULT_SHM_SIZE。 如需詳細資訊,請參閱 Docker 執行參考

resume_from
必要

包含要繼續實驗之檢查點或模型檔案的數據路徑。

max_run_duration_seconds
必要
int

執行所允許的時間上限。 如果執行時間超過此值,Azure ML 會嘗試自動取消執行。

source_directory
必要
str

本機目錄,包含定型作業所需的實驗組態和程式代碼檔案。

compute_target
必要

定型的計算目標。 這可以是物件或字串 「local」。

vm_size
必要
str

將針對定型建立之計算目標的 VM 大小。 支援的值:任何 Azure VM 大小

vm_priority
必要
str

將針對定型建立之計算目標的 VM 優先順序。 如果未指定,則會使用 'dedicated'。

支援的值:'dedicated' 和 'lowpriority'。

只有在輸入中指定 參數時 vm_size ,才會生效。

entry_script
必要
str

用來開始定型之檔案的相對路徑。

script_params
必要

要傳遞至 中所 entry_script指定定型腳本之命令行自變數的字典。

node_count
必要
int

用於定型的計算目標中的節點數目。 如果大於 1,則會執行 MPI 分散式作業。 AmlCompute只有分散式作業支持目標。

process_count_per_node
必要
int

每個節點的進程數目。 如果大於 1,則會執行 MPI 分散式作業。 AmlCompute只有分散式作業支持目標。

distributed_backend
必要
str

分散式定型的通訊後端。

荒廢的。 請使用 distributed_training 參數。

支援的值:『mpi』。 'mpi' 代表 MPI/Horovod。

node_countprocess_count_per_node 1 時>需要此參數。

當 == 1 和 node_count == 1 時process_count_per_node,除非明確設定後端,否則不會使用後端。 AmlCompute只有分散式定型支持目標。

distributed_training
必要
Mpi

執行分散式定型作業的參數。

若要使用 MPI 後端執行分散式作業,請使用 Mpi 物件來指定 process_count_per_node

use_gpu
必要

指定執行實驗的環境是否應該支援 GPU。 如果為 true,則會在環境中使用 GPU 型預設 Docker 映射。 如果為 false,則會使用以 CPU 為基礎的映像。 只有在未設定 參數時 custom_docker_image ,才會使用預設 Docker 映射 (CPU 或 GPU)。 此設定僅適用於已啟用 Docker 的計算目標。

use_docker
必要

指定執行實驗的環境是否應以 Docker 為基礎。

custom_docker_base_image
必要
str

將建置要用於定型之映像的 Docker 映像名稱。

荒廢的。 請使用 custom_docker_image 參數。

如果未設定,則會使用預設CPU型映像作為基底映像。

custom_docker_image
必要
str

將建置要用於定型之映像的 Docker 映像名稱。 如果未設定,則會使用預設CPU型映像作為基底映像。 只指定公用 Docker 存放庫 (Docker Hub) 中可用的映像。 若要從私人 Docker 存放庫使用映像,請改用建構函式的參數 environment_definition

image_registry_details
必要

Docker 映像登錄的詳細數據。

user_managed
必要

指定 Azure ML 是否重複使用現有的 Python 環境。 如果為 false,則會根據 conda 相依性規格建立 Python 環境。

conda_packages
必要

字串清單,代表要新增至實驗 Python 環境的 conda 套件。

pip_packages
必要

字串清單,代表要新增至實驗 Python 環境的 pip 套件。

conda_dependencies_file_path
必要

conda 相依性 yaml 檔案的相對路徑。 如果指定,Azure ML 將不會安裝任何架構相關套件。

荒廢的。 conda_dependencies_file使用參數。

請指定 conda_dependencies_file_pathconda_dependencies_file。 如果同時指定兩者, conda_dependencies_file 則會使用 。

pip_requirements_file_path
必要

pip 需求文字文件的相對路徑。

荒廢的。 請使用 pip_requirements_file 參數。

這可以搭配 pip_packages 參數提供。 請指定 pip_requirements_file_pathpip_requirements_file。 如果同時指定兩者, pip_requirements_file 則會使用 。

pip_requirements_file
必要
str

pip 需求文字文件的相對路徑。 這可以搭配 pip_packages 參數提供。

environment_variables
必要

環境變數名稱和值的字典。 這些環境變數會在執行使用者文本的程序上設定。

environment_definition
必要

實驗的環境定義。 它包含 PythonSection、DockerSection 和環境變數。 任何未透過其他參數直接公開至估算器建構的環境選項,都可以使用此參數來設定。 如果指定此參數,則會優先於其他環境相關參數,例如 use_gpucustom_docker_imageconda_packagespip_packages。 錯誤會報告無效的組合。

inputs
必要

要做為輸入的 DataReferenceDatasetConsumptionConfig 物件清單。

source_directory_data_store
必要

專案共用的備份數據存放區。

shm_size
必要

Docker 容器共用記憶體區塊的大小。 如果未設定,則為預設值

_disable_validation
必要

在執行提交之前停用腳本驗證。 預設值為 True。

_show_lint_warnings
必要

顯示腳本 linting 警告。 預設值為 False。

_show_package_warnings
必要

顯示套件驗證警告。 預設值為 False。