JupyterLab UI overview
JupyterLab is a web-based user interface for and is tightly integrated into ÃÛ¶¹ÊÓƵ Experience Platform. It provides an interactive development environment for data scientists to work with Jupyter Notebooks, code, and data.
This document provides an overview of JupyterLab and its features as well as instructions to perform common actions.
JupyterLab on Experience Platform
Experience Platform’s JupyterLab integration is accompanied with architectural changes, design considerations, customized notebook extensions, pre-installed libraries, and an ÃÛ¶¹ÊÓƵ-themed interface.
The following list outlines some of the features that are unique to JupyterLab on Platform:
Integration with other Platform services service-integration
Standardization and interoperability are key concepts behind Experience Platform. The integration of JupyterLab on Platform as an embedded IDE allows it to interact with other Platform services, enabling you to utilize Platform to its full potential. The following Platform services are available in JupyterLab:
- Catalog Service: Access and explore datasets with read and write functionalities.
- Query Service: Access and explore datasets using SQL, providing lower data access overheads when dealing with large amounts of data.
- Sensei ML Framework: Model development with the ability to train and score data, as well as recipe creation with a single click.
- Experience Data Model (XDM): Standardization and interoperability are key concepts behind ÃÛ¶¹ÊÓƵ Experience Platform. , driven by ÃÛ¶¹ÊÓƵ, is an effort to standardize customer experience data and define schemas for customer experience management.
Key features and common operations
Information regarding key features of JupyterLab and instructions on performing common operations are provided in the sections below:
Access JupyterLab access-jupyterlab
In , select Notebooks from the left navigation column. Allow some time for JupyterLab to fully initialize.
JupyterLab interface jupyterlab-interface
The JupyterLab interface consists of a menu bar, a collapsible left sidebar, and the main work area containing tabs of documents and activities.
Menu bar
The menu bar at the top of the interface has top-level menus that expose actions available in JupyterLab with their keyboard shortcuts:
- File: Actions related to files and directories
- Edit: Actions related to editing documents and other activities
- View: Actions that alter the appearance of JupyterLab
- Run: Actions for running code in different activities such as notebooks and code consoles
- Kernel: Actions for managing kernels
- Tabs: A list of open documents and activities
- Settings: Common settings and an advanced settings editor
- Help: A list of JupyterLab and kernel help links
Left sidebar
The left sidebar contains clickable tabs that provide access to the following features:
- File browser: A list of saved notebook documents and directories
- Data explorer: Browse, access, and explore datasets and schemas
- Running kernels and terminals: A list of active kernel and terminal sessions with the ability to terminate
- Commands: A list of useful commands
- Cell inspector: A cell editor that provides access to tools and metadata useful for setting up a notebook for presentation purposes
- tabs: A list of open tabs
Select a tab to expose its features, or select on an expanded tab to collapse the left sidebar as demonstrated below:
Main work area
The main work area in JupyterLab enables you to arrange documents and other activities into panels of tabs that can be resized or subdivided. Drag a tab to the center of a tab panel to migrate the tab. Divide a panel by dragging a tab to the left, right, top, or bottom of the panel:
GPU and memory server configuration in Python/R
In JupyterLab select the gear icon in the top-right corner to open Notebook server configuration. You can toggle GPU on and allocate the amount of memory you need by using the slider. The amount of memory you can allocate depends on how much your organization has provisioned. Select Update configs to save.
Terminate & restart JupyterLab
In JupyterLab, you can terminate your session to prevent further resources from being used. Start by selecting the power icon
To restart JupyterLab, select the restart icon
Code cells code-cells
Code cells are the primary content of notebooks. They contain source code in the language of the notebook’s associated kernel and the output as a result of executing the code cell. An execution count is displayed to the right of every code cell which represents its order of execution.
Common cell actions are described below:
-
Add a cell: Click the plus symbol (+) from the notebook menu to add an empty cell. New cells are placed under the cell that is currently being interacted with, or at the end of the notebook if no particular cell is in focus.
-
Move a cell: Place your cursor to the right of the cell you wish to move, then click and drag the cell to a new location. Additionally, moving a cell from one notebook to another replicates the cell along with its contents.
-
Execute a cell: Click on the body of the cell you wish to execute and then click the play icon (▶) from the notebook menu. An asterisk (*) is displayed in the cell’s execution counter when the kernel is processing the execution, and is replaced with an integer upon completion.
-
Delete a cell: Click on the body of the cell you wish to delete and then click the scissor icon.
Kernels kernels
Notebook kernels are the language-specific computing engines for processing notebook cells. In addition to Python, JupyterLab provides additional language support in R, PySpark, and Spark (Scala). When you open a notebook document, the associated kernel is launched. When a notebook cell is executed, the kernel performs the computation and produces results which may consume significant CPU and memory resources. Note that allocated memory is not freed until the kernel is shut down.
Certain features and functionalities are limited to particular kernels as described in the table below:
- Sensei ML Framework
- Catalog Service
- Query Service
- Sensei ML Framework
- Catalog Service
- Sensei ML Framework
- Catalog Service
Kernel sessions kernel-sessions
Each active notebook or activity on JupyterLab utilizes a kernel session. All active sessions can be found by expanding the Running terminals and kernels tab from the left sidebar. The type and state of the kernel for a notebook can be identified by observing the top right of the notebook interface. In the diagram below, the notebook’s associated kernel is Python 3 and the its current state is represented by a grey circle to the right. A hollow circle implies an idling kernel and a solid circle implies a busy kernel.
If the kernel is shut down or inactive for a prolonged period, then No Kernel! with a solid circle is shown. Activate a kernel by clicking the kernel status and selecting the appropriate kernel type as demonstrated below:
Launcher launcher
The customized Launcher provides you with useful notebook templates for their supported kernels to help you kickstart your task, including:
Some notebook templates are limited to certain kernels. Template availability for each kernel is mapped in the following table:
To open a new Launcher, click File > New Launcher. Alternatively, expand the File browser from the left sidebar and click the plus symbol (+):
Next steps
To learn more about each of the supported notebooks and how to use them, visit the Jupyterlab notebooks data access developer guide. This guide focuses on how to use JupyterLab notebooks to access your data including reading, writing, and querying data. The data access guide also contains information on the maximum amount of data that can be read by each supported notebook.
Supported libraries supported-libraries
For a list of supported packages in Python, R, and PySpark, copy and paste !conda list in a new cell, then run the cell. A list of supported packages populates in alphabetical order.
In addition, the following dependencies are used but not listed:
- CUDA 11.2
- CUDNN 8.1