可用選項 - Amazon SageMaker AI

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

可用選項

下表顯示您可以用來自訂筆記本任務的所有可用選項，無論您是在 Studio、本機 Jupyter 環境，還是使用 SageMaker Python SDK 執行筆記本任務。資料表包含自訂選項的類型、描述、有關如何使用選項的其他指導方針、Studio 中選項的欄位名稱 (如果可用)，以及 SageMaker Python SDK 中筆記本任務步驟的參數名稱 (如果可用)。

對於某些選項，您也可以預先設定自訂預設值，這樣您就不必在每次設定筆記本任務時指定這些值。對於 Studio，這些選項包括角色、輸入資料夾、輸出資料夾和 KMS 金鑰 ID，並在下表中指定。如果您為這些選項預先設定自訂預設值，當您建立筆記本任務時，這些欄位會預先填入建立任務表單中。如需如何在 Studio 和本機 Jupyter 環境中建立自訂預設值的詳細資訊，請參閱設定本機筆記本的預設選項。

SageMaker SDK 也提供您設定智慧型預設值的選項，讓您在建立 NotebookJobStep 時不必指定這些參數。這些參數為 role、s3_root_uri、s3_kms_key、volume_kms_key、subnets、security_group_ids，並在下表中指定。如需如何設定智慧型預設值的相關資訊，請參閱設定預設選項。

自訂選項 Description Studio 特定指南 本機 Jupyter 環境指南 SageMaker Python SDK 指導方針
任務名稱 應該出現在筆記本任務儀表板中的任務名稱。 欄位任務名稱。 與 Studio 相同。 參數 notebook_job_name。預設為 None。
映像 用來在所選計算類型上以非互動方式執行筆記本的容器映像。 欄位映像。此欄位預設為筆記本的目前映像。如有需要，可以將此欄位從預設值變更為自訂值。如果 Studio 無法推論此值，表單會顯示驗證錯誤，要求您指定此值。此映像可以是自訂映像、您自己的映像，也可以是可用的 Amazon SageMaker 映像。如需筆記本排程器支援的可用 SageMaker 映像清單，請參閱Amazon SageMaker 映像可與 Studio Classic 筆記本搭配使用。 欄位映像。此欄位需要 Docker 映像的 ECR URI，該映像可以在所選計算類型上執行提供的筆記本。依預設，排程器延伸模組會使用預先建立的 SageMaker AI Docker 映像檔 - 基本 Python 2.0。這是 DockerHub 搭配 boto3 AWS CLI和 Python 3 核心的官方 Python 3.8 映像。您也可以提供符合筆記本自訂映像規格的任何 ECR URI。如需詳細資訊，請參閱Amazon SageMaker Studio Classic 的自訂 Amazon SageMaker 映像規格。此映像應具有筆記本執行所需的所有核心和程式庫。 「必要」。參數 image_uri。ECR 上 Docker 映像檔的 URI 位置。您可以使用特定的 SageMaker Distribution 映像或基於這些映像的自訂映像，也可以使用您自己的映像，此映像已預先安裝筆記本任務相依性且符合額外要求。如需詳細資訊，請參閱SageMaker AI Python SDK 筆記本任務的映像限制條件。
執行個體類型 用來執行筆記本任務的 EC2 執行個體類型。筆記本任務使用 SageMaker 訓練任務作為運算層，因此指定的執行個體類型應為 SageMaker 訓練支援的執行個體類型。 欄位運算類型。預設為 ml.m5.large。 與 Studio 相同。 參數 instance_type。預設為 ml.m5.large。
核心 用來執行筆記本工作的 Jupyter 核心。 欄位核心。此欄位預設為筆記本的目前核心。如有需要，可以將此欄位從預設值變更為自訂值。如果 Studio 無法推論此值，表單會顯示驗證錯誤，要求您指定此值。 欄位核心。此核心應存在於映像中，並遵循 Jupyter 內核規範。此欄位預設為在基本 Python 2.0 映像中的 SageMaker 核心。如有需要，可以將此欄位從預設值變更為自訂值。 「必要」。參數 kernel_name。此核心應存在於映像中，並遵循 Jupyter 內核規範。若要查看映像的核心識別碼，請參閱 (LINK)。
SageMaker AI 工作階段 獲委派 SageMaker AI 服務呼叫的基礎 SageMaker AI 工作階段。 N/A N/A 參數 sagemaker_session。如果未指定，則會使用預設組態鏈結建立一個。
角色 ARN 角色的 Amazon Resource Name (ARN) 與筆記本工作搭配使用。 欄位角色 ARN。此欄位預設為 Studio 執行角色。如有需要，可以將此欄位從預設值變更為自訂值。
注意

