JupyterLab 版本控制

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

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

Amazon SageMaker Studio Classic 介面是以 JupyterLab 為基礎，JupyterLab 是一種適用於筆記本、程式碼和資料的 Web 型互動式開發環境。Studio Classic 僅支援使用 JupyterLab 3。

如果您使用 08/31/2022 AWS Management Console 之前的 或使用 02/22/23 AWS Command Line Interface 之前的 建立網域和使用者設定檔，則您的 Studio Classic 執行個體預設為 JupyterLab 1。07/01/2024 之後，您無法建立執行 JupyterLab 1 的任何 Studio Classic 應用程式。

JupyterLab 3

JupyterLab 3 包含了先前版本中未提供的功能。如需這些功能的更多相關資訊，請參閱 JupyterLab 3.0 已發佈！。

JupyterLab 3 的重要變更

使用 JupyterLab 3 時，請注意下列事項：

使用 IAM 政策條件索引鍵限制預設的 JupyterLab 版本

您可以使用 IAM 政策條件索引鍵來限制使用者可以啟動的 JupyterLab 版本。

下列政策說明如何在網域層級限制 JupyterLab 版本。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Block users from creating JupyterLab 3 apps at the domain level",
            "Effect": "Deny",
            "Action": [
                "sagemaker:CreateDomain",
                "sagemaker:UpdateDomain"
            ],
            "Resource": "*",
            "Condition": {
                "ForAnyValue:StringLike": {
                    "sagemaker:ImageArns": "*image/jupyter-server-3"
                }
            }
        }
    ]
}

下列政策說明如何在使用者設定檔層級限制 JupyterLab 版本。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Block users from creating JupyterLab 3 apps at the user profile level",
            "Effect": "Deny",
            "Action": [
                "sagemaker:CreateUserProfile",
                "sagemaker:UpdateUserProfile"
            ],
            "Resource": "*",
            "Condition": {
                "ForAnyValue:StringLike": {
                    "sagemaker:ImageArns": "*image/jupyter-server-3"
                }
            }
        }
    ]
}

下列政策說明如何在應用程式層級限制 JupyterLab 版本。CreateApp 要求必須包含映像 ARN，此政策才能套用。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Block users from creating JupyterLab 3 apps at the application level",
            "Effect": "Deny",
            "Action": "sagemaker:CreateApp",
            "Resource": "*",
            "Condition": {
                "ForAnyValue:StringLike": {
                    "sagemaker:ImageArns": "*image/jupyter-server-3"
                }
            }
        }
    ]
}

設定預設 JupyterLab 版本

下列各節說明如何使用主控台或 設定 Studio Classic 的預設 JupyterLab 版本 AWS CLI。 

從主控台

您可以在資源建立期間，選取要在網域或使用者設定檔層級上使用的預設 JupyterLab 版本。若要使用主控台預設 JupyterLab 預設版本，請參閱Amazon SageMaker AI 網域概觀。 

從 AWS CLI

您可以使用 選取要在網域或使用者設定檔層級上使用的預設 JupyterLab 版本 AWS CLI。 

若要使用 設定預設 JupyterLab 版本 AWS CLI，您必須將所需預設 JupyterLab 版本的 ARN 納入 AWS CLI 命令的一部分。此 ARN 會根據 SageMaker AI 網域的版本和區域而有所不同。 

下資料表列出了每個地區可用的 JupyterLab 版本的 ARN：

建立或更新網域

您可以透過叫用 CreateDomain 或 UpdateDomain 並傳遞 UserSettings.JupyterServerAppSettings.DefaultResourceSpec.SageMakerImageArn欄位，在網域層級設定預設 JupyterServer 版本。

以下說明如何使用 ，以 JupyterLab 3 做為預設網域 AWS CLI：

aws --region <REGION> \
sagemaker create-domain \
--domain-name <NEW_DOMAIN_NAME> \
--auth-mode <AUTHENTICATION_MODE> \
--subnet-ids <SUBNET-IDS> \
--vpc-id <VPC-ID> \
--default-user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

以下說明如何使用 更新網域以使用 JupyterLab 3 做為預設值 AWS CLI：

aws --region <REGION> \
sagemaker update-domain \
--domain-id <YOUR_DOMAIN_ID> \
--default-user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

建立或更新使用者設定檔

您可以調用建立使用者設定檔或更新使用者設定檔並傳遞 UserSettings.JupyterServerAppSettings.DefaultResourceSpec.SageMakerImageArn 欄位，在使用者設定檔層級設定預設 JupyterServer 版本。

以下說明如何使用 ，在現有網域上以 JupyterLab 3 做為預設值來建立使用者設定檔 AWS CLI：

aws --region <REGION> \
sagemaker create-user-profile \
--domain-id <YOUR_DOMAIN_ID> \
--user-profile-name <NEW_USERPROFILE_NAME> \
--query UserProfileArn --output text \
--user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

以下說明如何使用 AWS CLI更新使用者設定檔以使用 JupyterLab 3 作為預設值：

aws --region <REGION> \
sagemaker update-user-profile \
 --domain-id <YOUR_DOMAIN_ID> \
 --user-profile-name <EXISTING_USERPROFILE_NAME> \
--user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

從主控台檢視和更新應用程式的 JupyterLab 版本

以下說明如何檢視及更新 JupyterLab 版本的應用程式。

安裝 JupyterLab 和 Jupyter 伺服器延伸模組

在 JupyterLab 3 中，您必須先啟動studio conda 環境才能安裝延伸模組。如果您要在 Studio Classic 中或使用生命週期組態指令碼安裝延伸模組，則此方法會有所不同。

在 Studio Classic 中安裝延伸模組

若要在 Studio Classic 中安裝擴充功能，您必須先啟用studio環境，才能安裝擴充功能。

# Before installing extensions
conda activate studio

# Install your extensions
pip install <JUPYTER_EXTENSION>

# After installing extensions
conda deactivate

使用生命週期組態指令碼安裝延伸模組

如果您要在生命週期組態指令碼中安裝 JupyterLab 和 Jupyter 伺服器延伸模組，您必須修改指令碼，使其能夠與 JupyterLab 3 搭配使用。以下區段顯示了現有和新的生命週期組態指令碼所需的代碼。

現有生命週期組態指令碼

如果您要重複使用必須與這兩個版本的 JupyterLab 一起使用的現有生命週期組態指令碼，請在指令碼中使用下列程式碼：

# Before installing extension
export AWS_SAGEMAKER_JUPYTERSERVER_IMAGE="${AWS_SAGEMAKER_JUPYTERSERVER_IMAGE:-'jupyter-server'}"
if [ "$AWS_SAGEMAKER_JUPYTERSERVER_IMAGE" = "jupyter-server-3" ] ; then
   eval "$(conda shell.bash hook)"
   conda activate studio
fi;

# Install your extensions
pip install <JUPYTER_EXTENSION>


# After installing extension
if [ "$AWS_SAGEMAKER_JUPYTERSERVER_IMAGE" = "jupyter-server-3" ]; then
   conda deactivate
fi;

新生命週期組態指令碼

如果您正在撰寫只使用 JupyterLab 3 的新生命週期組態指令碼，您可以在指令碼中使用下列程式碼：

# Before installing extension
eval "$(conda shell.bash hook)"
conda activate studio


# Install your extensions
pip install <JUPYTER_EXTENSION>


conda deactivate