JupyterLab 版本控制

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

Amazon SageMaker Studio Classic 界面基于此 JupyterLab，它是一个基于 Web 的交互式开发环境，用于存放笔记本、代码和数据。Studio 经典版仅支持使用 JupyterLab 3.

如果您使用 2022 年 8 月 31 日之前的或 23 年 2 月 22 日 AWS Management Console 之前的创建域名和用户配置文件，则您的 Stu AWS Command Line Interface dio Classic 实例默认为 1。 JupyterLab 2024 年 1 月 7 日之后，您将无法创建任何运行 1 的 Studio Classic 应用程序。 JupyterLab

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 版本，请参阅亚马逊 SageMaker AI 域名概述。 

来自 AWS CLI

您可以使用选择要在域或用户配置文件级别上使用的默认 JupyterLab 版本 AWS CLI。 

要使用设置默认 JupyterLab 版本 AWS CLI，您必须在命令中包含所需默认 JupyterLab 版本的 ARN。 AWS CLI 此 ARN 因 A SageMaker I 域的版本和区域而异。 

下表列出了每个区域 ARNs 的可用 JupyterLab 版本：

创建或更新域

您可以通过调用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"
    }
  }
}'

创建或更新用户配置文件

通过调用CreateUserProfile或UpdateUserProfile并传递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"
    }
  }
}'

以下内容显示了如何使用以下方法更新用户配置文件以使用 JupyterLab 3 作为默认值 AWS CLI：

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 Server 扩展程序，则必须修改脚本使其与 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