Use external resources in Amazon SageMaker Studio Lab - Amazon SageMaker AI
Use GitHub resourcesAdd an Open in Studio Lab button to your notebookImport files from your computerConnect to Amazon S3

Use external resources in Amazon SageMaker Studio Lab

With Amazon SageMaker Studio Lab, you can integrate external resources, such as Jupyter notebooks and data, from Git repositories and Amazon S3. You can also add an Open in Studio Lab button to your GitHub repo and notebooks. This button lets you clone your notebooks directly from Studio Lab.

The following topics show how to integrate external resources.

Use GitHub resources

Studio Lab offers integration with GitHub. With this integration, you can clone notebooks and repositories directly to your Studio Lab project.

The following topics give information about how to use GitHub resources with Studio Lab.

Studio Lab sample notebooks

To get started with a repository of sample notebooks tailored for Studio Lab, see Studio Lab Sample Notebooks.

This repository provides notebooks for the following use cases and others.

  • Computer vision

  • Connecting to AWS

  • Creating custom environments

  • Geospatial data analysis

  • Natural language processing

  • Using R

Clone a GitHub repo

To clone a GitHub repo to your Studio Lab project, follow these steps.

  1. Start your Studio Lab project runtime. For more information on launching Studio Lab project runtime, see Start your project runtime.

  2. In Studio Lab, choose the File Browser icon ( Black square icon representing a placeholder or empty image. ) on the left menu, so that the File Browser panel shows on the left.

  3. Navigate to your user directory by choosing the file icon beneath the file search bar.

  4. Select the Git icon ( Black square icon representing a placeholder or empty image. ) from the left menu to open a new dropdown menu.

  5. Choose Clone a Repository.

  6. Paste the repository's URL under Git repository URL (.git).

  7. Select Clone.

Clone individual notebooks from GitHub

To open a notebook in Studio Lab, you must have access to the repo that the notebook is in. The following examples describe Studio Lab permission-related behavior in various situations.

  • If a repo is public, you can automatically clone the notebook into your project from the Studio Lab preview page.

  • If a repo is private, you are prompted to sign in to GitHub from the Studio Lab preview page. If you have access to a private repo, you can clone the notebook into your project.

  • If you don't have access to a private repo, you cannot clone the notebook from the Studio Lab preview page.

The following sections show two options for you to copy a GitHub notebook in your Studio Lab project. These options depend on whether the notebook has an Open in Studio Lab button.

Option 1: Copy notebook with an Open in Studio Lab button

The following procedure shows how to copy a notebook that has an Open in Studio Lab button. If you want to add this button to your notebook, see Add an Open in Studio Lab button to your notebook.

  1. Sign in to Studio Lab following the steps in Sign in to Studio Lab.

  2. In a new browser tab, navigate to the GitHub notebook that you want to clone.

  3. In the notebook, select the Open in Studio Lab button to open a new page in Studio Lab with a preview of the notebook.

  4. If your project runtime is not already running, start it by choosing the Start runtime button at the top of the preview page. Wait for the runtime to start before proceeding to the next step.

  5. After your project runtime has started, select Copy to project to open your project runtime in a new browser tab.

  6. In the Copy from GitHub? dialog box, select Copy notebook only. This copies the notebook file to your project.

Option 2: Clone any GitHub notebook

The following procedure shows how to copy any notebook from GitHub.

  1. Navigate to the notebook in GitHub.

  2. In the browser’s address bar, modify the notebook URL, as follows.

    # Original URL
https://github.com/<PATH_TO_NOTEBOOK>

# Modified URL 
https://studiolab.sagemaker.aws/import/github/<PATH_TO_NOTEBOOK>

  3. Navigate to the modified URL. This opens a preview of the notebook in Studio Lab.

  4. If your project runtime is not already running, start it by choosing the Start runtime button at the top of the preview page. Wait for the runtime to start before proceeding to the next step.

  5. After your project runtime has started, select Copy to project to open your project runtime in a new browser tab.

  6. In the Copy from GitHub? dialog box, select Copy notebook only to copy the notebook file to your project.

Add an Open in Studio Lab button to your notebook

When you add the Open in Studio Lab button to your notebooks, others can clone your notebooks or repositories directly to their Studio Lab projects. If you are sharing your notebook within a public GitHub repository, your content will be publicly readable. Do not share private content, such as AWS access keys or AWS Identity and Access Management credentials, in your notebook.

To add the functional Open in Studio Lab button to your Jupyter notebook or repository, add the following markdown to the top of your notebook or repository. 

[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/<PATH_TO_YOUR_NOTEBOOK_ON_GITHUB>)

Import files from your computer

The following steps show how to import files from your computer to your Studio Lab project. 

  1. Open the Studio Lab project runtime.

  2. Open the File Browser panel.

  3. In the actions bar of the File Browser panel, select the Upload Files button.

  4. Select the files that you want to upload from your local machine.

  5. Select Open.

Alternatively, you can drag and drop files from your computer into the File Browser panel.

Connect to Amazon S3

The AWS CLI enables AWS integration in your Studio Lab project. With this integration, you can pull resources from Amazon S3 to use with your Jupyter notebooks.

To use AWS CLI with Studio Lab, complete the following steps. For a notebook that outlines this integration, see Using Studio Lab with AWS Resources.

  1. Install the AWS CLI following the steps in  Installing or updating the latest version of the AWS CLI.

  2. Configure your AWS credentials by following the steps in  Quick setup. The role for your AWS account must have permissions to access the Amazon S3 bucket that you are copying data from.

  3. From your Jupyter notebook, clone resources from the Amazon S3 bucket, as needed. The following command shows how to clone all resources from an Amazon S3 path to your project. For more information, see the AWS CLI Command Reference.

    !aws s3 cp s3://<BUCKET_NAME>/<PATH_TO_RESOURCES>/ <PROJECT_DESTINATION_PATH>/ --recursive