JupyterLab のバージョニング

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon SageMaker Studio Classic のインターフェイスは、JupyterLab に基づいています。JupyterLab は、ノートブック、コード、データ用のウェブベースのインタラクティブな開発環境です。Studio Classic は JupyterLab 3 の使用のみをサポートしています。

AWS Management Console より前の または 08/31/2022 より前の を使用してドメインとユーザープロファイルを作成した場合 AWS Command Line Interface 02/22/23、Studio Classic インスタンスはデフォルトで JupyterLab 1 になります。2024 年 7 月 1 日以降は、JupyterLab 1 を実行する Studio Classic アプリケーションは作成できません。

JupyterLab 3

JupyterLab 3 には、過去のバージョンで利用できない次の機能が含まれています。これらの機能の詳細については、「JupyterLab 3.0 is released!」を参照してください。

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 のデフォルトバージョンを設定する

以下のセクションでは、コンソールまたは AWS CLIを使用して、Studio Classic の JupyterLab のデフォルトバージョンを設定する方法を説明します。 

コンソールから

リソースの作成中に、使用するデフォルトの JupyterLab バージョンをドメインレベルまたはユーザープロファイルレベルで選択できます。コンソールを使用してデフォルトの JupyterLab のバージョンを設定するには、「Amazon SageMaker AI ドメインの概要」を参照してください。 

から AWS CLI

AWS CLIを使用して、使用するデフォルトの JupyterLab バージョンをドメインレベルまたはユーザープロファイルレベルで選択できます。 

を使用してデフォルトの JupyterLab バージョンを設定するには AWS CLI、 AWS CLI コマンドの一部として目的のデフォルトの JupyterLab バージョンの ARN を含める必要があります。この ARN は、SageMaker AI ドメインのバージョンとリージョンによって異なります。 

次の表に、各リージョンで利用可能な JupyterLab バージョンの ARN を示します。

ドメインの作成または更新

CreateDomain または UpdateDomain を呼び出して UserSettings.JupyterServerAppSettings.DefaultResourceSpec.SageMakerImageArn フィールドを渡すことで、デフォルトの JupyterServer バージョンをドメインレベルで設定できます。

AWS CLIを使用した、JupyterLab 3 をデフォルトとするドメインの作成方法は次のとおりです。

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"
    }
  }
}'

AWS CLIを使用した、JupyterLab 3 をデフォルトとするドメインの更新方法は次のとおりです。

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 バージョンをユーザープロファイルレベルで設定できます。

AWS CLIを使用した、JupyterLab 3 をデフォルトとする既存のドメインでのユーザープロファイルの作成方法は次のとおりです。

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 Server の拡張機能をインストールする

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