如果 Studio 無法推論此值，則角色 ARN 欄位為空白。在這種情況下，請插入您要使用的 ARN。

 欄位角色 ARN。此欄位預設為任何字首為 SagemakerJupyterScheduler 的角色。如果您有多個帶有字首的角色，則擴展功能會從中選擇一個。如有需要，可以將此欄位從預設值變更為自訂值。對於此欄位，您可以設定自己的使用者預設值，該預設值會在您建立新工作定義時預先填入。如需詳細資訊，請參閱設定本機筆記本的預設選項。 參數 role。如果 SDK 正在 SageMaker 筆記本或 SageMaker Studio 筆記本中執行，則預設為 SageMaker AI 預設 IAM 角色。否則，它會擲回 ValueError。允許智慧型預設值。
輸入筆記本 您要排程執行的筆記本名稱。 「必要」。欄位輸入檔案。 與 Studio 相同。 必要參數 input_notebook。
輸入資料夾 包含您輸入內容的資料夾。工作輸入 (包括輸入筆記本和任何選用的啟動或初始化指令碼) 都放在此資料夾中。 欄位輸入資料夾。如果您未提供資料夾，排程器會為您的輸入建立預設的 Amazon S3 儲存貯體。 與 Studio 相同。對於此欄位，您可以設定自己的使用者預設值，該預設值會在您建立新工作定義時預先填入。如需詳細資訊，請參閱設定本機筆記本的預設選項。 N/A。輸入資料夾位於參數 s3_root_uri 指定的位置內。
輸出資料夾 包含輸內容的資料夾。工作輸出 (包括輸出筆記本和日誌) 都放在此文件夾中。 欄位輸出資料夾。如果您未指定資料夾，排程器會為您的輸出建立預設的 Amazon S3 儲存貯體。 與 Studio 相同。對於此欄位，您可以設定自己的使用者預設值，該預設值會在您建立新工作定義時預先填入。如需詳細資訊，請參閱設定本機筆記本的預設選項。 N/A。輸出資料夾位於參數 s3_root_uri 指定的位置內。
Parameters 要傳遞至筆記本任務之變數和值的字典。 欄位參數。您需要參數化筆記本，才能接受參數。 與 Studio 相同。 參數 parameters。您需要參數化筆記本，才能接受參數。
其他 (檔案或資料夾) 相依性 筆記本任務上傳至 s3 暫存資料夾的檔案或資料夾相依性清單。 不支援。 不支援。 參數 additional_dependencies。筆記本任務會將這些相依性上傳至 S3 暫存資料夾，以便可在執行期間使用它們。
S3 根 URI 包含您輸入內容的資料夾。工作輸入 (包括輸入筆記本和任何選用的啟動或初始化指令碼) 都放在此資料夾中。此 S3 儲存貯體必須位於您用來執行筆記本任務的同一 AWS 帳戶 中。 N/A。使用輸入資料夾和輸出資料夾。 與 Studio 相同。 參數 s3_root_uri。預設為預設 S3 儲存貯體。允許智慧型預設值。
環境變數 您要覆寫的任何現有環境變數，或是您要在筆記本中引入和使用的新環境變數。 欄位環境變數。 與 Studio 相同。 參數 environment_variables。預設為 None。
Tags (標籤) 連接至任務的標籤清單。 N/A N/A 參數 tags。預設為 None。您的標籤控制 Studio UI 如何擷取和顯示管道所建立的任務。如需詳細資訊，請參閱在 Studio UI 儀表板中檢視您的筆記本任務。
啟動指令碼 在筆記本啟動功能表中預先載入的指令碼，您可以選擇在執行筆記本之前執行。 欄位啟動指令碼。選取啟動時在映像上執行的生命週期組態 (LCC) 指令碼。
注意

啟動指令碼會在 Studio 環境之外的 Shell 中執行。因此，此指令碼無法依賴 Studio 本機儲存空間、環境變數或應用程式中繼資料 (在 /opt/ml/metadata 中)。此外，如果您同時使用啟動指令碼和初始化指令碼，啟動指令碼會先執行。

 不支援。 不支援。
初始化指令碼 筆記本啟動時，您可以執行的本機指令碼的路徑。 欄位初始化指令碼。輸入本機指令碼或生命週期組態 (LCC) 指令碼所在的 EFS 檔案路徑。如果您同時使用啟動指令碼和初始化指令碼，啟動指令碼會先執行。
注意

初始化指令碼來自與筆記本工作相同的筆記本。先前描述的啟動指令碼並非如此。此外，如果您同時使用啟動指令碼和初始化指令碼，啟動指令碼會先執行。

 欄位初始化指令碼。輸入本機指令碼或生命週期組態 (LCC) 指令碼所在的本機檔案路徑。 參數 initialization_script。預設為 None。
