Estimator 類別

參考

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

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

此類別的設計目的是要搭配尚未設定 Azure Machine Learning 預先設定估算器的機器學習架構使用。、 PyTorch 、 TensorFlow 和 SKLearn 的 Chainer 預先設定估算器存在。若要建立未預先設定的估算器，請參閱使用估算器使用 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 將嘗試自動嘗試

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

繼承: azureml.train.estimator._mml_base_estimator.MMLBaseEstimator

Estimator

建構函式

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 必要	AbstractComputeTarget 或 str 定型會發生所在的計算目標。這可以是物件或字串「local」。
vm_size 必要	str 將針對定型建立之計算目標的 VM 大小。支援的值：任何 Azure VM 大小。
vm_priority 必要	str 將針對定型建立之計算目標的 VM 優先順序。如果未指定，則會使用 'dedicated'。支援的值：'dedicated' 和 'lowpriority'。只有在輸入中指定參數時 `vm_size` ，才會生效。
entry_script 必要	str 用來開始定型之檔案的相對路徑。
script_params 必要	dict 命令列引數的字典，用來傳遞至中指定的 `entry_script` 定型腳本。
node_count 必要	int 用於定型之計算目標中的節點數目。如果大於 1，將會執行 MPI 分散式作業。
process_count_per_node 必要	int 要在每個節點上執行的進程數目 (或「背景工作」) 。如果大於 1，將會執行 MPI 分散式作業。 AmlCompute只有分散式作業支援目標。
distributed_backend 必要	str 分散式定型的通訊後端。已淘汰。 `distributed_training`使用參數。支援的值：'mpi'。 'mpi' 代表 MPI/Horovod。當或 `process_count_per_node`> 1 時 `node_count` ，需要此參數。當 == 1 和 `process_count_per_node` == 1 時 `node_count` ，除非明確設定後端，否則不會使用後端。 AmlCompute只有分散式定型支援目標。
distributed_training 必要	Mpi 執行分散式定型作業的參數。若要使用 MPI 後端執行分散式作業，請使用 Mpi 物件來指定 `process_count_per_node` 。
use_gpu 必要	bool 指出執行實驗的環境是否應該支援 GPU。如果為 true，則會在環境中使用以 GPU 為基礎的預設 Docker 映射。如果為 false，則會使用以 CPU 為基礎的映射。只有在未設定參數時 `custom_docker_image` ，才會使用預設 Docker 映射 (CPU 或 GPU) 。此設定僅適用于已啟用 Docker 的計算目標。
use_docker 必要	bool 指定執行實驗的環境是否應該以 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 必要	ContainerRegistry Docker 映射登錄的詳細資料。
user_managed 必要	bool 指定 Azure ML 是否重複使用現有的 Python 環境。如果為 false，則會根據 conda 相依性規格建立 Python 環境。
conda_packages 必要	list 字串清單，表示要新增至實驗 Python 環境的 conda 套件。
pip_packages 必要	list 字串清單，表示要新增至實驗 Python 環境的 pip 套件。
conda_dependencies_file_path 必要	str conda 相依性 yaml 檔案的相對路徑。如果指定，Azure ML 將不會安裝任何架構相關套件。已淘汰。 `conda_dependencies_file`使用參數。請指定 `conda_dependencies_file_path` 或 `conda_dependencies_file`。如果同時指定兩者， `conda_dependencies_file` 則會使用。
pip_requirements_file_path 必要	str pip 需求文字檔的相對路徑。已淘汰。 `pip_requirements_file`使用參數。這個參數可以與 `pip_packages` 參數結合來指定。請指定 `pip_requirements_file_path` 或 `pip_requirements_file`。如果同時指定兩者， `pip_requirements_file` 則會使用。
conda_dependencies_file 必要	str conda 相依性 yaml 檔案的相對路徑。如果指定，Azure ML 將不會安裝任何架構相關套件。
pip_requirements_file 必要	str pip 需求文字檔的相對路徑。這個參數可以與 `pip_packages` 參數結合來指定。
environment_variables 必要	dict 環境變數名稱和值的字典。這些環境變數會在執行使用者指令碼的程序上設定。
environment_definition 必要	Environment 實驗的環境定義。其中包含 PythonSection、DockerSection 和環境變數。任何未透過其他參數直接公開至估算器建構的環境選項，都可以使用此參數來設定。如果指定此參數，它將會優先于其他環境相關參數，例如 `use_gpu` 、 `custom_docker_image` 、 `conda_packages` 或 `pip_packages` 。錯誤將會回報不正確組合。
inputs 必要	list 要做為輸入的 DataReference 或 DatasetConsumptionConfig 物件清單。
source_directory_data_store 必要	Datastore 專案共用的備份資料存放區。
shm_size 必要	str Docker 容器的共用記憶體區塊大小。如果未設定，則會使用預設azureml.core.environment._DEFAULT_SHM_SIZE。如需詳細資訊，請參閱 Docker 執行參考。
resume_from 必要	DataPath 包含要繼續實驗之檢查點或模型檔案的資料路徑。
max_run_duration_seconds 必要	int 執行的最大允許時間。如果執行時間超過此值，Azure ML 將會嘗試自動取消執行。
source_directory 必要	str 本機目錄，其中包含定型作業所需的實驗組態和程式碼檔案。
compute_target 必要	AbstractComputeTarget 或 str 定型會發生所在的計算目標。這可以是物件或字串「local」。
vm_size 必要	str 將針對定型建立之計算目標的 VM 大小。支援的值：任何 Azure VM 大小。
vm_priority 必要	str 將針對定型建立之計算目標的 VM 優先順序。如果未指定，則會使用 'dedicated'。支援的值：'dedicated' 和 'lowpriority'。只有在輸入中指定參數時 `vm_size` ，才會生效。
entry_script 必要	str 用來開始定型之檔案的相對路徑。
script_params 必要	dict 命令列引數的字典，用來傳遞至中指定的 `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。當或 `process_count_per_node`> 1 時 `node_count` ，需要此參數。當 == 1 和 `process_count_per_node` == 1 時 `node_count` ，除非明確設定後端，否則不會使用後端。 AmlCompute只有分散式定型支援目標。
distributed_training 必要	Mpi 執行分散式定型作業的參數。若要使用 MPI 後端執行分散式作業，請使用 Mpi 物件來指定 `process_count_per_node` 。
use_gpu 必要	bool 指定執行實驗的環境是否應該支援 GPU。如果為 true，則會在環境中使用以 GPU 為基礎的預設 Docker 映射。如果為 false，則會使用以 CPU 為基礎的映射。只有在未設定參數時 `custom_docker_image` ，才會使用預設 Docker 映射 (CPU 或 GPU) 。此設定僅適用于已啟用 Docker 的計算目標。
use_docker 必要	bool 指定執行實驗的環境是否應該以 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 必要	ContainerRegistry Docker 映射登錄的詳細資料。
user_managed 必要	bool 指定 Azure ML 是否重複使用現有的 Python 環境。如果為 false，則會根據 conda 相依性規格建立 Python 環境。
conda_packages 必要	list 字串清單，表示要新增至實驗 Python 環境的 conda 套件。
pip_packages 必要	list 字串清單，表示要新增至實驗 Python 環境的 pip 套件。
conda_dependencies_file_path 必要	conda 相依性 yaml 檔案的相對路徑。如果指定，Azure ML 將不會安裝任何架構相關套件。已淘汰。 `conda_dependencies_file`使用參數。請指定 `conda_dependencies_file_path` 或 `conda_dependencies_file`。如果同時指定兩者， `conda_dependencies_file` 則會使用。
pip_requirements_file_path 必要	pip 需求文字檔的相對路徑。已淘汰。 `pip_requirements_file`使用參數。這可與參數搭配 `pip_packages` 使用。請指定 `pip_requirements_file_path` 或 `pip_requirements_file`。如果同時指定兩者， `pip_requirements_file` 則會使用。
pip_requirements_file 必要	str pip 需求文字檔的相對路徑。這可與參數搭配 `pip_packages` 使用。
environment_variables 必要	dict 環境變數名稱和值的字典。這些環境變數會在執行使用者指令碼的程序上設定。
environment_definition 必要	Environment 實驗的環境定義。其中包含 PythonSection、DockerSection 和環境變數。任何未透過其他參數直接公開至估算器建構的環境選項，都可以使用此參數來設定。如果指定此參數，它將會優先于其他環境相關參數，例如 `use_gpu` 、 `custom_docker_image` 、 `conda_packages` 或 `pip_packages` 。錯誤將會回報不正確組合。
inputs 必要	list 要做為輸入的 DataReference 或 DatasetConsumptionConfig 物件清單。
source_directory_data_store 必要	Datastore 專案共用的備份資料存放區。
shm_size 必要	Docker 容器的共用記憶體區塊大小。如果未設定，則為預設值
_disable_validation 必要	bool 在執行提交之前停用腳本驗證。預設值為 True。
_show_lint_warnings 必要	bool 顯示腳本 linting 警告。預設值是 False。
_show_package_warnings 必要	bool 顯示套件驗證警告。預設值是 False。

共用方式為

Estimator 類別

建構函式

參數

意見反應

其他資源