Skip to content

Commit

Permalink
added instructions for installing extensions in JupyterLab 3
Browse files Browse the repository at this point in the history
  • Loading branch information
durgasury committed Jun 7, 2022
1 parent 228f597 commit 8782fe9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@

3. Be careful using the "sudo" command in KernelGateways scripts. Not all kernels runs as root by default. If the kernel run as root, don't use the sudo command. Use sudo command only when the Kernel runs as a non-root default user.

4. If you are installing Jupyter lab or Jupyter server extensions, ensure they're compatible with both supported versions of JupyterLab in Studio. In short, you can directly install extensions in JupyterLab 1, and you will need to activate the `studio` conda environment to install extensions in JupyterLab 3. See [Installing JupyterLab and Jupyter Server extensions](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-jl.html#studio-jl-install) for details.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Lifecycle Configurations provide a mechanism to customize the Jupyter Server and

* [git-clone-repo](scripts/git-clone-repo) - Checks out a Git repository under the user's home folder automatedly when the Jupter server starts
* [install-autoshutdown-server-extension](scripts/install-autoshutdown-server-extension) (Recommended) - Installs only the server part of idle-kernel shutdown extension. No external dependencies to install, recommended to use in VPCOnly mode with restricted Internet connectivity. Idle timelimit has to be set using Life Cycle Configuration script.
* [install-autoshutdown-extension](scripts/install-autoshutdown-extension) - Installs the auto idle-kernel shutdown extension on the Jupyter Server. This install allows users to set idle timeout limit using the UI.
* [install-autoshutdown-extension](scripts/install-autoshutdown-extension) - Installs the auto idle-kernel shutdown extension on the Jupyter Server. This install allows users to set idle timeout limit using the UI. ***Note***: *The UI plugin is only compatible with JupyterLab v1.0. See [JupyterLab versioning](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-jl.html) for JupyterLab versions in SageMaker Studio.*
* [install-pip-package-on-kernel](scripts/install-pip-package-on-kernel) - Installs a python package with pip on a Studio Kernel
* [set-git-config](scripts/set-git-config) - This script sets the username and email address in Git config.
* [set-git-credentials](scripts/set-git-credentials) - Adds the user's git credentials to Secret Manager and configures git to fetch the credentials from there when needed
Expand Down
9 changes: 9 additions & 0 deletions scripts/install-autoshutdown-server-extension/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Auto shutdown server extension

The process for installing JupyterLab and Jupyter Server extensions differs depending on the JupyterLab version of your Studio instance. In JupyterLab 1, you can install extensions without activating any conda environment.

In JupyterLab 3, you must activate the `studio` conda environment before installing extensions. The script for adding the auto-shutdown extension has been updated to work with both versions of JupyterLab.

For more information, see [Installing JupyterLab and Jupyter Server extensions](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-jl.html#studio-jl-install).

You can read more about the launch in the [blog post here](https://aws.amazon.com/blogs/machine-learning/amazon-sagemaker-studio-and-sagemaker-notebook-instance-now-come-with-jupyterlab-3-notebooks-to-boost-developer-productivity/).

0 comments on commit 8782fe9

Please sign in to comment.