重試次數上限 Studio 嘗試重新執行失敗工作的執行次數。 欄位重試次數上限。預設值為 1。 與 Studio 相同。 參數 max_retry_attempts。預設值為 1。
最大執行期 (以秒為單位) 筆記本工作在停止前可以執行的最大時長 (以秒為單位)。如果您同時設定最大執行期和重試嘗試次數上限，則每次重試都會套用執行期。如果工作未在此時間內完成，則其狀態會設定為 Failed。 欄位執行時間上限 (以秒為單位) 預設為 172800 seconds (2 days)。 與 Studio 相同。 參數 max_runtime_in_seconds。預設為 172800 seconds (2 days)。
重試政策 重試政策的清單，這些政策管控失敗時要採取的動作。 不支援。 不支援。 參數 retry_policies。預設為 None。
新增 Step 或 StepCollection 相依性 任務依賴的 Step 或 StepCollection 名稱或執行個體清單。 不支援。 不支援。 參數 depends_on。預設為 None。使用此項來定義管道圖中步驟之間的明確相依性。
磁碟區大小 用於在訓練期間存放輸入和輸出資料的儲存磁碟區大小，以 GB 為單位。 不支援。 不支援。 參數 volume_size。預設為 30GB。
加密容器之間的流量 指定是否針對訓練任務加密訓練容器之間流量的旗標。 不適用。預設啟用。 不適用。預設啟用。 參數 encrypt_inter_container_traffic。預設為 True。
設定工作加密 此指示器表示您想要為筆記本工作輸出、工作執行個體磁碟區或兩者進行加密。 欄位設定任務加密。勾選此方塊可選擇加密。如果未勾選此方塊，則工作輸出會使用帳戶的預設 KMS 金鑰加密，且工作執行個體磁碟區不會加密。 與 Studio 相同。 不支援。
輸出加密 KMS 金鑰 如果您想要對用於筆記本工作輸出的加密金鑰進行自訂，可以使用此 KMS 金鑰。此欄位僅在勾選了設定工作加密時適用。 欄位輸出加密 KMS 金鑰。如果未指定此欄位，筆記本工作輸出會使用預設的 Amazon S3 KMS 金鑰，使用 SSE-KMS 加密。此外，如果您自行建立 Amazon S3 儲存貯體並使用加密，系統會保留您的加密方法。 與 Studio 相同。對於此欄位，您可以設定自己的使用者預設值，該預設值會在您建立新工作定義時預先填入。如需詳細資訊，請參閱設定本機筆記本的預設選項。 參數 s3_kms_key。預設為 None。允許智慧型預設值。
工作執行個體磁碟區加密 KMS 金鑰 如果您想要對工作執行個體磁碟區進行加密，可以使用此 KMS 金鑰。此欄位僅在勾選了設定工作加密時適用。 欄位工作執行個體磁碟區加密 KMS 金鑰。 欄位工作執行個體磁碟區加密 KMS 金鑰。對於此欄位，您可以設定自己的使用者預設值，該預設值會在您建立新工作定義時預先填入。如需詳細資訊，請參閱設定本機筆記本的預設選項。 參數 volume_kms_key。預設為 None。允許智慧型預設值。
使用 Virtual Private Cloud 執行此工作 (適用於 VPC 使用者) 此指示器表示您想要在 Virtual Private Cloud (VPC) 中執行此工作。為了獲得更好的安全性，建議您使用私有 VPC。 欄位使用 Virtual Private Cloud 執行此任務 如果您要使用 VPC，請勾選此方塊。至少，請建立下列 VPC 端點，讓您的筆記本任務能夠私下連線到這些 AWS 資源：
如果選擇使用 VPC，則您需要在下列選項中至少指定一個私有子網路和至少一個安全群組。如果不使用任何私有子網路，則您需要考慮其他組態選項。如需詳細資訊，請參閱限制和考量事項中不受支援的公用 VPC 子網路。		 與 Studio 相同。 N/A
子網路 (適用於 VPC 使用者) 您的子網路。此欄位必須包含至少一個子網路，最多五個子網路，而且您提供的所有子網路都應該為私有。如需詳細資訊，請參閱限制和考量事項中不受支援的公用 VPC 子網路。 欄位子網路。此欄位預設為與 Studio 網域相關聯的子網路，但您可以視需要對此欄位進行變更。 欄位子網路。排程器無法偵測到您的子網路，因此您必須輸入為 VPC 設定的任何子網路。 參數 subnets。預設為 None。允許智慧型預設值。
安全群組 (適用於 VPC 使用者) 您的安全群組。此欄位至少必須包含一個安全群組，最多 15 個安全群組。如需詳細資訊，請參閱限制和考量事項中不受支援的公用 VPC 子網路。 欄位安全群組。此欄位預設為與網域 VPC 相關聯的安全群組，但您可以視需要對此欄位進行變更。 欄位安全群組。排程器無法偵測到您的安全群組，因此您必須輸入為 VPC 設定的任何安全群組。 參數 security_group_ids。預設為 None。允許智慧型預設值。
名稱 筆記本任務步驟的名稱。 N/A N/A 參數 name。如果未指定，其會衍生自筆記本檔案名稱。
顯示名稱 應該出現在管道執行清單中的任務名稱。 N/A N/A 參數 display_name。預設為 None。
Description 任務的描述。 N/A N/A 參數 description。